miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(linter): add missing properties to the dep-checks docs (#19125)

Browse Source
This commit is contained in:
Miroslav Jonaš 2023-09-15 11:53:31 +03:00 committed by GitHub
parent d5f87f79bd
commit d87826eea2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/generated/packages/eslint-plugin/documents/dependency-checks.md
View File

@ -62,6 +62,8 @@ Sometimes we intentionally want to add or remove a dependency from our `package.
{ {
"buildTargets": ["build", "custom-build"], // add non standard build target names "buildTargets": ["build", "custom-build"], // add non standard build target names
"ignoredDependencies": ["lodash"], // these libs will be omitted from checks "ignoredDependencies": ["lodash"], // these libs will be omitted from checks
"includeTransitiveDependencies": true, // collect dependencies transitively from children
"ignoredFiles": ["webpack.config.js", "eslint.config.js"], // list of files that should be skipped for check
"checkMissingDependencies": true, // toggle to disable "checkMissingDependencies": true, // toggle to disable
"checkObsoleteDependencies": true, // toggle to disable "checkObsoleteDependencies": true, // toggle to disable
"checkVersionMismatches": true // toggle to disable "checkVersionMismatches": true // toggle to disable
@ -72,10 +74,12 @@ Sometimes we intentionally want to add or remove a dependency from our `package.
## Options ## Options
| Property | Type | Default | Description | | Property | Type | Default | Description |
| ------------------------- | --------------- | ----------- | ----------------------------------------------------------------------- | | ----------------------------- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| buildTargets | _Array<string>_ | _["build"]_ | List of build target names | | buildTargets | _Array<string>_ | _["build"]_ | List of build target names |
| ignoredDependencies | _Array<string>_ | _[]_ | List of dependencies to ignore for checks | | ignoredDependencies | _Array<string>_ | _[]_ | List of dependencies to ignore for checks |
| checkMissingDependencies | _boolean_ | _true_ | Disable to skip checking for missing dependencies | | includeTransitiveDependencies | _boolean_ | _false_ | Enable to collect dependencies of children projects |
| checkObsoleteDependencies | _boolean_ | _true_ | Disable to skip checking for unused dependencies | | ignoredFiles | _Array<string>_ | N/A | List of files to ignore when collecting dependencies. The default value will be set based on the selected executor during the generation. |
| checkVersionMismatches | _boolean_ | _true_ | Disable to skip checking if version specifier matches installed version | | checkMissingDependencies | _boolean_ | _true_ | Disable to skip checking for missing dependencies |
| checkObsoleteDependencies | _boolean_ | _true_ | Disable to skip checking for unused dependencies |
| checkVersionMismatches | _boolean_ | _true_ | Disable to skip checking if version specifier matches installed version |

18
docs/shared/packages/linter/dependency-checks.md
View File

@ -62,6 +62,8 @@ Sometimes we intentionally want to add or remove a dependency from our `package.
{ {
"buildTargets": ["build", "custom-build"], // add non standard build target names "buildTargets": ["build", "custom-build"], // add non standard build target names
"ignoredDependencies": ["lodash"], // these libs will be omitted from checks "ignoredDependencies": ["lodash"], // these libs will be omitted from checks
"includeTransitiveDependencies": true, // collect dependencies transitively from children
"ignoredFiles": ["webpack.config.js", "eslint.config.js"], // list of files that should be skipped for check
"checkMissingDependencies": true, // toggle to disable "checkMissingDependencies": true, // toggle to disable
"checkObsoleteDependencies": true, // toggle to disable "checkObsoleteDependencies": true, // toggle to disable
"checkVersionMismatches": true // toggle to disable "checkVersionMismatches": true // toggle to disable
@ -72,10 +74,12 @@ Sometimes we intentionally want to add or remove a dependency from our `package.
## Options ## Options
| Property | Type | Default | Description | | Property | Type | Default | Description |
| ------------------------- | --------------- | ----------- | ----------------------------------------------------------------------- | | ----------------------------- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| buildTargets | _Array<string>_ | _["build"]_ | List of build target names | | buildTargets | _Array<string>_ | _["build"]_ | List of build target names |
| ignoredDependencies | _Array<string>_ | _[]_ | List of dependencies to ignore for checks | | ignoredDependencies | _Array<string>_ | _[]_ | List of dependencies to ignore for checks |
| checkMissingDependencies | _boolean_ | _true_ | Disable to skip checking for missing dependencies | | includeTransitiveDependencies | _boolean_ | _false_ | Enable to collect dependencies of children projects |
| checkObsoleteDependencies | _boolean_ | _true_ | Disable to skip checking for unused dependencies | | ignoredFiles | _Array<string>_ | N/A | List of files to ignore when collecting dependencies. The default value will be set based on the selected executor during the generation. |
| checkVersionMismatches | _boolean_ | _true_ | Disable to skip checking if version specifier matches installed version | | checkMissingDependencies | _boolean_ | _true_ | Disable to skip checking for missing dependencies |
| checkObsoleteDependencies | _boolean_ | _true_ | Disable to skip checking for unused dependencies |
| checkVersionMismatches | _boolean_ | _true_ | Disable to skip checking if version specifier matches installed version |

1
packages/eslint-plugin/src/rules/dependency-checks.ts
View File

@ -20,7 +20,6 @@ export type Options = [
checkMissingDependencies?: boolean; checkMissingDependencies?: boolean;
checkObsoleteDependencies?: boolean; checkObsoleteDependencies?: boolean;
checkVersionMismatches?: boolean; checkVersionMismatches?: boolean;
checkMissingPackageJson?: boolean;
ignoredDependencies?: string[]; ignoredDependencies?: string[];
ignoredFiles?: string[]; ignoredFiles?: string[];
includeTransitiveDependencies?: boolean; includeTransitiveDependencies?: boolean;