feat(eslint-plugin-mark): create code-lang-shorthand and dummy rules (#13)

This pull request introduces a new ESLint rule to enforce the use of
shorthand for code block language identifiers and includes corresponding
updates to the configuration, rule definition, tests, and rule exports.

New ESLint rule for shorthand code block language identifiers:

*
[`packages/eslint-plugin-mark/src/rules/code-lang-shorthand/code-lang-shorthand.js`](diffhunk://#diff-6502c3e17c3ed74bdc42a42b44982988f8ec9f559d0a5d0afbeec6f7ece1e41bR1-R212):
Added a new rule to enforce the use of shorthand for code block language
identifiers, including meta information, schema, and rule definition.
*
[`packages/eslint-plugin-mark/src/rules/code-lang-shorthand/code-lang-shorthand.test.js`](diffhunk://#diff-18f9af089d57586ea0832f9a98f452a2e931db45929f9c10bc54a700ed9411a0R1-R247):
Added tests for the new `code-lang-shorthand` rule, covering various
scenarios including valid and invalid cases, options handling, and case
insensitivity.
*
[`packages/eslint-plugin-mark/src/rules/code-lang-shorthand/index.js`](diffhunk://#diff-f35328507dee7b405405502b54606c3bcdd15410dc747435ce1f99606b04dea3R1-R3):
Exported the new `code-lang-shorthand` rule.
*
[`packages/eslint-plugin-mark/src/configs/all.js`](diffhunk://#diff-dcdf50541cdda584e7b5e20419349e2a8760d86d4d140d12dbd1d97b3084703fR35):
Updated the configuration to include the new `mark/code-lang-shorthand`
rule.
*
[`packages/eslint-plugin-mark/src/rules/index.js`](diffhunk://#diff-8bd6342bada2eb43bbaea244fd51588f57f5ec17967476e31bbf0408aaa82ed1R1-R12):
Added the `code-lang-shorthand` rule to the list of exported rules.

Additional minor changes:

* Added references to external repositories in `.gitkeep` files for
various rules.
[[1]](diffhunk://#diff-7ff05802fc4a1d5074d8a0af498c0a17a44f19750684d216995ce918aef312ddR1)
[[2]](diffhunk://#diff-14e8afb3c825972be38f9135867b85df670f14f5a3837e8cf078ef1dfeb95badR1)
[[3]](diffhunk://#diff-9fb3a02b8be16b00a06688dbc53bfdb97f818a94e3502eeb35b559e197072b34R1)
[[4]](diffhunk://#diff-b1f4c89e4870adcd6309018b2abc8b948e2b10c6b6e1e9ee03402390a9a2c9dfR1)
[[5]](diffhunk://#diff-12f212746a4f9df7419cd1119cd4cc9f631ba1ff5cbfaf5f9b836abb4d4e528dR1)
[[6]](diffhunk://#diff-6565fdc2a5429445525d2875db780b2f66cae4864137b3495006d5e987b4e36eR1-R2)

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: lumirlumir

CONTRIBUTING.md

@@ -12,33 +12,33 @@ All packages are located in the `packages` directory, and the documentation can
 
 1. Clone it to your local directory. ([Git](https://git-scm.com/downloads) is required.)
 
-    ```bash
+    ```sh
     git clone https://github.com/lumirlumir/npm-eslint-plugin-mark.git
     ```
 
 1. Move to the `npm-eslint-plugin-mark` directory.
 
-    ```bash
+    ```sh
     cd npm-eslint-plugin-mark
     ```
 
 1. Install npm packages. ([Node.js](https://nodejs.org/en) is required.)
 
-    ```bash
+    ```sh
     npm install
     ```
 
 1. Edit codes.
 
 1. Create `my-branch` branch.
 
-    ```bash
+    ```sh
     git switch -c my-branch
     ```
 
 1. Commit your changes. (`husky` and `lint-staged` will lint your changed files!)
 
-    ```bash
+    ```sh
     git commit -am "<type>[optional scope]: <description>"
     ```
 

packages/eslint-plugin-mark/src/configs/all.js

@@ -32,6 +32,7 @@ export default function all(parserMode) {
     ...base(parserMode),
     name: `mark/all/${parserMode}`,
     rules: {
+      'mark/code-lang-shorthand': 'error',
       'mark/no-curly-quotes': 'error',
       'mark/no-double-spaces': 'error',
     },

packages/eslint-plugin-mark/src/rules/allowed-urls/.gitkeep

@@ -0,0 +1,211 @@
+/**
+ * @fileoverview Rule to enforce the use of shorthand for code block language identifiers.
+ * @author 루밀LuMir(lumirlumir)
+ * @see https://shiki.style/languages#bundled-languages
+ * @see https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/fromEntries
+ * @see https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/entries
+ */
+
+// --------------------------------------------------------------------------------
+// Import
+// --------------------------------------------------------------------------------
+
+import { getFileName } from '../../core/helpers/index.js';
+
+// --------------------------------------------------------------------------------
+// Typedefs
+// --------------------------------------------------------------------------------
+
+/**
+ * @typedef {import("@eslint/markdown").RuleModule} RuleModule
+ * @typedef {import("mdast").Code} Code
+ */
+
+// --------------------------------------------------------------------------------
+// Helpers
+// --------------------------------------------------------------------------------
+
+/** @type {Record<string, string>} */
+const langShorthandMap = Object.freeze({
+  asciidoc: 'adoc',
+  batch: 'bat',
+  berry: 'be',
+  bsl: '1c',
+  cadence: 'cdc',
+  clojure: 'clj',
+  codeql: 'ql',
+  coffeescript: 'coffee',
+  'common-lisp': 'lisp',
+  csharp: 'c#',
+  cypher: 'cql',
+  dockerfile: 'docker',
+  'emacs-lisp': 'elisp',
+  erlang: 'erl',
+  fluent: 'ftl',
+  'fortran-fixed-form': 'f',
+  fsharp: 'f#',
+  'glimmer-js': 'gjs',
+  'glimmer-ts': 'gts',
+  graphql: 'gql',
+  handlebars: 'hbs',
+  haskell: 'hs',
+  properties: 'ini',
+  javascript: 'js',
+  jssm: 'fsl',
+  julia: 'jl',
+  kotlin: 'kt',
+  kusto: 'kql',
+  lean4: 'lean',
+  makefile: 'make',
+  markdown: 'md',
+  mermaid: 'mmd',
+  mipsasm: 'mips',
+  narrat: 'nar',
+  nextflow: 'nf',
+  nushell: 'nu',
+  'objective-c': 'objc',
+  pot: 'po',
+  potx: 'po',
+  powershell: 'ps',
+  protobuf: 'proto',
+  jade: 'pug',
+  python: 'py',
+  perl6: 'raku',
+  regexp: 'regex',
+  ruby: 'rb',
+  rust: 'rs',
+  '1c-query': 'sdbl',
+  shaderlab: 'shader',
+  shellscript: 'sh',
+  shell: 'sh',
+  bash: 'sh',
+  zsh: 'sh',
+  shellsession: 'console',
+  'closure-templates': 'soy',
+  splunk: 'spl',
+  stylus: 'styl',
+  talonscript: 'talon',
+  terraform: 'tf',
+  text: 'txt',
+  typescript: 'ts',
+  typespec: 'tsp',
+  typst: 'typ',
+  vimscript: 'vim',
+  vyper: 'vy',
+  wikitext: 'wiki',
+  mediawiki: 'wiki',
+  wolfram: 'wl',
+  yaml: 'yml',
+});
+
+// --------------------------------------------------------------------------------
+// Rule Definition
+// --------------------------------------------------------------------------------
+
+/** @type {RuleModule} */
+export default {
+  meta: {
+    type: 'problem',
+
+    docs: {
+      // @ts-ignore -- TODO: https://github.com/eslint/eslint/issues/19521, https://github.com/eslint/eslint/issues/19523
+      name: getFileName(import.meta.url),
+      recommended: true,
+      description: 'Enforce the use of shorthand for code block language identifiers',
+      url: 'https://github.com/lumirlumir/npm-eslint-plugin-mark',
+    },
+
+    fixable: 'code',
+
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          ignores: {
+            type: 'array',
+            items: {
+              enum: Object.keys(langShorthandMap),
+            },
+          },
+          override: {
+            type: 'object',
+            additionalProperties: {
+              type: 'string',
+            },
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+
+    defaultOptions: [
+      {
+        ignores: [],
+        override: {},
+      },
+    ],
+
+    messages: {
+      codeLangShorthand: '`{{ lang }}` should be shortened to `{{ langShorthand }}`.',
+    },
+
+    language: 'markdown',
+
+    dialects: ['commonmark', 'gfm'],
+  },
+
+  create(context) {
+    return {
+      /** @param {Code} node */
+      code(node) {
+        const langShorthandMapMerged = Object.fromEntries(
+          Object.entries({
+            ...langShorthandMap,
+            ...context.options[0].override, // `override` option handling.
+          })
+            .map(([key, value]) => [key.toLowerCase(), value.toLowerCase()]) // Normalize keys and values.
+            .filter(([key]) => !context.options[0].ignores.includes(key)), // `ignores` option handling.
+        );
+        const langShorthand = langShorthandMapMerged[node.lang?.toLowerCase()]; // Normalize lang.
+
+        if (langShorthand === undefined) return;
+
+        // @ts-ignore -- TODO: https://github.com/eslint/markdown/issues/323
+        const match = context.sourceCode.getText(node).match(node.lang);
+
+        const matchIndexStart = match.index;
+        const matchIndexEnd = matchIndexStart + match[0].length;
+
+        context.report({
+          loc: {
+            start: {
+              line: node.position.start.line,
+              column: node.position.start.column + matchIndexStart,
+            },
+            end: {
+              line: node.position.start.line,
+              column: node.position.start.column + matchIndexEnd,
+            },
+          },
+
+          data: {
+            lang: node.lang, // Original lang.
+            langShorthand,
+          },
+
+          messageId: 'codeLangShorthand',
+
+          fix(fixer) {
+            return fixer.replaceTextRange(
+              [
+                node.position.start.offset + matchIndexStart,
+                node.position.start.offset + matchIndexEnd,
+              ],
+              langShorthand,
+            );
+          },
+        });
+      },
+    };
+  },
+};