From d87826eea2eea6dd390b1a2863dfa5a4f93bb97c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miroslav=20Jona=C5=A1?= Date: Fri, 15 Sep 2023 11:53:31 +0300 Subject: [PATCH] docs(linter): add missing properties to the dep-checks docs (#19125) --- .../documents/dependency-checks.md | 18 +++++++++++------- .../packages/linter/dependency-checks.md | 18 +++++++++++------- .../src/rules/dependency-checks.ts | 1 - 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/docs/generated/packages/eslint-plugin/documents/dependency-checks.md b/docs/generated/packages/eslint-plugin/documents/dependency-checks.md index 10733d0326..aaa8998a45 100644 --- a/docs/generated/packages/eslint-plugin/documents/dependency-checks.md +++ b/docs/generated/packages/eslint-plugin/documents/dependency-checks.md @@ -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 "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 "checkObsoleteDependencies": 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 -| Property | Type | Default | Description | -| ------------------------- | --------------- | ----------- | ----------------------------------------------------------------------- | -| buildTargets | _Array_ | _["build"]_ | List of build target names | -| ignoredDependencies | _Array_ | _[]_ | List of dependencies to ignore for checks | -| 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 | +| Property | Type | Default | Description | +| ----------------------------- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| buildTargets | _Array_ | _["build"]_ | List of build target names | +| ignoredDependencies | _Array_ | _[]_ | List of dependencies to ignore for checks | +| includeTransitiveDependencies | _boolean_ | _false_ | Enable to collect dependencies of children projects | +| ignoredFiles | _Array_ | N/A | List of files to ignore when collecting dependencies. The default value will be set based on the selected executor during the generation. | +| 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 | diff --git a/docs/shared/packages/linter/dependency-checks.md b/docs/shared/packages/linter/dependency-checks.md index 10733d0326..aaa8998a45 100644 --- a/docs/shared/packages/linter/dependency-checks.md +++ b/docs/shared/packages/linter/dependency-checks.md @@ -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 "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 "checkObsoleteDependencies": 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 -| Property | Type | Default | Description | -| ------------------------- | --------------- | ----------- | ----------------------------------------------------------------------- | -| buildTargets | _Array_ | _["build"]_ | List of build target names | -| ignoredDependencies | _Array_ | _[]_ | List of dependencies to ignore for checks | -| 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 | +| Property | Type | Default | Description | +| ----------------------------- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| buildTargets | _Array_ | _["build"]_ | List of build target names | +| ignoredDependencies | _Array_ | _[]_ | List of dependencies to ignore for checks | +| includeTransitiveDependencies | _boolean_ | _false_ | Enable to collect dependencies of children projects | +| ignoredFiles | _Array_ | N/A | List of files to ignore when collecting dependencies. The default value will be set based on the selected executor during the generation. | +| 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 | diff --git a/packages/eslint-plugin/src/rules/dependency-checks.ts b/packages/eslint-plugin/src/rules/dependency-checks.ts index e71eca23e0..d246e60f63 100644 --- a/packages/eslint-plugin/src/rules/dependency-checks.ts +++ b/packages/eslint-plugin/src/rules/dependency-checks.ts @@ -20,7 +20,6 @@ export type Options = [ checkMissingDependencies?: boolean; checkObsoleteDependencies?: boolean; checkVersionMismatches?: boolean; - checkMissingPackageJson?: boolean; ignoredDependencies?: string[]; ignoredFiles?: string[]; includeTransitiveDependencies?: boolean;