{"id":15392382,"url":"https://github.com/activeguild/vite-plugin-hit-word","last_synced_at":"2025-10-19T09:01:56.112Z","repository":{"id":38302973,"uuid":"498146205","full_name":"activeguild/vite-plugin-hit-word","owner":"activeguild","description":"Lists files containing the specified word(s). Say goodbye to the disappointment of todo on the code.","archived":false,"fork":false,"pushed_at":"2023-03-02T12:51:17.000Z","size":145,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T08:55:17.125Z","etag":null,"topics":["list","plugin","search","todo","vite","word"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/activeguild.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-31T01:25:02.000Z","updated_at":"2022-10-02T10:27:56.000Z","dependencies_parsed_at":"2024-10-18T23:09:42.009Z","dependency_job_id":null,"html_url":"https://github.com/activeguild/vite-plugin-hit-word","commit_stats":{"total_commits":41,"total_committers":2,"mean_commits":20.5,"dds":"0.024390243902439046","last_synced_commit":"22e18181104cf75ac7462f163832469d6adcfab5"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":"activeguild/vite-plugin-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-hit-word","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-hit-word/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-hit-word/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-hit-word/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/activeguild","download_url":"https://codeload.github.com/activeguild/vite-plugin-hit-word/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245940251,"owners_count":20697356,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["list","plugin","search","todo","vite","word"],"created_at":"2024-10-01T15:14:42.822Z","updated_at":"2025-10-19T09:01:56.059Z","avatar_url":"https://github.com/activeguild.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003evite-plugin-hit-word ⚡ Welcome 😀\u003c/h1\u003e\n\n\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://github.com/actions/setup-node\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/activeguild/vite-plugin-hit-word/workflows/automatic%20release/badge.svg\" style=\"max-width:100%;\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# vite-plugin-hit-word\n\nLists files containing the specified word(s).\nSay goodbye to the disappointment of todo on the code.\n\n## Motivation\n\nPeople 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.\nOf course, it is also possible to search for words other than `todo`.\nIf a line matching the word has a date set, it is compared to the current date and highlighted.\n\n## Install\n\n```bash\nnpm i -D vite-plugin-hit-word\n```\n\n## Options\n\nIf `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.\n\n| Parameter                      | Type                                                                                  | Description                                                   |\n| ------------------------------ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------- |\n| includes                       | string \\| RegExp \\| Array\u003cstring \\| RegExp\u003e                                           | Set the target path.                                          |\n| exclude                        | string \\| RegExp \\| Array\u003cstring \\| RegExp\u003e                                           | Set the paths you want to exclude.                            |\n| word.value                     | string \\| RegExp \\| Array\u003cstring \\| RegExp\u003e                                           | Set the words you want to search for on the code.             |\n| word.hasLimitDate              | boolean                                                                               | Check with the current date.(default false)                   |\n| word.thrownDeadlineExceeded    | boolean                                                                               | Throws an exceedance and terminates the build.(default false) |\n| word.deadlineExceededFonrColor | 'black'\\| 'red'\\| 'green'\\| 'yellow'\\| 'blue'\\| 'magenta'\\| 'cyan'\\| 'white'\\| 'gray' | Output log font color.(default yellow)                        |\n| word.replacement               | string \\|(word: string \\| RegExp, fileText: string) =\u003e string                         | Replace matched words.                                        |\n| word.logFontColor              | 'black'\\| 'red'\\| 'green'\\| 'yellow'\\| 'blue'\\| 'magenta'\\| 'cyan'\\| 'white'\\| 'gray' | Output log font color.(default yellow)                        |\n\n## Add it to vite.config.ts\n\n```ts\nimport { defineConfig } from 'vite'\nimport hitWord from 'vite-plugin-hit-word'\n\n// https://vitejs.dev/config/\nexport default defineConfig({\n  plugins: [\n    hitWord({\n      include: ['src/*'],\n      exclude: ['node_modules'],\n      word: { value: ['[todo]:'], hasLimitDate: true },\n    }),\n  ],\n})\n```\n\n#### e.g.\n\nThe following files are available.\n\n```tsx\nimport styles from './App.module.css'\n\nfunction App() {\n  // [todo]: [2022/05/22] issue #765\n\n  return (\n    \u003cdiv className=\"App\"\u003e\n      \u003cheader className={styles.header}\u003e\u003c/header\u003e\n    \u003c/div\u003e\n  )\n}\n\nexport default App\n```\n\nAt build time, output to the terminal as follows.\nYou can jump to the corresponding code from the path.\n\n```bash\n/Users/XXXXXX/projects/Sample/src/App.tsx(4) :\u003e\u003e   // [todo]: [2022/05/22] issue #765\n```\n\n## Principles of conduct\n\nPlease see [the principles of conduct](https://github.com/activeguild/vite-plugin-hit-word/blob/master/.github/CONTRIBUTING.md) when building a site.\n\n## License\n\nThis library is licensed under the [MIT license](https://github.com/activeguild/vite-plugin-hit-word/blob/master/LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factiveguild%2Fvite-plugin-hit-word","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factiveguild%2Fvite-plugin-hit-word","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factiveguild%2Fvite-plugin-hit-word/lists"}