@docusaurus/eslint-plugin 0.0.0-5454 → 0.0.0-5457

package/lib/index.d.ts

@@ -13,6 +13,7 @@ declare const _default: {
         'no-html-links': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"link", [{
             ignoreFullyResolved: boolean;
         }], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+        'prefer-docusaurus-heading': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"headings", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
     };
     configs: {
         recommended: {
@@ -20,6 +21,7 @@ declare const _default: {
             rules: {
                 '@docusaurus/string-literal-i18n-messages': string;
                 '@docusaurus/no-html-links': string;
+                '@docusaurus/prefer-docusaurus-heading': string;
             };
         };
         all: {
@@ -28,6 +30,7 @@ declare const _default: {
                 '@docusaurus/string-literal-i18n-messages': string;
                 '@docusaurus/no-untranslated-text': string;
                 '@docusaurus/no-html-links': string;
+                '@docusaurus/prefer-docusaurus-heading': string;
             };
         };
     };

package/lib/index.js

@@ -15,6 +15,7 @@ module.exports = {
             rules: {
                 '@docusaurus/string-literal-i18n-messages': 'error',
                 '@docusaurus/no-html-links': 'warn',
+                '@docusaurus/prefer-docusaurus-heading': 'warn',
             },
         },
         all: {
@@ -23,6 +24,7 @@ module.exports = {
                 '@docusaurus/string-literal-i18n-messages': 'error',
                 '@docusaurus/no-untranslated-text': 'warn',
                 '@docusaurus/no-html-links': 'warn',
+                '@docusaurus/prefer-docusaurus-heading': 'warn',
             },
         },
     },

package/lib/rules/index.d.ts

@@ -12,5 +12,6 @@ declare const _default: {
     'no-html-links': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"link", [{
         ignoreFullyResolved: boolean;
     }], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+    'prefer-docusaurus-heading': import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"headings", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
 };
 export default _default;

package/lib/rules/index.js

@@ -8,10 +8,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const no_html_links_1 = tslib_1.__importDefault(require("./no-html-links"));
+const prefer_docusaurus_heading_1 = tslib_1.__importDefault(require("./prefer-docusaurus-heading"));
 const no_untranslated_text_1 = tslib_1.__importDefault(require("./no-untranslated-text"));
 const string_literal_i18n_messages_1 = tslib_1.__importDefault(require("./string-literal-i18n-messages"));
 exports.default = {
     'no-untranslated-text': no_untranslated_text_1.default,
     'string-literal-i18n-messages': string_literal_i18n_messages_1.default,
     'no-html-links': no_html_links_1.default,
+    'prefer-docusaurus-heading': prefer_docusaurus_heading_1.default,
 };

package/lib/rules/prefer-docusaurus-heading.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"headings", [], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+export default _default;

package/lib/rules/prefer-docusaurus-heading.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../util");
+exports.default = (0, util_1.createRule)({
+    name: 'prefer-docusaurus-heading',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'enforce using Docusaurus theme Heading component instead of any <hn> tag',
+            recommended: false,
+        },
+        schema: [],
+        messages: {
+            headings: 'Do not use any of the `<hn>` tags for headings. Use the `<Heading />` component from `@theme/Heading` instead.',
+        },
+    },
+    defaultOptions: [],
+    create(context) {
+        const headingTypes = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
+        return {
+            JSXOpeningElement(node) {
+                const elementName = node.name.name;
+                if (!headingTypes.includes(elementName)) {
+                    return;
+                }
+                context.report({ node, messageId: 'headings' });
+            },
+        };
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/eslint-plugin",
-  "version": "0.0.0-5454",
+  "version": "0.0.0-5457",
   "description": "ESLint plugin to enforce best Docusaurus practices.",
   "main": "lib/index.js",
   "keywords": [
@@ -33,5 +33,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "420bebae1376648bc248021529a6fd1393caed97"
+  "gitHead": "ee5028f585f6d4f474839fafaa2d7d1fb4c46564"
 }

package/src/index.ts

@@ -15,6 +15,7 @@ export = {
       rules: {
         '@docusaurus/string-literal-i18n-messages': 'error',
         '@docusaurus/no-html-links': 'warn',
+        '@docusaurus/prefer-docusaurus-heading': 'warn',
       },
     },
     all: {
@@ -23,6 +24,7 @@ export = {
         '@docusaurus/string-literal-i18n-messages': 'error',
         '@docusaurus/no-untranslated-text': 'warn',
         '@docusaurus/no-html-links': 'warn',
+        '@docusaurus/prefer-docusaurus-heading': 'warn',
       },
     },
   },

package/src/rules/index.ts

@@ -6,6 +6,7 @@
  */
 
 import noHtmlLinks from './no-html-links';
+import preferDocusaurusHeading from './prefer-docusaurus-heading';
 import noUntranslatedText from './no-untranslated-text';
 import stringLiteralI18nMessages from './string-literal-i18n-messages';
 
@@ -13,4 +14,5 @@ export default {
   'no-untranslated-text': noUntranslatedText,
   'string-literal-i18n-messages': stringLiteralI18nMessages,
   'no-html-links': noHtmlLinks,
+  'prefer-docusaurus-heading': preferDocusaurusHeading,
 };

package/src/rules/prefer-docusaurus-heading.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {createRule} from '../util';
+import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree';
+
+type Options = [];
+type MessageIds = 'headings';
+
+export default createRule<Options, MessageIds>({
+  name: 'prefer-docusaurus-heading',
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'enforce using Docusaurus theme Heading component instead of any <hn> tag',
+      recommended: false,
+    },
+    schema: [],
+    messages: {
+      headings:
+        'Do not use any of the `<hn>` tags for headings. Use the `<Heading />` component from `@theme/Heading` instead.',
+    },
+  },
+  defaultOptions: [],
+
+  create(context) {
+    const headingTypes = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
+
+    return {
+      JSXOpeningElement(node) {
+        const elementName = (node.name as TSESTree.JSXIdentifier).name;
+
+        if (!headingTypes.includes(elementName)) {
+          return;
+        }
+
+        context.report({node, messageId: 'headings'});
+      },
+    };
+  },
+});