@mnaoumov/obsidian-dev-toolkit 0.0.0 → 1.1.0

package/dist/lib/cjs/linters/eslint-rules/plugin-name-as-code-in-ui.cjs

@@ -0,0 +1,263 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for("Symbol.asyncDispose");
+  symbolConstructor.dispose ??= symbolConstructor.for("Symbol.dispose");
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return "/";
+    },
+    env: {},
+    platform: "android"
+  };
+  const existingProcess = globalThis.process;
+  if (!existingProcess) {
+    globalThis.process = browserProcess;
+    return;
+  }
+  if (existingProcess.versions?.node) {
+    return;
+  }
+  const existingProcessRecord = existingProcess;
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+  existingProcessRecord["browser"] = true;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord["__name"] ??= keepName;
+  globalThisRecord["__extractDefault"] ??= extractDefault;
+  ensureBrowserProcess();
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/highlight',
+  '@lezer/lr',
+  'obsidian']
+  );
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/closebrackets',
+  '@codemirror/comment',
+  '@codemirror/fold',
+  '@codemirror/gutter',
+  '@codemirror/highlight',
+  '@codemirror/history',
+  '@codemirror/matchbrackets',
+  '@codemirror/panel',
+  '@codemirror/rangeset',
+  '@codemirror/rectangular-selection',
+  '@codemirror/stream-parser',
+  '@codemirror/tooltip']
+  );
+
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this  -- Need access to app. Actively use globalThis.
+    if (globalThis.app.isMobile) {
+      if (id === 'process' || id === 'node:process') {
+        // eslint-disable-next-line no-console -- Valid usage.
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+
+    // eslint-disable-next-line no-console -- Valid usage.
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_name_as_code_in_ui_exports = {};
+__export(plugin_name_as_code_in_ui_exports, {
+  MESSAGE_ID: () => MESSAGE_ID,
+  pluginNameAsCodeInUi: () => pluginNameAsCodeInUi
+});
+module.exports = __toCommonJS(plugin_name_as_code_in_ui_exports);
+var import_plugin_names = require('../plugin-names.cjs');
+var import_plugin_name_as_code = require('./plugin-name-as-code.cjs');
+const MESSAGE_ID = "pluginNameAsCodeInUi";
+const UI_TEXT_METHOD_NAMES = /* @__PURE__ */ new Set(["appendText", "setDesc", "setName", "setText", "setTitle"]);
+const ELEMENT_FACTORY_NAMES = /* @__PURE__ */ new Set(["createDiv", "createEl", "createSpan"]);
+const pluginNameAsCodeInUi = {
+  create(context) {
+    const options = context.options[0];
+    const pluginNames = (0, import_plugin_names.getPluginNames)({ additionalPluginNames: options?.additionalPluginNames, cwd: context.cwd });
+    return {
+      CallExpression(node) {
+        const calleeName = getCalleeName(node);
+        if (calleeName === null) {
+          return;
+        }
+        if (UI_TEXT_METHOD_NAMES.has(calleeName) && node.callee.type === "MemberExpression") {
+          inspectArgument(node.arguments[0]);
+          return;
+        }
+        if (!ELEMENT_FACTORY_NAMES.has(calleeName)) {
+          return;
+        }
+        for (const argument of node.arguments) {
+          if (argument.type !== "ObjectExpression") {
+            continue;
+          }
+          for (const property of argument.properties) {
+            if (property.type === "Property" && !property.computed && getKeyName(property.key) === "text") {
+              inspectExpression(property.value);
+            }
+          }
+        }
+      },
+      NewExpression(node) {
+        if (node.callee.type === "Identifier" && node.callee.name === "Notice") {
+          inspectArgument(node.arguments[0]);
+        }
+      }
+    };
+    function inspectArgument(argument) {
+      if (argument && argument.type !== "SpreadElement") {
+        inspectExpression(argument);
+      }
+    }
+    function inspectExpression(node) {
+      switch (node.type) {
+        case "BinaryExpression": {
+          if (node.operator === "+") {
+            inspectExpression(node.left);
+            inspectExpression(node.right);
+          }
+          break;
+        }
+        case "ConditionalExpression": {
+          inspectExpression(node.consequent);
+          inspectExpression(node.alternate);
+          break;
+        }
+        case "Literal": {
+          if (typeof node.value === "string") {
+            reportText(node, node.value);
+          }
+          break;
+        }
+        case "TemplateLiteral": {
+          for (const templateElement of node.quasis) {
+            reportText(templateElement, templateElement.value.raw);
+          }
+          break;
+        }
+        default: {
+          break;
+        }
+      }
+    }
+    function reportText(node, text) {
+      for (const match of (0, import_plugin_names.findPluginNameMatches)(text, pluginNames)) {
+        context.report({
+          data: { name: match.name },
+          messageId: MESSAGE_ID,
+          node
+        });
+      }
+    }
+  },
+  meta: {
+    docs: {
+      description: "Require a plugin name shown in UI to be built as a `<code>` element"
+    },
+    messages: {
+      [MESSAGE_ID]: "The plugin name `{{ name }}` is shown in UI as plain text. Build it as a `<code>` element instead: `appendCodeBlock()` into a `DocumentFragment`, or `createFragmentWithCodeBlocks()` with `asCodeBlock()`, from `@mnaoumov/obsidian-lib`'s `html-element.ts`."
+    },
+    schema: import_plugin_name_as_code.PLUGIN_NAME_RULE_SCHEMA,
+    type: "suggestion"
+  }
+};
+function getCalleeName(node) {
+  if (node.callee.type === "Identifier") {
+    return node.callee.name;
+  }
+  return node.callee.type === "MemberExpression" && !node.callee.computed && node.callee.property.type === "Identifier" ? node.callee.property.name : null;
+}
+function getKeyName(key) {
+  if (key.type === "Identifier") {
+    return key.name;
+  }
+  return key.type === "Literal" && typeof key.value === "string" ? key.value : null;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MESSAGE_ID,
+  pluginNameAsCodeInUi
+});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../../src/linters/eslint-rules/plugin-name-as-code-in-ui.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * ESLint rule: plugin-name-as-code-in-ui\n *\n * Reports an Obsidian plugin's display name inside a string that is shown in UI as plain text. In UI the name is\n * built as a `<code>` element instead: `appendCodeBlock()` into a `DocumentFragment`, or `createFragmentWithCodeBlocks()`\n * with `asCodeBlock()`, from `@mnaoumov/obsidian-lib`'s `html-element.ts`, and the fragment is what is passed on.\n *\n * Detection is best effort, by call shape, without type information. A string literal or template literal (or a\n * `+` concatenation or `? :` branch made of them) is read when it is:\n *\n * - the first argument of `new Notice(...)`;\n * - the first argument of `setName`, `setDesc`, `setText`, `appendText` or `setTitle` called on anything;\n * - the `text` property of an options object passed to `createEl`, `createDiv` or `createSpan`.\n *\n * There is no autofix: splitting a string around the name and building a fragment is a rewrite of the call, and\n * often of a translation key, which needs judgement. A command name, a ribbon tooltip and a window title cannot hold\n * markup, so the calls that set them (`addCommand`, `addRibbonIcon`, `document.title`) are not read at all.\n */\n\nimport type { Rule } from 'eslint';\nimport type {\n  CallExpression,\n  Expression,\n  NewExpression,\n  Node,\n  SpreadElement\n} from 'estree';\n\nimport type { PluginNameRuleOptions } from '../plugin-names.ts';\n\nimport {\n  findPluginNameMatches,\n  getPluginNames\n} from '../plugin-names.ts';\nimport { PLUGIN_NAME_RULE_SCHEMA } from './plugin-name-as-code.ts';\n\n/**\n * Message ID reported for a plugin name inside a UI string.\n */\nexport const MESSAGE_ID = 'pluginNameAsCodeInUi';\n\n/**\n * The methods whose first argument is shown in UI and may be a `DocumentFragment`.\n */\nconst UI_TEXT_METHOD_NAMES = new Set(['appendText', 'setDesc', 'setName', 'setText', 'setTitle']);\n\n/**\n * The element factories whose options object carries UI text in `text`.\n */\nconst ELEMENT_FACTORY_NAMES = new Set(['createDiv', 'createEl', 'createSpan']);\n\n/**\n * ESLint rule requiring a plugin name shown in UI to be built as a `<code>` element.\n */\nexport const pluginNameAsCodeInUi: Rule.RuleModule = {\n  create(context) {\n    const options = context.options[0] as PluginNameRuleOptions | undefined;\n    const pluginNames = getPluginNames({ additionalPluginNames: options?.additionalPluginNames, cwd: context.cwd });\n\n    return {\n      CallExpression(node: CallExpression): void {\n        const calleeName = getCalleeName(node);\n        if (calleeName === null) {\n          return;\n        }\n\n        if (UI_TEXT_METHOD_NAMES.has(calleeName) && node.callee.type === 'MemberExpression') {\n          inspectArgument(node.arguments[0]);\n          return;\n        }\n\n        if (!ELEMENT_FACTORY_NAMES.has(calleeName)) {\n          return;\n        }\n\n        for (const argument of node.arguments) {\n          if (argument.type !== 'ObjectExpression') {\n            continue;\n          }\n          for (const property of argument.properties) {\n            if (property.type === 'Property' && !property.computed && getKeyName(property.key) === 'text') {\n              inspectExpression(property.value);\n            }\n          }\n        }\n      },\n      NewExpression(node: NewExpression): void {\n        if (node.callee.type === 'Identifier' && node.callee.name === 'Notice') {\n          inspectArgument(node.arguments[0]);\n        }\n      }\n    };\n\n    function inspectArgument(argument: Expression | SpreadElement | undefined): void {\n      if (argument && argument.type !== 'SpreadElement') {\n        inspectExpression(argument);\n      }\n    }\n\n    function inspectExpression(node: Node): void {\n      switch (node.type) {\n        case 'BinaryExpression': {\n          if (node.operator === '+') {\n            inspectExpression(node.left);\n            inspectExpression(node.right);\n          }\n          break;\n        }\n        case 'ConditionalExpression': {\n          inspectExpression(node.consequent);\n          inspectExpression(node.alternate);\n          break;\n        }\n        case 'Literal': {\n          if (typeof node.value === 'string') {\n            reportText(node, node.value);\n          }\n          break;\n        }\n        case 'TemplateLiteral': {\n          for (const templateElement of node.quasis) {\n            reportText(templateElement, templateElement.value.raw);\n          }\n          break;\n        }\n        default: {\n          break;\n        }\n      }\n    }\n\n    function reportText(node: Node, text: string): void {\n      for (const match of findPluginNameMatches(text, pluginNames)) {\n        context.report({\n          data: { name: match.name },\n          messageId: MESSAGE_ID,\n          node\n        });\n      }\n    }\n  },\n  meta: {\n    docs: {\n      description: 'Require a plugin name shown in UI to be built as a `<code>` element'\n    },\n    messages: {\n      [MESSAGE_ID]: 'The plugin name `{{ name }}` is shown in UI as plain text. Build it as a `<code>` element instead: `appendCodeBlock()` into a `DocumentFragment`, or `createFragmentWithCodeBlocks()` with `asCodeBlock()`, from `@mnaoumov/obsidian-lib`\\'s `html-element.ts`.'\n    },\n    schema: PLUGIN_NAME_RULE_SCHEMA,\n    type: 'suggestion'\n  }\n};\n\n/**\n * Reads the name a call is made by: the function's name, or the method's for a member call.\n *\n * @param node - The call.\n * @returns The name, or `null` for a computed or otherwise unnamed callee.\n */\nfunction getCalleeName(node: CallExpression): null | string {\n  if (node.callee.type === 'Identifier') {\n    return node.callee.name;\n  }\n\n  return node.callee.type === 'MemberExpression' && !node.callee.computed && node.callee.property.type === 'Identifier'\n    ? node.callee.property.name\n    : null;\n}\n\n/**\n * Reads the name of an object property key written as an identifier or a string literal.\n *\n * @param key - The key.\n * @returns The name, or `null` for any other key.\n */\nfunction getKeyName(key: Node): null | string {\n  if (key.type === 'Identifier') {\n    return key.name;\n  }\n\n  return key.type === 'Literal' && typeof key.value === 'string' ? key.value : null;\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgCA,0BAGO;AACP,iCAAwC;AAKjC,MAAM,aAAa;AAK1B,MAAM,uBAAuB,oBAAI,IAAI,CAAC,cAAc,WAAW,WAAW,WAAW,UAAU,CAAC;AAKhG,MAAM,wBAAwB,oBAAI,IAAI,CAAC,aAAa,YAAY,YAAY,CAAC;AAKtE,MAAM,uBAAwC;AAAA,EACnD,OAAO,SAAS;AACd,UAAM,UAAU,QAAQ,QAAQ,CAAC;AACjC,UAAM,kBAAc,oCAAe,EAAE,uBAAuB,SAAS,uBAAuB,KAAK,QAAQ,IAAI,CAAC;AAE9G,WAAO;AAAA,MACL,eAAe,MAA4B;AACzC,cAAM,aAAa,cAAc,IAAI;AACrC,YAAI,eAAe,MAAM;AACvB;AAAA,QACF;AAEA,YAAI,qBAAqB,IAAI,UAAU,KAAK,KAAK,OAAO,SAAS,oBAAoB;AACnF,0BAAgB,KAAK,UAAU,CAAC,CAAC;AACjC;AAAA,QACF;AAEA,YAAI,CAAC,sBAAsB,IAAI,UAAU,GAAG;AAC1C;AAAA,QACF;AAEA,mBAAW,YAAY,KAAK,WAAW;AACrC,cAAI,SAAS,SAAS,oBAAoB;AACxC;AAAA,UACF;AACA,qBAAW,YAAY,SAAS,YAAY;AAC1C,gBAAI,SAAS,SAAS,cAAc,CAAC,SAAS,YAAY,WAAW,SAAS,GAAG,MAAM,QAAQ;AAC7F,gCAAkB,SAAS,KAAK;AAAA,YAClC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,cAAc,MAA2B;AACvC,YAAI,KAAK,OAAO,SAAS,gBAAgB,KAAK,OAAO,SAAS,UAAU;AACtE,0BAAgB,KAAK,UAAU,CAAC,CAAC;AAAA,QACnC;AAAA,MACF;AAAA,IACF;AAEA,aAAS,gBAAgB,UAAwD;AAC/E,UAAI,YAAY,SAAS,SAAS,iBAAiB;AACjD,0BAAkB,QAAQ;AAAA,MAC5B;AAAA,IACF;AAEA,aAAS,kBAAkB,MAAkB;AAC3C,cAAQ,KAAK,MAAM;AAAA,QACjB,KAAK,oBAAoB;AACvB,cAAI,KAAK,aAAa,KAAK;AACzB,8BAAkB,KAAK,IAAI;AAC3B,8BAAkB,KAAK,KAAK;AAAA,UAC9B;AACA;AAAA,QACF;AAAA,QACA,KAAK,yBAAyB;AAC5B,4BAAkB,KAAK,UAAU;AACjC,4BAAkB,KAAK,SAAS;AAChC;AAAA,QACF;AAAA,QACA,KAAK,WAAW;AACd,cAAI,OAAO,KAAK,UAAU,UAAU;AAClC,uBAAW,MAAM,KAAK,KAAK;AAAA,UAC7B;AACA;AAAA,QACF;AAAA,QACA,KAAK,mBAAmB;AACtB,qBAAW,mBAAmB,KAAK,QAAQ;AACzC,uBAAW,iBAAiB,gBAAgB,MAAM,GAAG;AAAA,UACvD;AACA;AAAA,QACF;AAAA,QACA,SAAS;AACP;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,aAAS,WAAW,MAAY,MAAoB;AAClD,iBAAW,aAAS,2CAAsB,MAAM,WAAW,GAAG;AAC5D,gBAAQ,OAAO;AAAA,UACb,MAAM,EAAE,MAAM,MAAM,KAAK;AAAA,UACzB,WAAW;AAAA,UACX;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,MACJ,aAAa;AAAA,IACf;AAAA,IACA,UAAU;AAAA,MACR,CAAC,UAAU,GAAG;AAAA,IAChB;AAAA,IACA,QAAQ;AAAA,IACR,MAAM;AAAA,EACR;AACF;AAQA,SAAS,cAAc,MAAqC;AAC1D,MAAI,KAAK,OAAO,SAAS,cAAc;AACrC,WAAO,KAAK,OAAO;AAAA,EACrB;AAEA,SAAO,KAAK,OAAO,SAAS,sBAAsB,CAAC,KAAK,OAAO,YAAY,KAAK,OAAO,SAAS,SAAS,eACrG,KAAK,OAAO,SAAS,OACrB;AACN;AAQA,SAAS,WAAW,KAA0B;AAC5C,MAAI,IAAI,SAAS,cAAc;AAC7B,WAAO,IAAI;AAAA,EACb;AAEA,SAAO,IAAI,SAAS,aAAa,OAAO,IAAI,UAAU,WAAW,IAAI,QAAQ;AAC/E;",
  "names": []
}


package/dist/lib/cjs/linters/eslint-rules/plugin-name-as-code-in-ui.d.cts

@@ -0,0 +1,30 @@
+/// <reference path="../../index.d.cts" />
+/**
+ * @file
+ *
+ * ESLint rule: plugin-name-as-code-in-ui
+ *
+ * Reports an Obsidian plugin's display name inside a string that is shown in UI as plain text. In UI the name is
+ * built as a `<code>` element instead: `appendCodeBlock()` into a `DocumentFragment`, or `createFragmentWithCodeBlocks()`
+ * with `asCodeBlock()`, from `@mnaoumov/obsidian-lib`'s `html-element.ts`, and the fragment is what is passed on.
+ *
+ * Detection is best effort, by call shape, without type information. A string literal or template literal (or a
+ * `+` concatenation or `? :` branch made of them) is read when it is:
+ *
+ * - the first argument of `new Notice(...)`;
+ * - the first argument of `setName`, `setDesc`, `setText`, `appendText` or `setTitle` called on anything;
+ * - the `text` property of an options object passed to `createEl`, `createDiv` or `createSpan`.
+ *
+ * There is no autofix: splitting a string around the name and building a fragment is a rewrite of the call, and
+ * often of a translation key, which needs judgement. A command name, a ribbon tooltip and a window title cannot hold
+ * markup, so the calls that set them (`addCommand`, `addRibbonIcon`, `document.title`) are not read at all.
+ */
+import type { Rule } from 'eslint' with { 'resolution-mode': 'import' };
+/**
+ * Message ID reported for a plugin name inside a UI string.
+ */
+export declare const MESSAGE_ID = "pluginNameAsCodeInUi";
+/**
+ * ESLint rule requiring a plugin name shown in UI to be built as a `<code>` element.
+ */
+export declare const pluginNameAsCodeInUi: Rule.RuleModule;

package/dist/lib/cjs/linters/eslint-rules/plugin-name-as-code.cjs

@@ -0,0 +1,215 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function () {
+function ensureDisposeSymbols(symbolConstructor = Symbol) {
+  symbolConstructor.asyncDispose ??= symbolConstructor.for("Symbol.asyncDispose");
+  symbolConstructor.dispose ??= symbolConstructor.for("Symbol.dispose");
+}
+
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return "/";
+    },
+    env: {},
+    platform: "android"
+  };
+  const existingProcess = globalThis.process;
+  if (!existingProcess) {
+    globalThis.process = browserProcess;
+    return;
+  }
+  if (existingProcess.versions?.node) {
+    return;
+  }
+  const existingProcessRecord = existingProcess;
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+  existingProcessRecord["browser"] = true;
+}
+
+function keepName($unknown) {
+  return $unknown;
+}
+
+(function initCjs() {
+  const globalThisRecord = globalThis;
+  ensureDisposeSymbols();
+  globalThisRecord["__name"] ??= keepName;
+  globalThisRecord["__extractDefault"] ??= extractDefault;
+  ensureBrowserProcess();
+  function extractDefault(module) {
+    return module && module.__esModule && "default" in module ? module.default : module;
+  }
+})();
+})();
+(function patchObsidianRequire() {
+  const originalRequire = require;
+  if (!originalRequire || originalRequire.__isPatched) {
+    return;
+  }
+
+  require = Object.assign(
+    (id) => requirePatched(id),
+    originalRequire,
+    {
+      __isPatched: true
+    }
+  );
+
+  function extractDefault(module) {
+    return module && module.__esModule && 'default' in module ? module.default : module;
+  }
+
+  const OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/autocomplete',
+  '@codemirror/collab',
+  '@codemirror/commands',
+  '@codemirror/language',
+  '@codemirror/lint',
+  '@codemirror/search',
+  '@codemirror/state',
+  '@codemirror/text',
+  '@codemirror/view',
+  '@lezer/common',
+  '@lezer/highlight',
+  '@lezer/lr',
+  'obsidian']
+  );
+
+  const DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES = new Set([
+  '@codemirror/closebrackets',
+  '@codemirror/comment',
+  '@codemirror/fold',
+  '@codemirror/gutter',
+  '@codemirror/highlight',
+  '@codemirror/history',
+  '@codemirror/matchbrackets',
+  '@codemirror/panel',
+  '@codemirror/rangeset',
+  '@codemirror/rectangular-selection',
+  '@codemirror/stream-parser',
+  '@codemirror/tooltip']
+  );
+
+  function requirePatched(id) {
+    if (OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id) || DEPRECATED_OBSIDIAN_BUILT_IN_MODULE_NAMES.has(id)) {
+      return originalRequire?.(id);
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-deprecated, obsidianmd/no-global-this  -- Need access to app. Actively use globalThis.
+    if (globalThis.app.isMobile) {
+      if (id === 'process' || id === 'node:process') {
+        // eslint-disable-next-line no-console -- Valid usage.
+        console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Fake process object is returned instead.`);
+
+        return process;
+      }
+    } else {
+      const module = originalRequire?.(id);
+      if (module) {
+        return extractDefault(module);
+      }
+    }
+
+    // eslint-disable-next-line no-console -- Valid usage.
+    console.debug(`The most likely you can safely ignore this error. Module not found: ${id}. Empty object is returned instead.`);
+    return {};
+  }
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plugin_name_as_code_exports = {};
+__export(plugin_name_as_code_exports, {
+  MESSAGE_ID: () => MESSAGE_ID,
+  PLUGIN_NAME_RULE_SCHEMA: () => PLUGIN_NAME_RULE_SCHEMA,
+  pluginNameAsCode: () => pluginNameAsCode
+});
+module.exports = __toCommonJS(plugin_name_as_code_exports);
+var import_plugin_names = require('../plugin-names.cjs');
+const MESSAGE_ID = "pluginNameAsCode";
+const EXCLUDED_COMMENT_PATTERNS = [
+  /(?<ticks>`+)[\s\S]*?\k<ticks>/g,
+  /\{@link\w*[^}]*\}/g,
+  /\b[a-z][\w+.-]*:\/\/\S+/gi
+];
+const COMMENT_OPENING_LENGTH = 2;
+const PLUGIN_NAME_RULE_SCHEMA = [
+  {
+    additionalProperties: false,
+    properties: {
+      additionalPluginNames: {
+        items: { type: "string" },
+        type: "array"
+      }
+    },
+    type: "object"
+  }
+];
+const pluginNameAsCode = {
+  create(context) {
+    const options = context.options[0];
+    const pluginNames = (0, import_plugin_names.getPluginNames)({ additionalPluginNames: options?.additionalPluginNames, cwd: context.cwd });
+    const sourceCode = context.sourceCode;
+    return {
+      Program() {
+        for (const comment of sourceCode.getAllComments()) {
+          const [valueStart] = sourceCode.getRange(comment);
+          for (const match of (0, import_plugin_names.findPluginNameMatches)(comment.value, pluginNames, EXCLUDED_COMMENT_PATTERNS)) {
+            const start = valueStart + COMMENT_OPENING_LENGTH + match.index;
+            const end = start + match.name.length;
+            context.report({
+              data: { name: match.name },
+              fix: (fixer) => fixer.replaceTextRange([start, end], `\`${match.name}\``),
+              loc: {
+                end: sourceCode.getLocFromIndex(end),
+                start: sourceCode.getLocFromIndex(start)
+              },
+              messageId: MESSAGE_ID
+            });
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    docs: {
+      description: "Require a plugin name in a comment to be marked as code with backticks"
+    },
+    fixable: "code",
+    messages: {
+      [MESSAGE_ID]: "Mark the plugin name `{{ name }}` as code: wrap it in backticks."
+    },
+    schema: PLUGIN_NAME_RULE_SCHEMA,
+    type: "suggestion"
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MESSAGE_ID,
+  PLUGIN_NAME_RULE_SCHEMA,
+  pluginNameAsCode
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vLi4vc3JjL2xpbnRlcnMvZXNsaW50LXJ1bGVzL3BsdWdpbi1uYW1lLWFzLWNvZGUudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBFU0xpbnQgcnVsZTogcGx1Z2luLW5hbWUtYXMtY29kZVxuICpcbiAqIFJlcG9ydHMgYW4gT2JzaWRpYW4gcGx1Z2luJ3MgZGlzcGxheSBuYW1lIHdyaXR0ZW4gYXMgcGxhaW4gdGV4dCBpbiBhIGNvZGUgY29tbWVudCwgYW5kIGF1dG9maXhlcyBpdCBieSB3cmFwcGluZ1xuICogdGhlIG5hbWUgaW4gYmFja3RpY2tzLiBUU0RvYyByZW5kZXJzIGEgbmFtZSBpbiBiYWNrdGlja3MgYXMgY29kZSwgc28gYSBkb2MgY29tbWVudCByZWFkcyB0aGUgc2FtZSBhcyB0aGUgUkVBRE1FLlxuICpcbiAqIEV2ZXJ5IGNvbW1lbnQgaXMgcmVhZDogYC8vYCwgYC8qICpcXC9gIGFuZCBKU0RvYyAvIFRTRG9jLiBBIG5hbWUgYWxyZWFkeSBpbnNpZGUgYSBjb2RlIHNwYW4sIGFuIGlubGluZSBgQGxpbmtgIHRhZ1xuICogKHdob3NlIHRhcmdldCBpcyBhbiBpZGVudGlmaWVyKSBvciBhIFVSTCBpcyBsZWZ0IGFsb25lLiBUaGUgbmFtZXMgY29tZSBmcm9tIGBwbHVnaW4tbmFtZXMudHNgOiB0aGUgc2hhcmVkIGxpc3QsXG4gKiB0aGUgcHJvamVjdCdzIG93biBgbWFuaWZlc3QuanNvbmAgYG5hbWVgLCBhbmQgdGhlIHJ1bGUncyBgYWRkaXRpb25hbFBsdWdpbk5hbWVzYCBvcHRpb24uXG4gKlxuICogTm90IGF0dGVtcHRlZDogYSBtdWx0aS13b3JkIG5hbWUgYnJva2VuIGFjcm9zcyB0d28gY29tbWVudCBsaW5lcywgd2hpY2ggYSByZWFkZXIgY2Fubm90IHRlbGwgZnJvbSB0d28gdW5yZWxhdGVkXG4gKiB3b3JkcyB3aXRob3V0IHVuZGVyc3RhbmRpbmcgdGhlIHByb3NlLlxuICovXG5cbmltcG9ydCB0eXBlIHsgUnVsZSB9IGZyb20gJ2VzbGludCc7XG5cbmltcG9ydCB0eXBlIHsgUGx1Z2luTmFtZVJ1bGVPcHRpb25zIH0gZnJvbSAnLi4vcGx1Z2luLW5hbWVzLnRzJztcblxuaW1wb3J0IHtcbiAgZmluZFBsdWdpbk5hbWVNYXRjaGVzLFxuICBnZXRQbHVnaW5OYW1lc1xufSBmcm9tICcuLi9wbHVnaW4tbmFtZXMudHMnO1xuXG4vKipcbiAqIE1lc3NhZ2UgSUQgcmVwb3J0ZWQgZm9yIGEgcGx1Z2luIG5hbWUgd3JpdHRlbiBhcyBwbGFpbiB0ZXh0IGluIGEgY29tbWVudC5cbiAqL1xuZXhwb3J0IGNvbnN0IE1FU1NBR0VfSUQgPSAncGx1Z2luTmFtZUFzQ29kZSc7XG5cbi8qKlxuICogVGhlIGNvbW1lbnQgc3BhbnMgd2hvc2UgcGx1Z2luIG5hbWVzIGFyZSBhbHJlYWR5IG1hcmtlZCBvciBhcmUgbm90IHByb3NlOiBhIGNvZGUgc3BhbiwgYW4gaW5saW5lIGBAbGlua2AgdGFnLCBhIFVSTC5cbiAqL1xuY29uc3QgRVhDTFVERURfQ09NTUVOVF9QQVRURVJOUzogcmVhZG9ubHkgUmVnRXhwW10gPSBbXG4gIC8oPzx0aWNrcz5gKylbXFxzXFxTXSo/XFxrPHRpY2tzPi9nLFxuICAvXFx7QGxpbmtcXHcqW159XSpcXH0vZyxcbiAgL1xcYlthLXpdW1xcdysuLV0qOlxcL1xcL1xcUysvZ2lcbl07XG5cbi8qKlxuICogVGhlIGxlbmd0aCBvZiB0aGUgb3BlbmluZyBkZWxpbWl0ZXIgb2YgYSBgLy9gIG9yIGAvKmAgY29tbWVudCwgd2hpY2ggYGNvbW1lbnQudmFsdWVgIGxlYXZlcyBvdXQuXG4gKi9cbmNvbnN0IENPTU1FTlRfT1BFTklOR19MRU5HVEggPSAyO1xuXG4vKipcbiAqIFRoZSBKU09OIHNjaGVtYSBvZiB0aGUgb3B0aW9ucyB0aGUgcGx1Z2luLW5hbWUgcnVsZXMgdGFrZS5cbiAqL1xuZXhwb3J0IGNvbnN0IFBMVUdJTl9OQU1FX1JVTEVfU0NIRU1BOiBSdWxlLlJ1bGVNZXRhRGF0YVsnc2NoZW1hJ10gPSBbXG4gIHtcbiAgICBhZGRpdGlvbmFsUHJvcGVydGllczogZmFsc2UsXG4gICAgcHJvcGVydGllczoge1xuICAgICAgYWRkaXRpb25hbFBsdWdpbk5hbWVzOiB7XG4gICAgICAgIGl0ZW1zOiB7IHR5cGU6ICdzdHJpbmcnIH0sXG4gICAgICAgIHR5cGU6ICdhcnJheSdcbiAgICAgIH1cbiAgICB9LFxuICAgIHR5cGU6ICdvYmplY3QnXG4gIH1cbl07XG5cbi8qKlxuICogRVNMaW50IHJ1bGUgcmVxdWlyaW5nIGEgcGx1Z2luIG5hbWUgaW4gYSBjb21tZW50IHRvIGJlIG1hcmtlZCBhcyBjb2RlLlxuICovXG5leHBvcnQgY29uc3QgcGx1Z2luTmFtZUFzQ29kZTogUnVsZS5SdWxlTW9kdWxlID0ge1xuICBjcmVhdGUoY29udGV4dCkge1xuICAgIGNvbnN0IG9wdGlvbnMgPSBjb250ZXh0Lm9wdGlvbnNbMF0gYXMgUGx1Z2luTmFtZVJ1bGVPcHRpb25zIHwgdW5kZWZpbmVkO1xuICAgIGNvbnN0IHBsdWdpbk5hbWVzID0gZ2V0UGx1Z2luTmFtZXMoeyBhZGRpdGlvbmFsUGx1Z2luTmFtZXM6IG9wdGlvbnM/LmFkZGl0aW9uYWxQbHVnaW5OYW1lcywgY3dkOiBjb250ZXh0LmN3ZCB9KTtcbiAgICBjb25zdCBzb3VyY2VDb2RlID0gY29udGV4dC5zb3VyY2VDb2RlO1xuXG4gICAgcmV0dXJuIHtcbiAgICAgIFByb2dyYW0oKTogdm9pZCB7XG4gICAgICAgIGZvciAoY29uc3QgY29tbWVudCBvZiBzb3VyY2VDb2RlLmdldEFsbENvbW1lbnRzKCkpIHtcbiAgICAgICAgICBjb25zdCBbdmFsdWVTdGFydF0gPSBzb3VyY2VDb2RlLmdldFJhbmdlKGNvbW1lbnQpO1xuICAgICAgICAgIGZvciAoY29uc3QgbWF0Y2ggb2YgZmluZFBsdWdpbk5hbWVNYXRjaGVzKGNvbW1lbnQudmFsdWUsIHBsdWdpbk5hbWVzLCBFWENMVURFRF9DT01NRU5UX1BBVFRFUk5TKSkge1xuICAgICAgICAgICAgY29uc3Qgc3RhcnQgPSB2YWx1ZVN0YXJ0ICsgQ09NTUVOVF9PUEVOSU5HX0xFTkdUSCArIG1hdGNoLmluZGV4O1xuICAgICAgICAgICAgY29uc3QgZW5kID0gc3RhcnQgKyBtYXRjaC5uYW1lLmxlbmd0aDtcbiAgICAgICAgICAgIGNvbnRleHQucmVwb3J0KHtcbiAgICAgICAgICAgICAgZGF0YTogeyBuYW1lOiBtYXRjaC5uYW1lIH0sXG4gICAgICAgICAgICAgIGZpeDogKGZpeGVyKSA9PiBmaXhlci5yZXBsYWNlVGV4dFJhbmdlKFtzdGFydCwgZW5kXSwgYFxcYCR7bWF0Y2gubmFtZX1cXGBgKSxcbiAgICAgICAgICAgICAgbG9jOiB7XG4gICAgICAgICAgICAgICAgZW5kOiBzb3VyY2VDb2RlLmdldExvY0Zyb21JbmRleChlbmQpLFxuICAgICAgICAgICAgICAgIHN0YXJ0OiBzb3VyY2VDb2RlLmdldExvY0Zyb21JbmRleChzdGFydClcbiAgICAgICAgICAgICAgfSxcbiAgICAgICAgICAgICAgbWVzc2FnZUlkOiBNRVNTQUdFX0lEXG4gICAgICAgICAgICB9KTtcbiAgICAgICAgICB9XG4gICAgICAgIH1cbiAgICAgIH1cbiAgICB9O1xuICB9LFxuICBtZXRhOiB7XG4gICAgZG9jczoge1xuICAgICAgZGVzY3JpcHRpb246ICdSZXF1aXJlIGEgcGx1Z2luIG5hbWUgaW4gYSBjb21tZW50IHRvIGJlIG1hcmtlZCBhcyBjb2RlIHdpdGggYmFja3RpY2tzJ1xuICAgIH0sXG4gICAgZml4YWJsZTogJ2NvZGUnLFxuICAgIG1lc3NhZ2VzOiB7XG4gICAgICBbTUVTU0FHRV9JRF06ICdNYXJrIHRoZSBwbHVnaW4gbmFtZSBge3sgbmFtZSB9fWAgYXMgY29kZTogd3JhcCBpdCBpbiBiYWNrdGlja3MuJ1xuICAgIH0sXG4gICAgc2NoZW1hOiBQTFVHSU5fTkFNRV9SVUxFX1NDSEVNQSxcbiAgICB0eXBlOiAnc3VnZ2VzdGlvbidcbiAgfVxufTtcbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFvQkEsMEJBR087QUFLQSxNQUFNLGFBQWE7QUFLMUIsTUFBTSw0QkFBK0M7QUFBQSxFQUNuRDtBQUFBLEVBQ0E7QUFBQSxFQUNBO0FBQ0Y7QUFLQSxNQUFNLHlCQUF5QjtBQUt4QixNQUFNLDBCQUF1RDtBQUFBLEVBQ2xFO0FBQUEsSUFDRSxzQkFBc0I7QUFBQSxJQUN0QixZQUFZO0FBQUEsTUFDVix1QkFBdUI7QUFBQSxRQUNyQixPQUFPLEVBQUUsTUFBTSxTQUFTO0FBQUEsUUFDeEIsTUFBTTtBQUFBLE1BQ1I7QUFBQSxJQUNGO0FBQUEsSUFDQSxNQUFNO0FBQUEsRUFDUjtBQUNGO0FBS08sTUFBTSxtQkFBb0M7QUFBQSxFQUMvQyxPQUFPLFNBQVM7QUFDZCxVQUFNLFVBQVUsUUFBUSxRQUFRLENBQUM7QUFDakMsVUFBTSxrQkFBYyxvQ0FBZSxFQUFFLHVCQUF1QixTQUFTLHVCQUF1QixLQUFLLFFBQVEsSUFBSSxDQUFDO0FBQzlHLFVBQU0sYUFBYSxRQUFRO0FBRTNCLFdBQU87QUFBQSxNQUNMLFVBQWdCO0FBQ2QsbUJBQVcsV0FBVyxXQUFXLGVBQWUsR0FBRztBQUNqRCxnQkFBTSxDQUFDLFVBQVUsSUFBSSxXQUFXLFNBQVMsT0FBTztBQUNoRCxxQkFBVyxhQUFTLDJDQUFzQixRQUFRLE9BQU8sYUFBYSx5QkFBeUIsR0FBRztBQUNoRyxrQkFBTSxRQUFRLGFBQWEseUJBQXlCLE1BQU07QUFDMUQsa0JBQU0sTUFBTSxRQUFRLE1BQU0sS0FBSztBQUMvQixvQkFBUSxPQUFPO0FBQUEsY0FDYixNQUFNLEVBQUUsTUFBTSxNQUFNLEtBQUs7QUFBQSxjQUN6QixLQUFLLENBQUMsVUFBVSxNQUFNLGlCQUFpQixDQUFDLE9BQU8sR0FBRyxHQUFHLEtBQUssTUFBTSxJQUFJLElBQUk7QUFBQSxjQUN4RSxLQUFLO0FBQUEsZ0JBQ0gsS0FBSyxXQUFXLGdCQUFnQixHQUFHO0FBQUEsZ0JBQ25DLE9BQU8sV0FBVyxnQkFBZ0IsS0FBSztBQUFBLGNBQ3pDO0FBQUEsY0FDQSxXQUFXO0FBQUEsWUFDYixDQUFDO0FBQUEsVUFDSDtBQUFBLFFBQ0Y7QUFBQSxNQUNGO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFBQSxFQUNBLE1BQU07QUFBQSxJQUNKLE1BQU07QUFBQSxNQUNKLGFBQWE7QUFBQSxJQUNmO0FBQUEsSUFDQSxTQUFTO0FBQUEsSUFDVCxVQUFVO0FBQUEsTUFDUixDQUFDLFVBQVUsR0FBRztBQUFBLElBQ2hCO0FBQUEsSUFDQSxRQUFRO0FBQUEsSUFDUixNQUFNO0FBQUEsRUFDUjtBQUNGOyIsCiAgIm5hbWVzIjogW10KfQo=

package/dist/lib/cjs/linters/eslint-rules/plugin-name-as-code.d.cts

@@ -0,0 +1,29 @@
+/// <reference path="../../index.d.cts" />
+/**
+ * @file
+ *
+ * ESLint rule: plugin-name-as-code
+ *
+ * Reports an Obsidian plugin's display name written as plain text in a code comment, and autofixes it by wrapping
+ * the name in backticks. TSDoc renders a name in backticks as code, so a doc comment reads the same as the README.
+ *
+ * Every comment is read: `//`, `/* *\/` and JSDoc / TSDoc. A name already inside a code span, an inline `@link` tag
+ * (whose target is an identifier) or a URL is left alone. The names come from `plugin-names.ts`: the shared list,
+ * the project's own `manifest.json` `name`, and the rule's `additionalPluginNames` option.
+ *
+ * Not attempted: a multi-word name broken across two comment lines, which a reader cannot tell from two unrelated
+ * words without understanding the prose.
+ */
+import type { Rule } from 'eslint' with { 'resolution-mode': 'import' };
+/**
+ * Message ID reported for a plugin name written as plain text in a comment.
+ */
+export declare const MESSAGE_ID = "pluginNameAsCode";
+/**
+ * The JSON schema of the options the plugin-name rules take.
+ */
+export declare const PLUGIN_NAME_RULE_SCHEMA: Rule.RuleMetaData['schema'];
+/**
+ * ESLint rule requiring a plugin name in a comment to be marked as code.
+ */
+export declare const pluginNameAsCode: Rule.RuleModule;