Ignores unwanted dependencies in TypeScript definitions. Useful for autogenerated declarations
Adds // @ts-ignore
to unwanted import
and require
targets in TypeScript definition files.
npm install ts-ignore-import
ts-ignore-import [...declaration files]
Very similar to CLI-use. See type file.
ts-ignore-import
ts-ignore-import --allow=bunyan-adapter --allow=express
ts-ignore-import \
--allow=bunyan-adapter \
--allow=express \
'lib/**/*.d.ts'
One or more declaration files that will be processed. Supports glob patterns.
-
--allow
,-a
– Marks a module as allowed. It will then not have a// @ts-ignore
added to it. (Already added ignores are kept though) -
--skip
,-s
– Skip a specific file. Follows.gitignore
syntax. Matched against file paths relative to resolved path oftsconfig
. -
--ts-config
,-t
– Point to atsconfig.json
file to override any auto-discovered one
-
--debug
– Activates some very verbose logging -
--dry-run
– Runs everything like normal, but doesn't save any changes -
--help
– When set, this help will be printed -
--silent
– When set, no feedback will be printed -
--verbose
,-v
– When set, more verbose feedback will be printed -
--version
– When set, this tools version will be printed
Optional. Uses cosmiconfig
to set it up. Useful for eg. skipFiles
Non-exhaustive list:
-
.tsignoreimportrc
– JSON or YAML content -
.tsignoreimportrc.json
– JSON content -
.tsignoreimportrc.yml
– YAML content -
tsignoreimportrc.config.js
– JS-file exporting the config -
package.json
property:tsIgnoreImport
-
allow
– an array of values that's same as--allow
-
files
– an array of one or more declaration files that will be processed. Supports glob patterns -
skipFiles
– an array of values that's same as--skip
-
tsConfig
– same as--ts-config
. Will get overridden by--ts-config
-
@hdsydsvenskan/ts-ignore-import
– the original version of this project, created and released by me while I worked for HD-Sydsvenskan