I made a plugin to remember todo comments on the code in vite

Introduce

Often we forget the todo left on the code.
IDE extensions and other features are added, but because of differences in development environments among members and the fact that they are not always visible, they are often noticed just before the release of a product.

We believe that incorporating it as part of the build may prevent it.
Recently, we have been using vite a lot, so we created a plugin that can be used with vite.
see plugin.

Usage

Install

npm i -D vite-plugin-hit-word

Add it to vite.config.ts

A deadline can be set on the code by assigning a date. If the deadline is exceeded, it will be output in red on the terminal.

import { defineConfig } from 'vite'
import hitWord from 'vite-plugin-hit-word'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    hitWord({
      include: ['src/*'],
      exclude: ['node_modules'],
      word: { value: '[todo]:', hasDeadlineDate: true },
    }),
  ],
})

e.g.

The following files are available.

import styles from './App.module.css'

function App() {
  // [todo]: [2022/05/22] issue #765

  return (
    <div className="App">
      <header className={styles.header}></header>
    </div>
  )
}

export default App

At build time, output to the terminal as follows.
You can jump to the corresponding code from the path.

/Users/XXXXXX/projects/Sample/src/App.tsx(4) :>>   // [todo]: [2022/05/22] issue #765

I have shown an example with todo, but it can be changed to suit your project.

Feedback is welcome.