suppress-ts-errors

February 11, 2025 ยท View on GitHub

CI Downloads Version License GitHub stars

Cli tool to add comments to suppress typescript type errors.
Add @ts-expect-error or @ts-ignore comments to all locations where errors are occurring.
Support for .ts, .tsx, .vue.

Kapture 2022-05-01 at 15 35 50

๐Ÿš€ Usage

Running scripts to .ts and .tsx

Run the script in the directory where tsconfig.json is located.

$ npx suppress-ts-errors

Running scripts to .vue

When targeting vue sfc, the path of the vue component must be specified with the glob pattern.
Notice: It does not support commenting out type errors in the <template> section of vue, only the <script> section.

$ npx suppress-ts-errors vue src/**/*.vue

options

optiondefaultdescription
-t, --tsconfig-path./tsconfig.jsonPath to tsconfig.json.
-c, --comment-type1Choice of inserted comment type.
1 is @ts-expect-error, 2 is @ts-ignore.
-e, --error-codetrueAdd error code to comment. e.g. TS2345.
-g, --globundefinedAdd a specific glob for error suppression (prevents script from processing all files and their dependencies)
-m, --messageundefinedAdd a custom message to the comment.

โœจ Contributing

Contributions are welcome ๐ŸŽ‰
We accept contributions via Pull Requests. See this guide on how to make a contribution.

๐Ÿ“„ License

suppress-ts-errors is available under the MIT License.