vite-plugin-hit-word

Lists files containing the specified word(s). Say goodbye to the disappointment of todo on the code.

Motivation

People often forget that there is a todo left on the code. By including todo checks in your builds, you provide an opportunity to ensure that todo is noticed. Of course, it is also possible to search for words other than todo. If a line matching the word has a date set, it is compared to the current date and highlighted.

Install

npm i -D vite-plugin-hit-word

Options

If hasLimitDate is set, compares the current date to the date set on the line where the matched word exists. If the current date is newer, the text on the console is printed in red.

| Parameter | Type | Description | | ------------------------------ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------- | | includes | string | RegExp | Array<string | RegExp> | Set the target path. | | exclude | string | RegExp | Array<string | RegExp> | Set the paths you want to exclude. | | word.value | string | RegExp | Array<string | RegExp> | Set the words you want to search for on the code. | | word.hasLimitDate | boolean | Check with the current date.(default false) | | word.thrownDeadlineExceeded | boolean | Throws an exceedance and terminates the build.(default false) | | word.deadlineExceededFonrColor | 'black'| 'red'| 'green'| 'yellow'| 'blue'| 'magenta'| 'cyan'| 'white'| 'gray' | Output log font color.(default yellow) | | word.replacement | string |(word: string | RegExp, fileText: string) => string | Replace matched words. | | word.logFontColor | 'black'| 'red'| 'green'| 'yellow'| 'blue'| 'magenta'| 'cyan'| 'white'| 'gray' | Output log font color.(default yellow) |

Add it to vite.config.ts

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]:'], hasLimitDate: 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

Principles of conduct

Please see the principles of conduct when building a site.

License

This library is licensed under the MIT license.