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.

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

[eslint-patch] Some minor documentation updates #4493

Merged
merged 2 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@rushstack/eslint-bulk",
"comment": "Some minor documentation updates",
"type": "patch"
}
],
"packageName": "@rushstack/eslint-bulk"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@rushstack/eslint-patch",
"comment": "Some minor documentation updates",
"type": "patch"
}
],
"packageName": "@rushstack/eslint-patch"
}
12 changes: 8 additions & 4 deletions eslint/eslint-bulk/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# @rushstack/eslint-bulk

This package provides the command-line interface (CLI) for the **ESLint bulk suppressions**
feature from
[`@rushstack/eslint-patch`](https://www.npmjs.com/package/@rushstack/eslint-patch).
feature from `@rushstack/eslint-patch`.

> 👉 See the `@rushstack/eslint-patch` [documentation](https://www.npmjs.com/package/@rushstack/eslint-patch)
> for details.
### Setting it up

👉 Before using this tool, you will first need to install and configure the
[@rushstack/eslint-patch](https://www.npmjs.com/package/@rushstack/eslint-patch) package.

See the [eslint-bulk-suppressions documentation](https://www.npmjs.com/package/@rushstack/eslint-patch#eslint-bulk-suppressions-feature)
for details.

### Typical workflow

Expand Down
10 changes: 5 additions & 5 deletions eslint/eslint-patch/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @rushstack/eslint-patch

Enhance your [ESLint](https://eslint.org/) with better support for large scale monorepos!
Enhance [ESLint](https://eslint.org/) with better support for large scale monorepos!

This is a runtime patch that enables new/experimental features for ESLint. It operates as a "monkey patch"
that gets loaded with **.eslintrc.js** and modifies the ESLint engine in memory. This approach works
Expand All @@ -9,19 +9,19 @@ companion tools such as the ESLint extensions for VS Code and WebStorm.

This package provides several independently loadable features:

- `eslint-bulk-suppressions` enables you to roll out new lint rules in your monorepo without having to
- **eslint-bulk-suppressions**: enables you to roll out new lint rules in your monorepo without having to
clutter up source files with thousands of machine-generated `// eslint-ignore-next-line` directives.
Instead, the "bulk suppressions" for legacy violations are managed in a separate file called
**.eslint-bulk-suppressions.json**.

- `modern-module-resolution` allows an ESLint config package to provide plugin dependencies, avoiding the
- **modern-module-resolution**: allows an ESLint config package to provide plugin dependencies, avoiding the
problem where hundreds of projects in a monorepo need to copy+paste the same `"devDependencies"` in
every **package.json** file.

> NOTE: ESLint 8.21.0 has now introduced a new `ESLINT_USE_FLAT_CONFIG` mode that may reduce the need
> **NOTE:** ESLint 8.21.0 has now introduced a new `ESLINT_USE_FLAT_CONFIG` mode that may reduce the need
for the `modern-module-resolution` patch.

- `custom-config-package-names` enables [rig packages](https://heft.rushstack.io/pages/intro/rig_packages/)
- **custom-config-package-names**: enables [rig packages](https://heft.rushstack.io/pages/intro/rig_packages/)
to provide shareable configs for ESLint, by removing the requirement that `eslint-config` must appear in
the NPM package name.

Expand Down
Loading