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

Add link to typed linting in generated docs #516

Merged
merged 1 commit into from
Feb 3, 2024
Merged

Add link to typed linting in generated docs #516

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
2 changes: 1 addition & 1 deletion docs/examples/eslint-plugin-test/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This plugin is for x purpose.
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
⚙️ Has configuration options.\
💭 Requires type information.\
💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).\
🗂️ The type of rule.\
❗ Identifies problems that could cause errors or unexpected behavior.\
📖 Identifies potential improvements.\
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/eslint-plugin-test/docs/rules/no-foo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

⚙️ This rule is configurable.

💭 This rule requires type information.
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).

❗ This rule identifies problems that could cause errors or unexpected behavior.

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/eslint-plugin-test/docs/rules/prefer-bar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).

💭 This rule requires type information.
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).

📖 This rule identifies potential improvements.

Expand Down
2 changes: 1 addition & 1 deletion lib/rule-doc-notices.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ const RULE_NOTICES: {
[NOTICE_TYPE.HAS_SUGGESTIONS]: NOTICE_HAS_SUGGESTIONS,

[NOTICE_TYPE.OPTIONS]: `${EMOJI_OPTIONS} This rule is configurable.`,
[NOTICE_TYPE.REQUIRES_TYPE_CHECKING]: `${EMOJI_REQUIRES_TYPE_CHECKING} This rule requires type information.`,
[NOTICE_TYPE.REQUIRES_TYPE_CHECKING]: `${EMOJI_REQUIRES_TYPE_CHECKING} This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).`,
};

/**
Expand Down
2 changes: 1 addition & 1 deletion lib/rule-list-legend.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ const LEGENDS: {
[COLUMN_TYPE.NAME]: undefined,
[COLUMN_TYPE.OPTIONS]: [`${EMOJI_OPTIONS} Has configuration options.`],
[COLUMN_TYPE.REQUIRES_TYPE_CHECKING]: [
`${EMOJI_REQUIRES_TYPE_CHECKING} Requires type information.`,
`${EMOJI_REQUIRES_TYPE_CHECKING} Requires [type information](https://typescript-eslint.io/linting/typed-linting).`,
],
};

Expand Down
4 changes: 2 additions & 2 deletions test/lib/generate/__snapshots__/option-rule-list-columns-test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ exports[`generate (--rule-list-columns) shows column and notice for requiresType

💼 Configurations enabled in.\\
🌐 Set in the \`all\` configuration.\\
💭 Requires type information.
💭 Requires [type information](https://typescript-eslint.io/linting/typed-linting).

| Name | Description | 💼 | 💭 |
| :----------------------------- | :--------------------- | :- | :- |
Expand All @@ -70,7 +70,7 @@ exports[`generate (--rule-list-columns) shows column and notice for requiresType
exports[`generate (--rule-list-columns) shows column and notice for requiresTypeChecking updates the documentation 3`] = `
"# Description of no-bar (\`test/no-bar\`)

💭 This rule requires type information.
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).

<!-- end auto-generated rule header -->
"
Expand Down
Loading