Skip to content

Commit

Permalink
prefer hyphens to asterisks for line indents (greater visual distingu…
Browse files Browse the repository at this point in the history
…ishability from bolding asterisks)
  • Loading branch information
brettz9 committed Aug 12, 2024
1 parent 3cd2163 commit ee604f4
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 52 deletions.
52 changes: 26 additions & 26 deletions .README/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,38 +52,38 @@ export default config;

The general starting rulesets you can extend from in flat config are:

* `jsdoc.configs['flat/recommended']`: Recommended starting rules for enforcing proper tag values, that common tags exist, and that tags are formatted and styled consistently
* `jsdoc.configs['flat/recommended-error']`: The same, reporting with failing errors instead of mere warnings
* `jsdoc.configs['flat/recommended-typescript']`: A similar recommended starting list, adjusted for projects using TypeScript syntax (and not just the "typescript" `mode` setting)
* `jsdoc.configs['flat/recommended-typescript-error']`: The same, reporting with failing errors instead of mere warnings
* `jsdoc.configs['flat/recommended-typescript-flavor']`: A similar recommended starting list, adjusted for projects using JavaScript syntax (source files that are still `.js`) but using TypeScript flavor within JSDoc (i.e., the default "typescript" `mode` in `eslint-plugin-jsdoc`)
* `jsdoc.configs['flat/recommended-typescript-flavor-error']`: The same, reporting with failing errors instead of mere warnings
- `jsdoc.configs['flat/recommended']`: Recommended starting rules for enforcing proper tag values, that common tags exist, and that tags are formatted and styled consistently
- `jsdoc.configs['flat/recommended-error']`: The same, reporting with failing errors instead of mere warnings
- `jsdoc.configs['flat/recommended-typescript']`: A similar recommended starting list, adjusted for projects using TypeScript syntax (and not just the "typescript" `mode` setting)
- `jsdoc.configs['flat/recommended-typescript-error']`: The same, reporting with failing errors instead of mere warnings
- `jsdoc.configs['flat/recommended-typescript-flavor']`: A similar recommended starting list, adjusted for projects using JavaScript syntax (source files that are still `.js`) but using TypeScript flavor within JSDoc (i.e., the default "typescript" `mode` in `eslint-plugin-jsdoc`)
- `jsdoc.configs['flat/recommended-typescript-flavor-error']`: The same, reporting with failing errors instead of mere warnings

#### Granular Flat Configs

There also exist several more granular, standalone TypeScript rulesets you can extend from.
These each only enable mostly or only rules from the recommended starting rules:

* **Contents**: rules that check names and descriptions
* `jsdoc.configs['flat/contents-typescript']`: for TypeScript files, with reports set to warn
* `jsdoc.configs['flat/contents-typescript-error']`: for TypeScript files, with reports set to error
* `jsdoc.configs['flat/contents-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
* `jsdoc.configs['flat/contents-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
* **Logical**: rules that enforce proper tag values
* `jsdoc.configs['flat/logical-typescript']`: for TypeScript files, with reports set to warn
* `jsdoc.configs['flat/logical-typescript-error']`: for TypeScript files, with reports set to error
* `jsdoc.configs['flat/logical-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
* `jsdoc.configs['flat/logical-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
* **Requirements**: rules that enforce tags exist
* `jsdoc.configs['flat/requirements-typescript']`: for TypeScript files, with reports set to warn
* `jsdoc.configs['flat/requirements-typescript-error']`: for TypeScript files, with reports set to error
* `jsdoc.configs['flat/requirements-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
* `jsdoc.configs['flat/requirements-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
* **Stylistic**: rules that enforce clear, consistent tag formatting and styles
* `jsdoc.configs['flat/stylistic-typescript']`: for TypeScript files, with reports set to warn
* `jsdoc.configs['flat/stylistic-typescript-error']`: for TypeScript files, with reports set to error
* `jsdoc.configs['flat/stylistic-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
* `jsdoc.configs['flat/stylistic-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
- **Contents**: rules that check names and descriptions
- `jsdoc.configs['flat/contents-typescript']`: for TypeScript files, with reports set to warn
- `jsdoc.configs['flat/contents-typescript-error']`: for TypeScript files, with reports set to error
- `jsdoc.configs['flat/contents-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
- `jsdoc.configs['flat/contents-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
- **Logical**: rules that enforce proper tag values
- `jsdoc.configs['flat/logical-typescript']`: for TypeScript files, with reports set to warn
- `jsdoc.configs['flat/logical-typescript-error']`: for TypeScript files, with reports set to error
- `jsdoc.configs['flat/logical-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
- `jsdoc.configs['flat/logical-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
- **Requirements**: rules that enforce tags exist
- `jsdoc.configs['flat/requirements-typescript']`: for TypeScript files, with reports set to warn
- `jsdoc.configs['flat/requirements-typescript-error']`: for TypeScript files, with reports set to error
- `jsdoc.configs['flat/requirements-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
- `jsdoc.configs['flat/requirements-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
- **Stylistic**: rules that enforce clear, consistent tag formatting and styles
- `jsdoc.configs['flat/stylistic-typescript']`: for TypeScript files, with reports set to warn
- `jsdoc.configs['flat/stylistic-typescript-error']`: for TypeScript files, with reports set to error
- `jsdoc.configs['flat/stylistic-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
- `jsdoc.configs['flat/stylistic-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error

For example, to enforce only that any JSDoc tags and their contents are valid and styled consistently in TypeScript files, without enforcing that tags must always exist:

Expand Down
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ export default config;

The general starting rulesets you can extend from in flat config are:

* `jsdoc.configs['flat/recommended']`: Recommended starting rules for enforcing proper tag values, that common tags exist, and that tags are formatted and styled consistently
* `jsdoc.configs['flat/recommended-error']`: The same, reporting with failing errors instead of mere warnings
* `jsdoc.configs['flat/recommended-typescript']`: A similar recommended starting list, adjusted for projects using TypeScript syntax (and not just the "typescript" `mode` setting)
* `jsdoc.configs['flat/recommended-typescript-error']`: The same, reporting with failing errors instead of mere warnings
* `jsdoc.configs['flat/recommended-typescript-flavor']`: A similar recommended starting list, adjusted for projects using JavaScript syntax (source files that are still `.js`) but using TypeScript flavor within JSDoc (i.e., the default "typescript" `mode` in `eslint-plugin-jsdoc`)
* `jsdoc.configs['flat/recommended-typescript-flavor-error']`: The same, reporting with failing errors instead of mere warnings
- `jsdoc.configs['flat/recommended']`: Recommended starting rules for enforcing proper tag values, that common tags exist, and that tags are formatted and styled consistently
- `jsdoc.configs['flat/recommended-error']`: The same, reporting with failing errors instead of mere warnings
- `jsdoc.configs['flat/recommended-typescript']`: A similar recommended starting list, adjusted for projects using TypeScript syntax (and not just the "typescript" `mode` setting)
- `jsdoc.configs['flat/recommended-typescript-error']`: The same, reporting with failing errors instead of mere warnings
- `jsdoc.configs['flat/recommended-typescript-flavor']`: A similar recommended starting list, adjusted for projects using JavaScript syntax (source files that are still `.js`) but using TypeScript flavor within JSDoc (i.e., the default "typescript" `mode` in `eslint-plugin-jsdoc`)
- `jsdoc.configs['flat/recommended-typescript-flavor-error']`: The same, reporting with failing errors instead of mere warnings

<a name="user-content-eslint-plugin-jsdoc-configuration-flat-config-granular-flat-configs"></a>
<a name="eslint-plugin-jsdoc-configuration-flat-config-granular-flat-configs"></a>
Expand All @@ -84,26 +84,26 @@ The general starting rulesets you can extend from in flat config are:
There also exist several more granular, standalone TypeScript rulesets you can extend from.
These each only enable mostly or only rules from the recommended starting rules:

* **Contents**: rules that check names and descriptions
* `jsdoc.configs['flat/contents-typescript']`: for TypeScript files, with reports set to warn
* `jsdoc.configs['flat/contents-typescript-error']`: for TypeScript files, with reports set to error
* `jsdoc.configs['flat/contents-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
* `jsdoc.configs['flat/contents-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
* **Logical**: rules that enforce proper tag values
* `jsdoc.configs['flat/logical-typescript']`: for TypeScript files, with reports set to warn
* `jsdoc.configs['flat/logical-typescript-error']`: for TypeScript files, with reports set to error
* `jsdoc.configs['flat/logical-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
* `jsdoc.configs['flat/logical-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
* **Requirements**: rules that enforce tags exist
* `jsdoc.configs['flat/requirements-typescript']`: for TypeScript files, with reports set to warn
* `jsdoc.configs['flat/requirements-typescript-error']`: for TypeScript files, with reports set to error
* `jsdoc.configs['flat/requirements-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
* `jsdoc.configs['flat/requirements-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
* **Stylistic**: rules that enforce clear, consistent tag formatting and styles
* `jsdoc.configs['flat/stylistic-typescript']`: for TypeScript files, with reports set to warn
* `jsdoc.configs['flat/stylistic-typescript-error']`: for TypeScript files, with reports set to error
* `jsdoc.configs['flat/stylistic-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
* `jsdoc.configs['flat/stylistic-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
- **Contents**: rules that check names and descriptions
- `jsdoc.configs['flat/contents-typescript']`: for TypeScript files, with reports set to warn
- `jsdoc.configs['flat/contents-typescript-error']`: for TypeScript files, with reports set to error
- `jsdoc.configs['flat/contents-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
- `jsdoc.configs['flat/contents-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
- **Logical**: rules that enforce proper tag values
- `jsdoc.configs['flat/logical-typescript']`: for TypeScript files, with reports set to warn
- `jsdoc.configs['flat/logical-typescript-error']`: for TypeScript files, with reports set to error
- `jsdoc.configs['flat/logical-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
- `jsdoc.configs['flat/logical-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
- **Requirements**: rules that enforce tags exist
- `jsdoc.configs['flat/requirements-typescript']`: for TypeScript files, with reports set to warn
- `jsdoc.configs['flat/requirements-typescript-error']`: for TypeScript files, with reports set to error
- `jsdoc.configs['flat/requirements-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
- `jsdoc.configs['flat/requirements-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error
- **Stylistic**: rules that enforce clear, consistent tag formatting and styles
- `jsdoc.configs['flat/stylistic-typescript']`: for TypeScript files, with reports set to warn
- `jsdoc.configs['flat/stylistic-typescript-error']`: for TypeScript files, with reports set to error
- `jsdoc.configs['flat/stylistic-typescript-flavor']`: for files using JavaScript syntax and JSDoc types, with reports set to warn
- `jsdoc.configs['flat/stylistic-typescript-flavor-error']`: for files using JavaScript syntax and JSDoc types, with reports set to error

For example, to enforce only that any JSDoc tags and their contents are valid and styled consistently in TypeScript files, without enforcing that tags must always exist:

Expand Down

0 comments on commit ee604f4

Please sign in to comment.