From f99a9a57ff860c9966728fb2051481c71571ab19 Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Wed, 17 Nov 2021 13:42:20 +0800 Subject: [PATCH] chore: various website improvements (#4157) --- .../eslint-plugin/docs/rules/brace-style.md | 6 ++- .../eslint-plugin/docs/rules/comma-dangle.md | 6 ++- .../eslint-plugin/docs/rules/comma-spacing.md | 6 ++- .../docs/rules/default-param-last.md | 6 ++- .../eslint-plugin/docs/rules/dot-notation.md | 6 ++- .../docs/rules/func-call-spacing.md | 6 ++- packages/eslint-plugin/docs/rules/indent.md | 6 ++- .../docs/rules/init-declarations.md | 6 ++- .../docs/rules/keyword-spacing.md | 6 ++- .../docs/rules/lines-between-class-members.md | 6 ++- .../docs/rules/no-array-constructor.md | 6 ++- .../docs/rules/no-dupe-class-members.md | 6 ++- .../docs/rules/no-duplicate-imports.md | 6 ++- .../docs/rules/no-empty-function.md | 6 ++- .../docs/rules/no-extra-parens.md | 6 ++- .../eslint-plugin/docs/rules/no-extra-semi.md | 6 ++- .../docs/rules/no-implied-eval.md | 6 ++- .../docs/rules/no-invalid-this.md | 6 ++- .../eslint-plugin/docs/rules/no-loop-func.md | 6 ++- .../docs/rules/no-loss-of-precision.md | 6 ++- .../docs/rules/no-magic-numbers.md | 6 ++- .../eslint-plugin/docs/rules/no-redeclare.md | 6 ++- .../eslint-plugin/docs/rules/no-shadow.md | 6 ++- .../docs/rules/no-throw-literal.md | 6 ++- .../docs/rules/no-unused-expressions.md | 6 ++- .../docs/rules/no-unused-vars.md | 6 ++- .../docs/rules/no-use-before-define.md | 6 ++- .../docs/rules/no-useless-constructor.md | 6 ++- .../docs/rules/object-curly-spacing.md | 6 ++- .../rules/padding-line-between-statements.md | 6 ++- packages/eslint-plugin/docs/rules/quotes.md | 6 ++- .../eslint-plugin/docs/rules/require-await.md | 6 ++- packages/eslint-plugin/docs/rules/semi.md | 6 ++- .../docs/rules/space-before-function-paren.md | 6 ++- .../docs/rules/space-infix-ops.md | 6 ++- packages/website/docusaurus.config.js | 45 ++++++++++++------- packages/website/src/clientModules.js | 2 +- packages/website/src/css/custom.css | 21 +++------ packages/website/src/pages/index.tsx | 13 +++--- .../static/img/favicon/site.webmanifest | 24 +++++----- packages/website/tsconfig.json | 5 +++ 41 files changed, 236 insertions(+), 84 deletions(-) diff --git a/packages/eslint-plugin/docs/rules/brace-style.md b/packages/eslint-plugin/docs/rules/brace-style.md index 87c123a43d7..fcdc24b0499 100644 --- a/packages/eslint-plugin/docs/rules/brace-style.md +++ b/packages/eslint-plugin/docs/rules/brace-style.md @@ -19,7 +19,11 @@ It adds support for `enum`, `interface`, `namespace` and `module` declarations. See [`eslint/brace-style` options](https://eslint.org/docs/rules/brace-style#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/brace-style.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/brace-style.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/comma-dangle.md b/packages/eslint-plugin/docs/rules/comma-dangle.md index 035248bcd46..43c9f3c5aab 100644 --- a/packages/eslint-plugin/docs/rules/comma-dangle.md +++ b/packages/eslint-plugin/docs/rules/comma-dangle.md @@ -31,7 +31,11 @@ This rule has a string option and an object option. - [See the other options allowed](https://github.com/eslint/eslint/blob/master/docs/rules/comma-dangle.md#options) -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/comma-dangle.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/comma-dangle.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/comma-spacing.md b/packages/eslint-plugin/docs/rules/comma-spacing.md index 4ed084d8ee0..d6794c94992 100644 --- a/packages/eslint-plugin/docs/rules/comma-spacing.md +++ b/packages/eslint-plugin/docs/rules/comma-spacing.md @@ -19,7 +19,11 @@ It adds support for trailing comma in a types parameters list. See [`eslint/comma-spacing` options](https://eslint.org/docs/rules/comma-spacing#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/comma-spacing.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/comma-spacing.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/default-param-last.md b/packages/eslint-plugin/docs/rules/default-param-last.md index 0eb9aa429df..0e671562efa 100644 --- a/packages/eslint-plugin/docs/rules/default-param-last.md +++ b/packages/eslint-plugin/docs/rules/default-param-last.md @@ -53,7 +53,11 @@ class Foo { See [`eslint/default-param-last` options](https://eslint.org/docs/rules/default-param-last#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/default-param-last.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/default-param-last.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/dot-notation.md b/packages/eslint-plugin/docs/rules/dot-notation.md index bc2b4f340f2..ef80277de28 100644 --- a/packages/eslint-plugin/docs/rules/dot-notation.md +++ b/packages/eslint-plugin/docs/rules/dot-notation.md @@ -80,7 +80,11 @@ x['hello'] = 123; If the TypeScript compiler option `noPropertyAccessFromIndexSignature` is set to `true`, then the above code is always allowed, even if `allowIndexSignaturePropertyAccess` is `false`. -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/dot-notation.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/dot-notation.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/func-call-spacing.md b/packages/eslint-plugin/docs/rules/func-call-spacing.md index 0070c563303..49dba186638 100644 --- a/packages/eslint-plugin/docs/rules/func-call-spacing.md +++ b/packages/eslint-plugin/docs/rules/func-call-spacing.md @@ -19,7 +19,11 @@ It adds support for generic type parameters on function calls. See [`eslint/func-call-spacing` options](https://eslint.org/docs/rules/func-call-spacing#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/func-call-spacing.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/func-call-spacing.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/indent.md b/packages/eslint-plugin/docs/rules/indent.md index 1c8af15906c..424c5b93ee1 100644 --- a/packages/eslint-plugin/docs/rules/indent.md +++ b/packages/eslint-plugin/docs/rules/indent.md @@ -21,7 +21,11 @@ It adds support for TypeScript nodes. See [`eslint/indent` options](https://eslint.org/docs/rules/indent#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/indent.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/indent.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/init-declarations.md b/packages/eslint-plugin/docs/rules/init-declarations.md index 53783e23759..01944dde398 100644 --- a/packages/eslint-plugin/docs/rules/init-declarations.md +++ b/packages/eslint-plugin/docs/rules/init-declarations.md @@ -19,7 +19,11 @@ It adds support for TypeScript's `declare` variables. See [`eslint/init-declarations` options](https://eslint.org/docs/rules/init-declarations#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/init-declarations.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/init-declarations.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/keyword-spacing.md b/packages/eslint-plugin/docs/rules/keyword-spacing.md index f4d4403bd40..aa23e89733f 100644 --- a/packages/eslint-plugin/docs/rules/keyword-spacing.md +++ b/packages/eslint-plugin/docs/rules/keyword-spacing.md @@ -19,7 +19,11 @@ This version adds support for generic type parameters on function calls. See [`eslint/keyword-spacing` options](https://eslint.org/docs/rules/keyword-spacing#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/keyword-spacing.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/keyword-spacing.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/lines-between-class-members.md b/packages/eslint-plugin/docs/rules/lines-between-class-members.md index ab40dfdbdf3..59e05c58836 100644 --- a/packages/eslint-plugin/docs/rules/lines-between-class-members.md +++ b/packages/eslint-plugin/docs/rules/lines-between-class-members.md @@ -70,7 +70,11 @@ class foo { } ``` -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/lines-between-class-members.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/lines-between-class-members.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-array-constructor.md b/packages/eslint-plugin/docs/rules/no-array-constructor.md index dd9dd25bc14..86ff2cc4557 100644 --- a/packages/eslint-plugin/docs/rules/no-array-constructor.md +++ b/packages/eslint-plugin/docs/rules/no-array-constructor.md @@ -40,7 +40,11 @@ new Array(someOtherArray.length); See [`eslint/no-array-constructor` options](https://eslint.org/docs/rules/no-array-constructor#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-array-constructor.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-array-constructor.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-dupe-class-members.md b/packages/eslint-plugin/docs/rules/no-dupe-class-members.md index 121c07a4670..f502a258649 100644 --- a/packages/eslint-plugin/docs/rules/no-dupe-class-members.md +++ b/packages/eslint-plugin/docs/rules/no-dupe-class-members.md @@ -19,7 +19,11 @@ It adds support for TypeScript's method overload definitions. See [`eslint/no-dupe-class-members` options](https://eslint.org/docs/rules/no-dupe-class-members#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-dupe-class-members.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-dupe-class-members.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-duplicate-imports.md b/packages/eslint-plugin/docs/rules/no-duplicate-imports.md index 1cc99ddd097..a8c1b8c6e00 100644 --- a/packages/eslint-plugin/docs/rules/no-duplicate-imports.md +++ b/packages/eslint-plugin/docs/rules/no-duplicate-imports.md @@ -19,7 +19,11 @@ This version adds support for type-only import and export. See [`eslint/no-duplicate-imports` options](https://eslint.org/docs/rules/no-duplicate-imports#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-duplicate-imports.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-duplicate-imports.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-empty-function.md b/packages/eslint-plugin/docs/rules/no-empty-function.md index b7d0fb99f5f..c9cfa8eb792 100644 --- a/packages/eslint-plugin/docs/rules/no-empty-function.md +++ b/packages/eslint-plugin/docs/rules/no-empty-function.md @@ -87,7 +87,11 @@ class Foo { --- -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-empty-function.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-empty-function.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-extra-parens.md b/packages/eslint-plugin/docs/rules/no-extra-parens.md index 8a748ac5a23..6b8baf22cb3 100644 --- a/packages/eslint-plugin/docs/rules/no-extra-parens.md +++ b/packages/eslint-plugin/docs/rules/no-extra-parens.md @@ -19,7 +19,11 @@ It adds support for TypeScript type assertions. See [`eslint/no-extra-parens` options](https://eslint.org/docs/rules/no-extra-parens#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-extra-parens.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-extra-parens.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-extra-semi.md b/packages/eslint-plugin/docs/rules/no-extra-semi.md index 2d43f5223ee..04cbb7ba0fa 100644 --- a/packages/eslint-plugin/docs/rules/no-extra-semi.md +++ b/packages/eslint-plugin/docs/rules/no-extra-semi.md @@ -19,7 +19,11 @@ It adds support for class properties. See [`eslint/no-extra-semi` options](https://eslint.org/docs/rules/no-extra-semi#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-extra-semi.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-extra-semi.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-implied-eval.md b/packages/eslint-plugin/docs/rules/no-implied-eval.md index 2a89bed488f..d54d53e5aaf 100644 --- a/packages/eslint-plugin/docs/rules/no-implied-eval.md +++ b/packages/eslint-plugin/docs/rules/no-implied-eval.md @@ -102,7 +102,11 @@ setTimeout(Foo.fn, 100); If you want to allow `new Function()` or `setTimeout()`, `setInterval()`, `setImmediate()` and `execScript()` with string arguments, then you can safely disable this rule. -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-implied-eval.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-implied-eval.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-invalid-this.md b/packages/eslint-plugin/docs/rules/no-invalid-this.md index 86d7a03eba5..ccf880254d9 100644 --- a/packages/eslint-plugin/docs/rules/no-invalid-this.md +++ b/packages/eslint-plugin/docs/rules/no-invalid-this.md @@ -23,7 +23,11 @@ See [`eslint/no-invalid-this` options](https://eslint.org/docs/rules/no-invalid- When you are indifferent as to how your variables are initialized. -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-invalid-this.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-invalid-this.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-loop-func.md b/packages/eslint-plugin/docs/rules/no-loop-func.md index 0ca7ea51516..5951e0c42ad 100644 --- a/packages/eslint-plugin/docs/rules/no-loop-func.md +++ b/packages/eslint-plugin/docs/rules/no-loop-func.md @@ -19,7 +19,11 @@ It adds support for TypeScript types. See [`eslint/no-loop-func` options](https://eslint.org/docs/rules/no-loop-func#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-loop-func.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-loop-func.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-loss-of-precision.md b/packages/eslint-plugin/docs/rules/no-loss-of-precision.md index d2e9fb23f6c..abc7faefa0b 100644 --- a/packages/eslint-plugin/docs/rules/no-loss-of-precision.md +++ b/packages/eslint-plugin/docs/rules/no-loss-of-precision.md @@ -16,7 +16,11 @@ Note that this rule requires ESLint v7. } ``` -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-loss-of-precision.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-loss-of-precision.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-magic-numbers.md b/packages/eslint-plugin/docs/rules/no-magic-numbers.md index 26739600713..98b7a29b2f0 100644 --- a/packages/eslint-plugin/docs/rules/no-magic-numbers.md +++ b/packages/eslint-plugin/docs/rules/no-magic-numbers.md @@ -116,7 +116,11 @@ class Foo { } ``` -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-magic-numbers.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-magic-numbers.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-redeclare.md b/packages/eslint-plugin/docs/rules/no-redeclare.md index 98a4cf78ba3..963e5c0945e 100644 --- a/packages/eslint-plugin/docs/rules/no-redeclare.md +++ b/packages/eslint-plugin/docs/rules/no-redeclare.md @@ -77,7 +77,11 @@ type something = string; const something = 2; ``` -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-redeclare.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-redeclare.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-shadow.md b/packages/eslint-plugin/docs/rules/no-shadow.md index 681ac7b2561..e3374b8a0bb 100644 --- a/packages/eslint-plugin/docs/rules/no-shadow.md +++ b/packages/eslint-plugin/docs/rules/no-shadow.md @@ -84,7 +84,11 @@ const test = 1; type Func = (test: string) => typeof test; ``` -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-shadow.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-shadow.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-throw-literal.md b/packages/eslint-plugin/docs/rules/no-throw-literal.md index a67d422cdc4..cd711ced9f6 100644 --- a/packages/eslint-plugin/docs/rules/no-throw-literal.md +++ b/packages/eslint-plugin/docs/rules/no-throw-literal.md @@ -91,7 +91,11 @@ throw new CustomError(); --- -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-throw-literal.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-throw-literal.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-unused-expressions.md b/packages/eslint-plugin/docs/rules/no-unused-expressions.md index 760fca41193..5806dd46735 100644 --- a/packages/eslint-plugin/docs/rules/no-unused-expressions.md +++ b/packages/eslint-plugin/docs/rules/no-unused-expressions.md @@ -19,7 +19,11 @@ It adds support for optional call expressions `x?.()`, and directive in module d See [`eslint/no-unused-expressions` options](https://eslint.org/docs/rules/no-unused-expressions#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-unused-expressions.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-unused-expressions.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-unused-vars.md b/packages/eslint-plugin/docs/rules/no-unused-vars.md index 0878d325c1e..1caa0db386e 100644 --- a/packages/eslint-plugin/docs/rules/no-unused-vars.md +++ b/packages/eslint-plugin/docs/rules/no-unused-vars.md @@ -19,7 +19,11 @@ It adds support for TypeScript features, such as types. See [`eslint/no-unused-vars` options](https://eslint.org/docs/rules/no-unused-vars#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-unused-vars.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-unused-vars.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-use-before-define.md b/packages/eslint-plugin/docs/rules/no-use-before-define.md index c6344fb04ef..83069ce0558 100644 --- a/packages/eslint-plugin/docs/rules/no-use-before-define.md +++ b/packages/eslint-plugin/docs/rules/no-use-before-define.md @@ -101,7 +101,11 @@ enum Enum {} See [`eslint/no-use-before-define` options](https://eslint.org/docs/rules/no-use-before-define#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-use-before-define.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-use-before-define.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/no-useless-constructor.md b/packages/eslint-plugin/docs/rules/no-useless-constructor.md index bca548db536..02e627ca91d 100644 --- a/packages/eslint-plugin/docs/rules/no-useless-constructor.md +++ b/packages/eslint-plugin/docs/rules/no-useless-constructor.md @@ -23,7 +23,11 @@ It adds support for: See [`eslint/no-useless-constructor` options](https://eslint.org/docs/rules/no-useless-constructor#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-useless-constructor.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-useless-constructor.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/object-curly-spacing.md b/packages/eslint-plugin/docs/rules/object-curly-spacing.md index cccc94747d8..c06b72fde76 100644 --- a/packages/eslint-plugin/docs/rules/object-curly-spacing.md +++ b/packages/eslint-plugin/docs/rules/object-curly-spacing.md @@ -19,7 +19,11 @@ It adds support for TypeScript's object types. See [`eslint/object-curly-spacing` options](https://eslint.org/docs/rules/object-curly-spacing#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/object-curly-spacing.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/object-curly-spacing.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/padding-line-between-statements.md b/packages/eslint-plugin/docs/rules/padding-line-between-statements.md index e0cdb725ad6..b93f94d6e57 100644 --- a/packages/eslint-plugin/docs/rules/padding-line-between-statements.md +++ b/packages/eslint-plugin/docs/rules/padding-line-between-statements.md @@ -47,7 +47,11 @@ In addition to options provided by ESLint, `interface` and `type` can be used as **Note:** ESLint `cjs-export` and `cjs-import` statement types are renamed to `exports` and `require` respectively. -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/padding-line-between-statements.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/padding-line-between-statements.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/quotes.md b/packages/eslint-plugin/docs/rules/quotes.md index 0801bebe5cc..28631a4c807 100644 --- a/packages/eslint-plugin/docs/rules/quotes.md +++ b/packages/eslint-plugin/docs/rules/quotes.md @@ -19,7 +19,11 @@ It adds support for TypeScript features which allow quoted names, but not backti See [`eslint/quotes` options](https://eslint.org/docs/rules/quotes#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/quotes.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/quotes.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/require-await.md b/packages/eslint-plugin/docs/rules/require-await.md index a0eeda41eaf..df213d5ed24 100644 --- a/packages/eslint-plugin/docs/rules/require-await.md +++ b/packages/eslint-plugin/docs/rules/require-await.md @@ -29,7 +29,11 @@ const returnsPromise2 = () => returnsPromise1(); See [`eslint/require-await` options](https://eslint.org/docs/rules/require-await#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/require-await.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/require-await.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/semi.md b/packages/eslint-plugin/docs/rules/semi.md index 15b13d80b4a..f67b9c9749b 100644 --- a/packages/eslint-plugin/docs/rules/semi.md +++ b/packages/eslint-plugin/docs/rules/semi.md @@ -23,7 +23,11 @@ See also the [`@typescript-eslint/member-delimiter-style`](member-delimiter-styl See [`eslint/semi` options](https://eslint.org/docs/rules/semi#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/semi.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/semi.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/space-before-function-paren.md b/packages/eslint-plugin/docs/rules/space-before-function-paren.md index 29378534d40..49f91810310 100644 --- a/packages/eslint-plugin/docs/rules/space-before-function-paren.md +++ b/packages/eslint-plugin/docs/rules/space-before-function-paren.md @@ -19,7 +19,11 @@ It adds support for generic type parameters on function calls. See [`eslint/space-before-function-paren` options](https://eslint.org/docs/rules/space-before-function-paren#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/space-before-function-paren.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/space-before-function-paren.md) + + ## Attributes diff --git a/packages/eslint-plugin/docs/rules/space-infix-ops.md b/packages/eslint-plugin/docs/rules/space-infix-ops.md index 030edc2f69c..dc2bfec7903 100644 --- a/packages/eslint-plugin/docs/rules/space-infix-ops.md +++ b/packages/eslint-plugin/docs/rules/space-infix-ops.md @@ -23,7 +23,11 @@ enum MyEnum { See [`eslint/space-infix-ops` options](https://eslint.org/docs/rules/space-infix-ops#options). -Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/space-infix-ops.md) + + +Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/space-infix-ops.md) + + ## Attributes diff --git a/packages/website/docusaurus.config.js b/packages/website/docusaurus.config.js index f46afb18767..a53d2377a06 100644 --- a/packages/website/docusaurus.config.js +++ b/packages/website/docusaurus.config.js @@ -4,8 +4,6 @@ const lightCodeTheme = require('prism-react-renderer/themes/github'); const darkCodeTheme = require('prism-react-renderer/themes/dracula'); -const sponsors = require('./data/sponsors.json'); - const remarkPlugins = [ [require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }], ]; @@ -24,9 +22,6 @@ const config = { organizationName: 'typescript-eslint', projectName: 'typescript-eslint', clientModules: [require.resolve('./src/clientModules.js')], - customFields: { - sponsors, - }, plugins: [ '@docusaurus/plugin-debug', [ @@ -60,9 +55,13 @@ const config = { ], ], themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + /** @type {import('@docusaurus/theme-common').UserThemeConfig} */ ({ // sidebarCollapsible: false, + metadatas: [ + { name: 'msapplication-TileColor', content: '#443fd4' }, + { name: 'theme-color', content: '#443fd4' }, + ], navbar: { title: 'TypeScript ESLint', // hideOnScroll: true, @@ -105,21 +104,37 @@ const config = { prism: { theme: lightCodeTheme, darkTheme: darkCodeTheme, + additionalLanguages: ['ignore'], }, tableOfContents: { maxHeadingLevel: 4, minHeadingLevel: 2, }, }), + // Misleading API name, but these are just tags + stylesheets: [ + { + rel: 'apple-touch-icon', + sizes: '180x180', + href: '/img/favicon/apple-touch-icon.png', + }, + { + rel: 'icon', + type: 'image/png', + sizes: '32x32', + href: '/img/favicon/favicon-32x32.png', + }, + { + rel: 'icon', + type: 'image/png', + sizes: '16x16', + href: '/img/favicon/favicon-16x16.png', + }, + { + rel: 'manifest', + href: '/img/favicon/site.webmanifest', + }, + ], }; -/* - - - - - - -*/ - module.exports = config; diff --git a/packages/website/src/clientModules.js b/packages/website/src/clientModules.js index bcb346be41a..e140bca1019 100644 --- a/packages/website/src/clientModules.js +++ b/packages/website/src/clientModules.js @@ -1,3 +1,3 @@ -if (typeof window !== 'undefined' && typeof window.document !== 'undefined') { +if (typeof window !== 'undefined') { require('konamimojisplosion').initializeKonamimojisplosion(); } diff --git a/packages/website/src/css/custom.css b/packages/website/src/css/custom.css index 529d92bfc54..e8312b24582 100644 --- a/packages/website/src/css/custom.css +++ b/packages/website/src/css/custom.css @@ -64,28 +64,19 @@ html[data-theme='dark'] .header-github-link:before { background: url('/img/github-dark.svg') no-repeat; } -.menu > .menu__list > .menu__list-item > .menu__link { +.theme-doc-sidebar-item-link-level-1 > a, +.theme-doc-sidebar-item-category-level-1 > a { font-size: 1rem; font-weight: var(--ifm-font-weight-bold); } -.menu - > .menu__list - > .menu__list-item - > .menu__list - > .menu__list-item - > .menu__link { +.theme-doc-sidebar-item-link-level-2 > a, +.theme-doc-sidebar-item-category-level-2 > a { font-size: 0.9rem; } -.menu - > .menu__list - > .menu__list-item - > .menu__list - > .menu__list-item - > .menu__list - > .menu__list-item - .menu__link { +.theme-doc-sidebar-item-link-level-3 > a, +.theme-doc-sidebar-item-category-level-3 > a { font-size: 0.8rem; } diff --git a/packages/website/src/pages/index.tsx b/packages/website/src/pages/index.tsx index 16fcc6a2ea5..aa743826bae 100644 --- a/packages/website/src/pages/index.tsx +++ b/packages/website/src/pages/index.tsx @@ -6,6 +6,8 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import useBaseUrl from '@docusaurus/useBaseUrl'; import styles from './styles.module.css'; +import sponsors from '@site/data/sponsors.json'; + interface FeatureItem { title: string; description: JSX.Element; @@ -124,18 +126,16 @@ function Sponsors(props: { title: string; className?: string; }): JSX.Element { - const { siteConfig } = useDocusaurusContext(); - - const tierSponsors = siteConfig.customFields.sponsors.filter( - sponsor => sponsor.tier === props.tier, - ); + // TODO this seems like a ts-eslint problem: JSON types are not resolved + /* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call */ + const tierSponsors = sponsors.filter(sponsor => sponsor.tier === props.tier); return (
); + /* eslint-enable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call */ } function Home(): JSX.Element { diff --git a/packages/website/static/img/favicon/site.webmanifest b/packages/website/static/img/favicon/site.webmanifest index bb4df2f62b3..ba9eb3dcb7b 100644 --- a/packages/website/static/img/favicon/site.webmanifest +++ b/packages/website/static/img/favicon/site.webmanifest @@ -1,14 +1,14 @@ { - "name": "TypeScript ESLint", - "short_name": "TypeScript ESLint", - "icons": [ - { - "src": "/android-chrome-192x192.png", - "sizes": "192x192", - "type": "image/png" - } - ], - "theme_color": "#443fd4", - "background_color": "#443fd4", - "display": "standalone" + "name": "TypeScript ESLint", + "short_name": "TypeScript ESLint", + "icons": [ + { + "src": "/android-chrome-192x192.png", + "sizes": "192x192", + "type": "image/png" + } + ], + "theme_color": "#443fd4", + "background_color": "#443fd4", + "display": "standalone" } diff --git a/packages/website/tsconfig.json b/packages/website/tsconfig.json index 8d740772b7c..e55d1dba2d1 100644 --- a/packages/website/tsconfig.json +++ b/packages/website/tsconfig.json @@ -9,6 +9,11 @@ "lib": ["DOM"], "noEmit": true, "noImplicitAny": false, + "resolveJsonModule": true, + "baseUrl": ".", + "paths": { + "@site/*": ["./*"] + }, "types": ["node", "@docusaurus/module-type-aliases"] }, "include": ["src/"]