Skip to content

Commit

Permalink
docs: feature-freeze member-ordering, naming-convention, sort-type-co…
Browse files Browse the repository at this point in the history
…nstituents (#8793)
  • Loading branch information
JoshuaKGoldberg committed Apr 4, 2024
1 parent 346287c commit d063275
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/eslint-plugin/docs/rules/member-ordering.mdx
Expand Up @@ -12,6 +12,15 @@ import TabItem from '@theme/TabItem';
This rule aims to standardize the way classes, interfaces, and type literals are structured and ordered.
A consistent ordering of fields, methods and constructors can make code easier to read, navigate, and edit.

:::note
This rule is _feature frozen_: it will no longer receive new features such as new options.
It still will accept bug and documentation fixes for its existing area of features.

Stylistic rules that enforce naming and/or sorting conventions tend to grow incomprehensibly complex as increasingly obscure features are requested.
This rule has reached the limit of what is reasonable for the typescript-eslint project to maintain.
See [eslint-plugin: Feature freeze naming and sorting stylistic rules](https://github.com/typescript-eslint/typescript-eslint/issues/8792) for more information.
:::

## Options

```ts
Expand Down
9 changes: 9 additions & 0 deletions packages/eslint-plugin/docs/rules/naming-convention.mdx
Expand Up @@ -12,6 +12,15 @@ import TabItem from '@theme/TabItem';
Enforcing naming conventions helps keep the codebase consistent, and reduces overhead when thinking about how to name a variable.
Additionally, a well-designed style guide can help communicate intent, such as by enforcing all private properties begin with an `_`, and all global-level constants are written in `UPPER_CASE`.

:::note
This rule is _feature frozen_: it will no longer receive new features such as new options.
It still will accept bug and documentation fixes for its existing area of features and to support new TypeScript versions.

Stylistic rules that enforce naming and/or sorting conventions tend to grow incomprehensibly complex as increasingly obscure features are requested.
This rule has reached the limit of what is reasonable for the typescript-eslint project to maintain.
See [eslint-plugin: Feature freeze naming and sorting stylistic rules](https://github.com/typescript-eslint/typescript-eslint/issues/8792) for more information.
:::

## Examples

This rule allows you to enforce conventions for any identifier, using granular selectors to create a fine-grained style guide.
Expand Down
9 changes: 9 additions & 0 deletions packages/eslint-plugin/docs/rules/sort-type-constituents.mdx
Expand Up @@ -19,6 +19,15 @@ This rule reports on any types that aren't sorted alphabetically.

> Types are sorted case-insensitively and treating numbers like a human would, falling back to character code sorting in case of ties.
:::note
This rule is _feature frozen_: it will no longer receive new features such as new options.
It still will accept bug and documentation fixes for its existing area of features.

Stylistic rules that enforce naming and/or sorting conventions tend to grow incomprehensibly complex as increasingly obscure features are requested.
This rule has reached the limit of what is reasonable for the typescript-eslint project to maintain.
See [eslint-plugin: Feature freeze naming and sorting stylistic rules](https://github.com/typescript-eslint/typescript-eslint/issues/8792) for more information.
:::

## Examples

<Tabs>
Expand Down

0 comments on commit d063275

Please sign in to comment.