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

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

Merged
merged 1 commit into from
Sep 15, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions docs/generated/packages/eslint-plugin/documents/dependency-checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -72,10 +74,12 @@ Sometimes we intentionally want to add or remove a dependency from our `package.

## Options

| Property | Type | Default | Description |
| ------------------------- | --------------- | ----------- | ----------------------------------------------------------------------- |
| buildTargets | _Array<string>_ | _["build"]_ | List of build target names |
| ignoredDependencies | _Array<string>_ | _[]_ | 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<string>_ | _["build"]_ | List of build target names |
| ignoredDependencies | _Array<string>_ | _[]_ | List of dependencies to ignore for checks |
| includeTransitiveDependencies | _boolean_ | _false_ | Enable to collect dependencies of children projects |
| 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. |
| 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 changes: 11 additions & 7 deletions docs/shared/packages/linter/dependency-checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -72,10 +74,12 @@ Sometimes we intentionally want to add or remove a dependency from our `package.

## Options

| Property | Type | Default | Description |
| ------------------------- | --------------- | ----------- | ----------------------------------------------------------------------- |
| buildTargets | _Array<string>_ | _["build"]_ | List of build target names |
| ignoredDependencies | _Array<string>_ | _[]_ | 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<string>_ | _["build"]_ | List of build target names |
| ignoredDependencies | _Array<string>_ | _[]_ | List of dependencies to ignore for checks |
| includeTransitiveDependencies | _boolean_ | _false_ | Enable to collect dependencies of children projects |
| 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. |
| 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 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/dependency-checks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ export type Options = [
checkMissingDependencies?: boolean;
checkObsoleteDependencies?: boolean;
checkVersionMismatches?: boolean;
checkMissingPackageJson?: boolean;
ignoredDependencies?: string[];
ignoredFiles?: string[];
includeTransitiveDependencies?: boolean;
Expand Down