Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Sydsvenskan/node-ts-ignore-import
Add some @ts-ignore to imported dependencies in your auto-generated TypeScript type declarations
https://github.com/Sydsvenskan/node-ts-ignore-import
Last synced: 7 days ago
JSON representation
Add some @ts-ignore to imported dependencies in your auto-generated TypeScript type declarations
- Host: GitHub
- URL: https://github.com/Sydsvenskan/node-ts-ignore-import
- Owner: Sydsvenskan
- License: mit
- Created: 2020-06-15T14:26:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-15T21:28:11.000Z (over 2 years ago)
- Last Synced: 2024-10-30T02:32:58.391Z (13 days ago)
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TS Ignore Import
Ignores unwanted dependencies in TypeScript definitions. Useful for autogenerated declarations
[](https://github.com/Flet/semistandard)
Adds `// @ts-ignore` to unwanted `import` and `require` targets in TypeScript definition files.
## Install
```bash
yarn add --dev @hdsydsvenskan/ts-ignore-import
```
## Syntax
```bash
ts-ignore-import [...declaration files]
```
## Programmatic use
Very similar to CLI-use. See [type file](./index.d.ts).
## Examples
### Simplest
```bash
ts-ignore-import
```
### Allow some dependencies
```bash
ts-ignore-import --allow=bunyan-adapter --allow=express
```
### Advanced
```bash
ts-ignore-import \
--allow=bunyan-adapter \
--allow=express \
'lib/**/*.d.ts'
```
## Input
One or more declaration files that will be processed. Supports glob patterns.
## Flags
### Core Flags
* `--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 of ts-config.
* `--ts-config`, `-t` – Point to a `tsconfig.json` file to override any auto-discovered one
### Additional Flags
* `--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
## Config file
Optional. Uses [cosmiconfig](https://www.npmjs.com/package/cosmiconfig) to set it up. Useful for eg. `skipFiles`
### Possible file names
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`
### Properties
* `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 overriden by `--ts-config`