Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Chore - Tidy readme and improve release test #284

Merged
merged 2 commits into from
Jun 24, 2023
Merged

Chore - Tidy readme and improve release test #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
204573f
Fix order of options in README
mrseanryan Jun 24, 2023
d5c0f32
Improve the release test
mrseanryan Jun 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ ts-unused-exports path/to/tsconfig.json [file1.ts ...] [options]
| `exitWithUnusedTypesCount` | Set the process exit code to be the total count of unused exported types. | `--exitWithUnusedTypesCount` |
| `findCompletelyUnusedFiles` | Find all *completely* unused files (where *all* exports are unused). | `--findCompletelyUnusedFiles` |
| `ignoreFiles` | Ignore files with filenames that match the given regex. Use this to exclude groups of files - for example test files and their utilities. | `--ignoreFiles=.*spec` |
| `ignoreLocallyUsed` | Exports which are used in the same file they are defined in won't be reported as unused. Note that this may have an impact on performance in larger codebases. | `--ignoreLocallyUsed` |
| `ignoreProductionFiles` | Only scan **test** files (so ignore non-test 'production' files). | `--ignoreProductionFiles` |
| `ignoreTestFiles` | Only scan **production** files (ignore all test files, like `spec.ts(x)` or `test.ts(x)` or `TestUtils.ts`). Use this to detect production code that is only used in tests (so is dead code). Note: this will NOT detect unused exports in test code - for that, you can run `ts-unused-exports` separately with the `--ignoreProductionFiles` option. | `--ignoreTestFiles` |
| `ignoreLocallyUsed` | Exports which are used in the same file they are defined in won't be reported as unused. Note that this may have an impact on performance in larger codebases. | `--ignoreLocallyUsed` |
| `maxIssues` | Return successfully for up to a given number of modules with unused exports. | `--maxIssues=7` |
| `searchNamespaces` | Enable searching for unused exports within namespaces. Note: this can affect performance on large codebases. | `--searchNamespaces` |
| `showLineNumber` | Show the line number and column of the unused export. | `--showLineNumber` |
Expand Down
1 change: 1 addition & 0 deletions example/library-usage-via-TypeScript/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npm i ts-unused-exports@latest && npm run-script build