@mnaoumov/typescript-dev-toolkit 3.6.4 → 3.7.1

package/dist/lib/cjs/docs-site/outdated-references.cjs

@@ -0,0 +1,118 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+"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 outdated_references_exports = {};
+__export(outdated_references_exports, {
+  OUTDATED_REFERENCE_ALLOW_MARKER: () => OUTDATED_REFERENCE_ALLOW_MARKER,
+  assertNoOutdatedReferences: () => assertNoOutdatedReferences,
+  findOutdatedReferences: () => findOutdatedReferences,
+  findOutdatedReferencesInText: () => findOutdatedReferencesInText,
+  formatOutdatedReferences: () => formatOutdatedReferences
+});
+module.exports = __toCommonJS(outdated_references_exports);
+var import_node_fs = require('node:fs');
+var import_promises = require('node:fs/promises');
+var import_node_path = require('node:path');
+const OUTDATED_REFERENCE_ALLOW_MARKER = "outdated-reference-ok";
+const OUTDATED_REFERENCE_PATTERNS = [
+  {
+    hint: "a module path or repository link of the retired `obsidian-dev-utils` package; name the `@mnaoumov/*` package that has it now",
+    regExp: /obsidian-dev-utils\//u
+  },
+  {
+    hint: "an import of the retired `obsidian-dev-utils` package; import the `@mnaoumov/*` package that has it now",
+    regExp: /from\s+['"]obsidian-dev-utils['"]/u
+  },
+  {
+    hint: "the legacy `__obsidianDevUtils` console recipe; use `getSharedAbortController()` or the `Symbol.for('@mnaoumov/typescript-lib/state')` slot",
+    regExp: /__obsidianDevUtils\.sharedAbortController/u
+  }
+];
+async function assertNoOutdatedReferences(rootDirectory) {
+  const references = await findOutdatedReferences(rootDirectory);
+  if (references.length > 0) {
+    throw new Error(`${String(references.length)} outdated reference(s):
+${formatOutdatedReferences(references)}`);
+  }
+}
+async function findOutdatedReferences(rootDirectory) {
+  const readmePath = (0, import_node_path.join)(rootDirectory, "README.md");
+  const files = [
+    ...(0, import_node_fs.existsSync)(readmePath) ? [readmePath] : [],
+    ...await listFiles((0, import_node_path.join)(rootDirectory, "docs", "src", "content", "docs"), (name) => /\.mdx?$/u.test(name), ["api"]),
+    ...await listFiles((0, import_node_path.join)(rootDirectory, "src"), isScannedSource, []),
+    ...await listFiles((0, import_node_path.join)(rootDirectory, "scripts"), isScannedSource, [])
+  ];
+  const references = [];
+  for (const file of files) {
+    references.push(...findOutdatedReferencesInText((0, import_node_path.relative)(rootDirectory, file).replaceAll("\\", "/"), await (0, import_promises.readFile)(file, "utf-8")));
+  }
+  return references;
+}
+function findOutdatedReferencesInText(filePath, text) {
+  const references = [];
+  for (const [index, line] of text.split(/\r?\n/u).entries()) {
+    if (line.includes(OUTDATED_REFERENCE_ALLOW_MARKER)) {
+      continue;
+    }
+    for (const pattern of OUTDATED_REFERENCE_PATTERNS) {
+      if (pattern.regExp.test(line)) {
+        references.push({ filePath, hint: pattern.hint, line: index + 1, text: line.trim() });
+        break;
+      }
+    }
+  }
+  return references;
+}
+function formatOutdatedReferences(references) {
+  return references.map((reference) => `${reference.filePath}:${String(reference.line)} - ${reference.text} (${reference.hint})`).join("\n");
+}
+function isScannedSource(name) {
+  return name.endsWith(".ts") && !name.endsWith(".d.ts") && !name.endsWith(".test.ts") && name !== "__merged.ts";
+}
+async function listFiles(directory, isIncluded, excludedDirectories) {
+  const files = [];
+  if (!(0, import_node_fs.existsSync)(directory)) {
+    return files;
+  }
+  for (const entry of await (0, import_promises.readdir)(directory, { withFileTypes: true })) {
+    const entryPath = (0, import_node_path.join)(directory, entry.name);
+    if (entry.isDirectory()) {
+      if (!excludedDirectories.includes(entry.name)) {
+        files.push(...await listFiles(entryPath, isIncluded, excludedDirectories));
+      }
+    } else if (isIncluded(entry.name)) {
+      files.push(entryPath);
+    }
+  }
+  return files.sort();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  OUTDATED_REFERENCE_ALLOW_MARKER,
+  assertNoOutdatedReferences,
+  findOutdatedReferences,
+  findOutdatedReferencesInText,
+  formatOutdatedReferences
+});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/docs-site/outdated-references.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Finds references to the retired `obsidian-dev-utils` package that point a reader at something that no longer\n * exists: one of its module paths, a link into its repository, or the legacy console recipe for the shared abort\n * controller.\n *\n * The bare name `obsidian-dev-utils` is NOT flagged: `@mnaoumov/obsidian-lib` keeps it on purpose as a wire name (its\n * debug namespace, CSS class and event prefix), and a migration note may name the package. What is flagged is the\n * name used as an ADDRESS.\n *\n * Scanned, where present: `README.md`, the guides under `docs/src/content/docs` (not the generated API reference,\n * which is rendered from the TSDoc this also scans), and every non-test `.ts` file under `src/` and `scripts/`.\n * `CHANGELOG.md` is history and is not scanned. A line that names an old address on purpose, such as a migration\n * note, carries `outdated-reference-ok` on that line.\n */\n\nimport { existsSync } from 'node:fs';\nimport {\n  readdir,\n  readFile\n} from 'node:fs/promises';\nimport {\n  join,\n  relative\n} from 'node:path';\n\n/**\n * The marker that allows an outdated reference on its line.\n */\nexport const OUTDATED_REFERENCE_ALLOW_MARKER = 'outdated-reference-ok';\n\ninterface OutdatedReferencePattern {\n  readonly hint: string;\n  readonly regExp: RegExp;\n}\n\nconst OUTDATED_REFERENCE_PATTERNS: readonly OutdatedReferencePattern[] = [\n  {\n    hint: 'a module path or repository link of the retired `obsidian-dev-utils` package; name the `@mnaoumov/*` package that has it now',\n    regExp: /obsidian-dev-utils\\//u\n  },\n  {\n    hint: 'an import of the retired `obsidian-dev-utils` package; import the `@mnaoumov/*` package that has it now',\n    regExp: /from\\s+['\"]obsidian-dev-utils['\"]/u\n  },\n  {\n    hint: 'the legacy `__obsidianDevUtils` console recipe; use `getSharedAbortController()` or the `Symbol.for(\\'@mnaoumov/typescript-lib/state\\')` slot',\n    regExp: /__obsidianDevUtils\\.sharedAbortController/u\n  }\n];\n\n/**\n * An outdated reference found in a file.\n */\nexport interface OutdatedReference {\n  /**\n   * The file's path, relative to the package root.\n   */\n  readonly filePath: string;\n\n  /**\n   * What to write instead.\n   */\n  readonly hint: string;\n\n  /**\n   * The 1-based line.\n   */\n  readonly line: number;\n\n  /**\n   * The line's text, trimmed.\n   */\n  readonly text: string;\n}\n\n/**\n * Finds the outdated references in the package and throws when there is one, for a gate test or script.\n *\n * @param rootDirectory - The package root.\n * @returns A promise that resolves when there is none.\n * @throws {Error} Listing every reference, one per line.\n */\nexport async function assertNoOutdatedReferences(rootDirectory: string): Promise<void> {\n  const references = await findOutdatedReferences(rootDirectory);\n  if (references.length > 0) {\n    throw new Error(`${String(references.length)} outdated reference(s):\\n${formatOutdatedReferences(references)}`);\n  }\n}\n\n/**\n * Finds the outdated references in the package.\n *\n * @param rootDirectory - The package root.\n * @returns The outdated references.\n */\nexport async function findOutdatedReferences(rootDirectory: string): Promise<OutdatedReference[]> {\n  const readmePath = join(rootDirectory, 'README.md');\n  const files = [\n    ...existsSync(readmePath) ? [readmePath] : [],\n    ...await listFiles(join(rootDirectory, 'docs', 'src', 'content', 'docs'), (name) => /\\.mdx?$/u.test(name), ['api']),\n    ...await listFiles(join(rootDirectory, 'src'), isScannedSource, []),\n    ...await listFiles(join(rootDirectory, 'scripts'), isScannedSource, [])\n  ];\n  const references: OutdatedReference[] = [];\n  for (const file of files) {\n    references.push(...findOutdatedReferencesInText(relative(rootDirectory, file).replaceAll('\\\\', '/'), await readFile(file, 'utf-8')));\n  }\n  return references;\n}\n\n/**\n * Finds the outdated references in one file's text.\n *\n * @param filePath - The file's path, used in the result.\n * @param text - The file's text.\n * @returns The outdated references, in line order.\n */\nexport function findOutdatedReferencesInText(filePath: string, text: string): OutdatedReference[] {\n  const references: OutdatedReference[] = [];\n  for (const [index, line] of text.split(/\\r?\\n/u).entries()) {\n    if (line.includes(OUTDATED_REFERENCE_ALLOW_MARKER)) {\n      continue;\n    }\n    for (const pattern of OUTDATED_REFERENCE_PATTERNS) {\n      if (pattern.regExp.test(line)) {\n        references.push({ filePath, hint: pattern.hint, line: index + 1, text: line.trim() });\n        break;\n      }\n    }\n  }\n  return references;\n}\n\n/**\n * Formats references one per line, as `path:line - text (hint)`.\n *\n * @param references - The references.\n * @returns The formatted text.\n */\nexport function formatOutdatedReferences(references: readonly OutdatedReference[]): string {\n  return references.map((reference) => `${reference.filePath}:${String(reference.line)} - ${reference.text} (${reference.hint})`).join('\\n');\n}\n\nfunction isScannedSource(name: string): boolean {\n  return name.endsWith('.ts') && !name.endsWith('.d.ts') && !name.endsWith('.test.ts') && name !== '__merged.ts';\n}\n\nasync function listFiles(directory: string, isIncluded: (name: string) => boolean, excludedDirectories: readonly string[]): Promise<string[]> {\n  const files: string[] = [];\n  if (!existsSync(directory)) {\n    return files;\n  }\n  for (const entry of await readdir(directory, { withFileTypes: true })) {\n    const entryPath = join(directory, entry.name);\n    if (entry.isDirectory()) {\n      if (!excludedDirectories.includes(entry.name)) {\n        files.push(...await listFiles(entryPath, isIncluded, excludedDirectories));\n      }\n    } else if (isIncluded(entry.name)) {\n      files.push(entryPath);\n    }\n  }\n  return files.sort();\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAiBA,qBAA2B;AAC3B,sBAGO;AACP,uBAGO;AAKA,MAAM,kCAAkC;AAO/C,MAAM,8BAAmE;AAAA,EACvE;AAAA,IACE,MAAM;AAAA,IACN,QAAQ;AAAA,EACV;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,QAAQ;AAAA,EACV;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,QAAQ;AAAA,EACV;AACF;AAkCA,eAAsB,2BAA2B,eAAsC;AACrF,QAAM,aAAa,MAAM,uBAAuB,aAAa;AAC7D,MAAI,WAAW,SAAS,GAAG;AACzB,UAAM,IAAI,MAAM,GAAG,OAAO,WAAW,MAAM,CAAC;AAAA,EAA4B,yBAAyB,UAAU,CAAC,EAAE;AAAA,EAChH;AACF;AAQA,eAAsB,uBAAuB,eAAqD;AAChG,QAAM,iBAAa,uBAAK,eAAe,WAAW;AAClD,QAAM,QAAQ;AAAA,IACZ,OAAG,2BAAW,UAAU,IAAI,CAAC,UAAU,IAAI,CAAC;AAAA,IAC5C,GAAG,MAAM,cAAU,uBAAK,eAAe,QAAQ,OAAO,WAAW,MAAM,GAAG,CAAC,SAAS,WAAW,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC;AAAA,IAClH,GAAG,MAAM,cAAU,uBAAK,eAAe,KAAK,GAAG,iBAAiB,CAAC,CAAC;AAAA,IAClE,GAAG,MAAM,cAAU,uBAAK,eAAe,SAAS,GAAG,iBAAiB,CAAC,CAAC;AAAA,EACxE;AACA,QAAM,aAAkC,CAAC;AACzC,aAAW,QAAQ,OAAO;AACxB,eAAW,KAAK,GAAG,iCAA6B,2BAAS,eAAe,IAAI,EAAE,WAAW,MAAM,GAAG,GAAG,UAAM,0BAAS,MAAM,OAAO,CAAC,CAAC;AAAA,EACrI;AACA,SAAO;AACT;AASO,SAAS,6BAA6B,UAAkB,MAAmC;AAChG,QAAM,aAAkC,CAAC;AACzC,aAAW,CAAC,OAAO,IAAI,KAAK,KAAK,MAAM,QAAQ,EAAE,QAAQ,GAAG;AAC1D,QAAI,KAAK,SAAS,+BAA+B,GAAG;AAClD;AAAA,IACF;AACA,eAAW,WAAW,6BAA6B;AACjD,UAAI,QAAQ,OAAO,KAAK,IAAI,GAAG;AAC7B,mBAAW,KAAK,EAAE,UAAU,MAAM,QAAQ,MAAM,MAAM,QAAQ,GAAG,MAAM,KAAK,KAAK,EAAE,CAAC;AACpF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,SAAO;AACT;AAQO,SAAS,yBAAyB,YAAkD;AACzF,SAAO,WAAW,IAAI,CAAC,cAAc,GAAG,UAAU,QAAQ,IAAI,OAAO,UAAU,IAAI,CAAC,MAAM,UAAU,IAAI,KAAK,UAAU,IAAI,GAAG,EAAE,KAAK,IAAI;AAC3I;AAEA,SAAS,gBAAgB,MAAuB;AAC9C,SAAO,KAAK,SAAS,KAAK,KAAK,CAAC,KAAK,SAAS,OAAO,KAAK,CAAC,KAAK,SAAS,UAAU,KAAK,SAAS;AACnG;AAEA,eAAe,UAAU,WAAmB,YAAuC,qBAA2D;AAC5I,QAAM,QAAkB,CAAC;AACzB,MAAI,KAAC,2BAAW,SAAS,GAAG;AAC1B,WAAO;AAAA,EACT;AACA,aAAW,SAAS,UAAM,yBAAQ,WAAW,EAAE,eAAe,KAAK,CAAC,GAAG;AACrE,UAAM,gBAAY,uBAAK,WAAW,MAAM,IAAI;AAC5C,QAAI,MAAM,YAAY,GAAG;AACvB,UAAI,CAAC,oBAAoB,SAAS,MAAM,IAAI,GAAG;AAC7C,cAAM,KAAK,GAAG,MAAM,UAAU,WAAW,YAAY,mBAAmB,CAAC;AAAA,MAC3E;AAAA,IACF,WAAW,WAAW,MAAM,IAAI,GAAG;AACjC,YAAM,KAAK,SAAS;AAAA,IACtB;AAAA,EACF;AACA,SAAO,MAAM,KAAK;AACpB;",
  "names": []
}


package/dist/lib/cjs/docs-site/outdated-references.d.cts

@@ -0,0 +1,72 @@
+/// <reference path="../library-references.d.cts" />
+/**
+ * @file
+ *
+ * Finds references to the retired `obsidian-dev-utils` package that point a reader at something that no longer
+ * exists: one of its module paths, a link into its repository, or the legacy console recipe for the shared abort
+ * controller.
+ *
+ * The bare name `obsidian-dev-utils` is NOT flagged: `@mnaoumov/obsidian-lib` keeps it on purpose as a wire name (its
+ * debug namespace, CSS class and event prefix), and a migration note may name the package. What is flagged is the
+ * name used as an ADDRESS.
+ *
+ * Scanned, where present: `README.md`, the guides under `docs/src/content/docs` (not the generated API reference,
+ * which is rendered from the TSDoc this also scans), and every non-test `.ts` file under `src/` and `scripts/`.
+ * `CHANGELOG.md` is history and is not scanned. A line that names an old address on purpose, such as a migration
+ * note, carries `outdated-reference-ok` on that line.
+ */
+/**
+ * The marker that allows an outdated reference on its line.
+ */
+export declare const OUTDATED_REFERENCE_ALLOW_MARKER = "outdated-reference-ok";
+/**
+ * An outdated reference found in a file.
+ */
+export interface OutdatedReference {
+    /**
+     * The file's path, relative to the package root.
+     */
+    readonly filePath: string;
+    /**
+     * What to write instead.
+     */
+    readonly hint: string;
+    /**
+     * The 1-based line.
+     */
+    readonly line: number;
+    /**
+     * The line's text, trimmed.
+     */
+    readonly text: string;
+}
+/**
+ * Finds the outdated references in the package and throws when there is one, for a gate test or script.
+ *
+ * @param rootDirectory - The package root.
+ * @returns A promise that resolves when there is none.
+ * @throws {Error} Listing every reference, one per line.
+ */
+export declare function assertNoOutdatedReferences(rootDirectory: string): Promise<void>;
+/**
+ * Finds the outdated references in the package.
+ *
+ * @param rootDirectory - The package root.
+ * @returns The outdated references.
+ */
+export declare function findOutdatedReferences(rootDirectory: string): Promise<OutdatedReference[]>;
+/**
+ * Finds the outdated references in one file's text.
+ *
+ * @param filePath - The file's path, used in the result.
+ * @param text - The file's text.
+ * @returns The outdated references, in line order.
+ */
+export declare function findOutdatedReferencesInText(filePath: string, text: string): OutdatedReference[];
+/**
+ * Formats references one per line, as `path:line - text (hint)`.
+ *
+ * @param references - The references.
+ * @returns The formatted text.
+ */
+export declare function formatOutdatedReferences(references: readonly OutdatedReference[]): string;

package/dist/lib/cjs/formatters/dprint.cjs

@@ -76,11 +76,18 @@ async function format(options) {
     throw new Error("dprint.json not found");
   }
   const command = rewrite ? "fmt" : "check";
-  const targets = paths?.length ? paths : ["**/*"];
-  await (0, import_root.execFromRoot)([...(0, import_package_manager.resolveToolCommand)({ tool: "dprint" }), command, "--config", dprintJsonPath, { batchedArguments: targets }]);
+  const hasPaths = paths !== void 0 && paths.length > 0;
+  await (0, import_root.execFromRoot)([
+    ...(0, import_package_manager.resolveToolCommand)({ tool: "dprint" }),
+    command,
+    "--config",
+    dprintJsonPath,
+    ...hasPaths ? ["--allow-no-files"] : [],
+    { batchedArguments: hasPaths ? paths : ["**/*"] }
+  ]);
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   format
 });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9mb3JtYXR0ZXJzL2RwcmludC50cyJdLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBmaWxlXG4gKlxuICogRm9ybWF0IHRoZSBzb3VyY2UgY29kZS5cbiAqL1xuXG5pbXBvcnQgeyBhc3NlcnROb25OdWxsYWJsZSB9IGZyb20gJ0BtbmFvdW1vdi90eXBlc2NyaXB0LWxpYi90eXBlLWd1YXJkcyc7XG5pbXBvcnQgeyBleGlzdHNTeW5jIH0gZnJvbSAnbm9kZTpmcyc7XG5cbmltcG9ydCB7IHJlc29sdmVUb29sQ29tbWFuZCB9IGZyb20gJy4uL3BhY2thZ2UtbWFuYWdlci50cyc7XG5pbXBvcnQgeyBSZXBvUGF0aHMgfSBmcm9tICcuLi9yZXBvLXBhdGhzLnRzJztcbmltcG9ydCB7XG4gIGV4ZWNGcm9tUm9vdCxcbiAgZ2V0Um9vdEZvbGRlcixcbiAgcmVzb2x2ZVBhdGhGcm9tUm9vdFNhZmVcbn0gZnJvbSAnLi4vcm9vdC50cyc7XG5cbi8qKlxuICogUGFyYW1ldGVycyBmb3IgdGhlIHtAbGluayBmb3JtYXR9IGZ1bmN0aW9uLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIEZvcm1hdE9wdGlvbnMge1xuICAvKipcbiAgICogVGhlIGBkcHJpbnQuanNvbmAgdXNlZCB3aGVuIHRoZSBwcm9qZWN0IGhhcyBub25lIG9mIGl0cyBvd24uIFdpdGhvdXQgaXQsIGEgcHJvamVjdCB3aXRoIG5vIGBkcHJpbnQuanNvbmBcbiAgICogZmFpbHMuXG4gICAqL1xuICByZWFkb25seSBkZWZhdWx0Q29uZmlnRmlsZVBhdGg/OiBzdHJpbmcgfCB1bmRlZmluZWQ7XG5cbiAgLyoqXG4gICAqIE9wdGlvbmFsIGZpbGUgcGF0aHMgdG8gZm9ybWF0LiBJZiBvbWl0dGVkLCBmb3JtYXRzIHRoZSBlbnRpcmUgcHJvamVjdC5cbiAgICovXG4gIHJlYWRvbmx5IHBhdGhzPzogc3RyaW5nW10gfCB1bmRlZmluZWQ7XG5cbiAgLyoqXG4gICAqIFdoZXRoZXIgdG8gcmV3cml0ZSB0aGUgc291cmNlIGNvZGUuXG4gICAqXG4gICAqIEBkZWZhdWx0IGB0cnVlYFxuICAgKi9cbiAgcmVhZG9ubHkgcmV3cml0ZT86IGJvb2xlYW4gfCB1bmRlZmluZWQ7XG59XG5cbi8qKlxuICogRm9ybWF0IHRoZSBzb3VyY2UgY29kZS5cbiAqXG4gKiBAcGFyYW0gb3B0aW9ucyAtIFRoZSB7QGxpbmsgRm9ybWF0T3B0aW9uc30uXG4gKiBAcmV0dXJucyBBIHtAbGluayBQcm9taXNlfSB0aGF0IHJlc29sdmVzIHdoZW4gdGhlIHNvdXJjZSBjb2RlIGhhcyBiZWVuIGZvcm1hdHRlZC5cbiAqL1xuZXhwb3J0IGFzeW5jIGZ1bmN0aW9uIGZvcm1hdChvcHRpb25zPzogRm9ybWF0T3B0aW9ucyk6IFByb21pc2U8dm9pZD4ge1xuICBjb25zdCB7IGRlZmF1bHRDb25maWdGaWxlUGF0aCwgcGF0aHMsIHJld3JpdGUgPSB0cnVlIH0gPSBvcHRpb25zID8/IHt9O1xuICBjb25zdCByb290Rm9sZGVyID0gZ2V0Um9vdEZvbGRlcigpO1xuICBhc3NlcnROb25OdWxsYWJsZShyb290Rm9sZGVyLCAnUm9vdCBmb2xkZXIgbm90IGZvdW5kJyk7XG4gIGxldCBkcHJpbnRKc29uUGF0aCA9IHJlc29sdmVQYXRoRnJvbVJvb3RTYWZlKHsgcGF0aDogUmVwb1BhdGhzLkRwcmludEpzb24gfSk7XG4gIGlmICghZXhpc3RzU3luYyhkcHJpbnRKc29uUGF0aCkgJiYgZGVmYXVsdENvbmZpZ0ZpbGVQYXRoKSB7XG4gICAgZHByaW50SnNvblBhdGggPSBkZWZhdWx0Q29uZmlnRmlsZVBhdGg7XG4gIH1cblxuICBpZiAoIWV4aXN0c1N5bmMoZHByaW50SnNvblBhdGgpKSB7XG4gICAgdGhyb3cgbmV3IEVycm9yKCdkcHJpbnQuanNvbiBub3QgZm91bmQnKTtcbiAgfVxuXG4gIGNvbnN0IGNvbW1hbmQgPSByZXdyaXRlID8gJ2ZtdCcgOiAnY2hlY2snO1xuICAvKiB2OCBpZ25vcmUgc3RhcnQgLS0gVGhlIHBhdGhzLXByb3ZpZGVkIGJyYW5jaCBpcyBvbmx5IGV4ZXJjaXNlZCBieSBjb25zdW1lciBwcm9qZWN0cyBwYXNzaW5nIGZpbGUgbGlzdHMuICovXG4gIGNvbnN0IHRhcmdldHMgPSBwYXRocz8ubGVuZ3RoID8gcGF0aHMgOiBbJyoqLyonXTtcbiAgLyogdjggaWdub3JlIHN0b3AgKi9cbiAgYXdhaXQgZXhlY0Zyb21Sb290KFsuLi5yZXNvbHZlVG9vbENvbW1hbmQoeyB0b29sOiAnZHByaW50JyB9KSwgY29tbWFuZCwgJy0tY29uZmlnJywgZHByaW50SnNvblBhdGgsIHsgYmF0Y2hlZEFyZ3VtZW50czogdGFyZ2V0cyB9XSk7XG59XG4iXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQU1BLHlCQUFrQztBQUNsQyxxQkFBMkI7QUFFM0IsNkJBQW1DO0FBQ25DLHdCQUEwQjtBQUMxQixrQkFJTztBQStCUCxlQUFzQixPQUFPLFNBQXdDO0FBQ25FLFFBQU0sRUFBRSx1QkFBdUIsT0FBTyxVQUFVLEtBQUssSUFBSSxXQUFXLENBQUM7QUFDckUsUUFBTSxpQkFBYSwyQkFBYztBQUNqQyw0Q0FBa0IsWUFBWSx1QkFBdUI7QUFDckQsTUFBSSxxQkFBaUIscUNBQXdCLEVBQUUsTUFBTSw0QkFBVSxXQUFXLENBQUM7QUFDM0UsTUFBSSxLQUFDLDJCQUFXLGNBQWMsS0FBSyx1QkFBdUI7QUFDeEQscUJBQWlCO0FBQUEsRUFDbkI7QUFFQSxNQUFJLEtBQUMsMkJBQVcsY0FBYyxHQUFHO0FBQy9CLFVBQU0sSUFBSSxNQUFNLHVCQUF1QjtBQUFBLEVBQ3pDO0FBRUEsUUFBTSxVQUFVLFVBQVUsUUFBUTtBQUVsQyxRQUFNLFVBQVUsT0FBTyxTQUFTLFFBQVEsQ0FBQyxNQUFNO0FBRS9DLFlBQU0sMEJBQWEsQ0FBQyxPQUFHLDJDQUFtQixFQUFFLE1BQU0sU0FBUyxDQUFDLEdBQUcsU0FBUyxZQUFZLGdCQUFnQixFQUFFLGtCQUFrQixRQUFRLENBQUMsQ0FBQztBQUNwSTsiLCJuYW1lcyI6W119
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9mb3JtYXR0ZXJzL2RwcmludC50cyJdLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBmaWxlXG4gKlxuICogRm9ybWF0IHRoZSBzb3VyY2UgY29kZS5cbiAqL1xuXG5pbXBvcnQgeyBhc3NlcnROb25OdWxsYWJsZSB9IGZyb20gJ0BtbmFvdW1vdi90eXBlc2NyaXB0LWxpYi90eXBlLWd1YXJkcyc7XG5pbXBvcnQgeyBleGlzdHNTeW5jIH0gZnJvbSAnbm9kZTpmcyc7XG5cbmltcG9ydCB7IHJlc29sdmVUb29sQ29tbWFuZCB9IGZyb20gJy4uL3BhY2thZ2UtbWFuYWdlci50cyc7XG5pbXBvcnQgeyBSZXBvUGF0aHMgfSBmcm9tICcuLi9yZXBvLXBhdGhzLnRzJztcbmltcG9ydCB7XG4gIGV4ZWNGcm9tUm9vdCxcbiAgZ2V0Um9vdEZvbGRlcixcbiAgcmVzb2x2ZVBhdGhGcm9tUm9vdFNhZmVcbn0gZnJvbSAnLi4vcm9vdC50cyc7XG5cbi8qKlxuICogUGFyYW1ldGVycyBmb3IgdGhlIHtAbGluayBmb3JtYXR9IGZ1bmN0aW9uLlxuICovXG5leHBvcnQgaW50ZXJmYWNlIEZvcm1hdE9wdGlvbnMge1xuICAvKipcbiAgICogVGhlIGBkcHJpbnQuanNvbmAgdXNlZCB3aGVuIHRoZSBwcm9qZWN0IGhhcyBub25lIG9mIGl0cyBvd24uIFdpdGhvdXQgaXQsIGEgcHJvamVjdCB3aXRoIG5vIGBkcHJpbnQuanNvbmBcbiAgICogZmFpbHMuXG4gICAqL1xuICByZWFkb25seSBkZWZhdWx0Q29uZmlnRmlsZVBhdGg/OiBzdHJpbmcgfCB1bmRlZmluZWQ7XG5cbiAgLyoqXG4gICAqIE9wdGlvbmFsIGZpbGUgcGF0aHMgdG8gZm9ybWF0LiBJZiBvbWl0dGVkLCBmb3JtYXRzIHRoZSBlbnRpcmUgcHJvamVjdC5cbiAgICovXG4gIHJlYWRvbmx5IHBhdGhzPzogc3RyaW5nW10gfCB1bmRlZmluZWQ7XG5cbiAgLyoqXG4gICAqIFdoZXRoZXIgdG8gcmV3cml0ZSB0aGUgc291cmNlIGNvZGUuXG4gICAqXG4gICAqIEBkZWZhdWx0IGB0cnVlYFxuICAgKi9cbiAgcmVhZG9ubHkgcmV3cml0ZT86IGJvb2xlYW4gfCB1bmRlZmluZWQ7XG59XG5cbi8qKlxuICogRm9ybWF0IHRoZSBzb3VyY2UgY29kZS5cbiAqXG4gKiBFeHBsaWNpdCB7QGxpbmsgRm9ybWF0T3B0aW9ucy5wYXRoc30gZ2V0IGAtLWFsbG93LW5vLWZpbGVzYDogYSBsaXN0IGBkcHJpbnQuanNvbmAgZXhjbHVkZXMgZW50aXJlbHkgKGEgcHJlLWNvbW1pdFxuICogaG9vayBzdGFnaW5nIG9ubHkgYSBgZGVtby12YXVsdC9gIGZpbGUpIGlzIG5vdGhpbmcgdG8gZm9ybWF0LCBub3QgYW4gZXJyb3IsIHdoaWxlIGRwcmludCB3b3VsZCBleGl0IGAxNGAgd2l0aFxuICogYE5vIGZpbGVzIGZvdW5kIHRvIGZvcm1hdGAuIFRoZSB3aG9sZS1wcm9qZWN0IHJ1biBrZWVwcyB0aGUgY2hlY2ssIHNpbmNlIGZpbmRpbmcgbm90aGluZyB0aGVyZSBpcyBhIGJyb2tlblxuICogY29uZmlndXJhdGlvbi5cbiAqXG4gKiBAcGFyYW0gb3B0aW9ucyAtIFRoZSB7QGxpbmsgRm9ybWF0T3B0aW9uc30uXG4gKiBAcmV0dXJucyBBIHtAbGluayBQcm9taXNlfSB0aGF0IHJlc29sdmVzIHdoZW4gdGhlIHNvdXJjZSBjb2RlIGhhcyBiZWVuIGZvcm1hdHRlZC5cbiAqL1xuZXhwb3J0IGFzeW5jIGZ1bmN0aW9uIGZvcm1hdChvcHRpb25zPzogRm9ybWF0T3B0aW9ucyk6IFByb21pc2U8dm9pZD4ge1xuICBjb25zdCB7IGRlZmF1bHRDb25maWdGaWxlUGF0aCwgcGF0aHMsIHJld3JpdGUgPSB0cnVlIH0gPSBvcHRpb25zID8/IHt9O1xuICBjb25zdCByb290Rm9sZGVyID0gZ2V0Um9vdEZvbGRlcigpO1xuICBhc3NlcnROb25OdWxsYWJsZShyb290Rm9sZGVyLCAnUm9vdCBmb2xkZXIgbm90IGZvdW5kJyk7XG4gIGxldCBkcHJpbnRKc29uUGF0aCA9IHJlc29sdmVQYXRoRnJvbVJvb3RTYWZlKHsgcGF0aDogUmVwb1BhdGhzLkRwcmludEpzb24gfSk7XG4gIGlmICghZXhpc3RzU3luYyhkcHJpbnRKc29uUGF0aCkgJiYgZGVmYXVsdENvbmZpZ0ZpbGVQYXRoKSB7XG4gICAgZHByaW50SnNvblBhdGggPSBkZWZhdWx0Q29uZmlnRmlsZVBhdGg7XG4gIH1cblxuICBpZiAoIWV4aXN0c1N5bmMoZHByaW50SnNvblBhdGgpKSB7XG4gICAgdGhyb3cgbmV3IEVycm9yKCdkcHJpbnQuanNvbiBub3QgZm91bmQnKTtcbiAgfVxuXG4gIGNvbnN0IGNvbW1hbmQgPSByZXdyaXRlID8gJ2ZtdCcgOiAnY2hlY2snO1xuICBjb25zdCBoYXNQYXRocyA9IHBhdGhzICE9PSB1bmRlZmluZWQgJiYgcGF0aHMubGVuZ3RoID4gMDtcbiAgYXdhaXQgZXhlY0Zyb21Sb290KFtcbiAgICAuLi5yZXNvbHZlVG9vbENvbW1hbmQoeyB0b29sOiAnZHByaW50JyB9KSxcbiAgICBjb21tYW5kLFxuICAgICctLWNvbmZpZycsXG4gICAgZHByaW50SnNvblBhdGgsXG4gICAgLi4uaGFzUGF0aHMgPyBbJy0tYWxsb3ctbm8tZmlsZXMnXSA6IFtdLFxuICAgIHsgYmF0Y2hlZEFyZ3VtZW50czogaGFzUGF0aHMgPyBwYXRocyA6IFsnKiovKiddIH1cbiAgXSk7XG59XG4iXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQU1BLHlCQUFrQztBQUNsQyxxQkFBMkI7QUFFM0IsNkJBQW1DO0FBQ25DLHdCQUEwQjtBQUMxQixrQkFJTztBQW9DUCxlQUFzQixPQUFPLFNBQXdDO0FBQ25FLFFBQU0sRUFBRSx1QkFBdUIsT0FBTyxVQUFVLEtBQUssSUFBSSxXQUFXLENBQUM7QUFDckUsUUFBTSxpQkFBYSwyQkFBYztBQUNqQyw0Q0FBa0IsWUFBWSx1QkFBdUI7QUFDckQsTUFBSSxxQkFBaUIscUNBQXdCLEVBQUUsTUFBTSw0QkFBVSxXQUFXLENBQUM7QUFDM0UsTUFBSSxLQUFDLDJCQUFXLGNBQWMsS0FBSyx1QkFBdUI7QUFDeEQscUJBQWlCO0FBQUEsRUFDbkI7QUFFQSxNQUFJLEtBQUMsMkJBQVcsY0FBYyxHQUFHO0FBQy9CLFVBQU0sSUFBSSxNQUFNLHVCQUF1QjtBQUFBLEVBQ3pDO0FBRUEsUUFBTSxVQUFVLFVBQVUsUUFBUTtBQUNsQyxRQUFNLFdBQVcsVUFBVSxVQUFhLE1BQU0sU0FBUztBQUN2RCxZQUFNLDBCQUFhO0FBQUEsSUFDakIsT0FBRywyQ0FBbUIsRUFBRSxNQUFNLFNBQVMsQ0FBQztBQUFBLElBQ3hDO0FBQUEsSUFDQTtBQUFBLElBQ0E7QUFBQSxJQUNBLEdBQUcsV0FBVyxDQUFDLGtCQUFrQixJQUFJLENBQUM7QUFBQSxJQUN0QyxFQUFFLGtCQUFrQixXQUFXLFFBQVEsQ0FBQyxNQUFNLEVBQUU7QUFBQSxFQUNsRCxDQUFDO0FBQ0g7IiwibmFtZXMiOltdfQ==

package/dist/lib/cjs/formatters/dprint.d.cts

@@ -27,6 +27,11 @@ export interface FormatOptions {
 /**
  * Format the source code.
  *
+ * Explicit {@link FormatOptions.paths} get `--allow-no-files`: a list `dprint.json` excludes entirely (a pre-commit
+ * hook staging only a `demo-vault/` file) is nothing to format, not an error, while dprint would exit `14` with
+ * `No files found to format`. The whole-project run keeps the check, since finding nothing there is a broken
+ * configuration.
+ *
  * @param options - The {@link FormatOptions}.
  * @returns A {@link Promise} that resolves when the source code has been formatted.
  */

package/dist/lib/esm/docs-site/docs-snippets.d.mts

@@ -0,0 +1,136 @@
+/// <reference path="../library-references.d.mts" />
+/**
+ * @file
+ *
+ * Extracts the code snippets of a package's documentation guides and type-checks them against its sources.
+ *
+ * A guide's snippet is code a reader copies, so a renamed member or a stale import path in it is a bug that ships
+ * to the site with every check green. Every fenced `ts`, `typescript`, `js` or `javascript` block in
+ * `docs/src/content/docs` is compiled as its own module, with the project's `tsconfig.json`, so an import of the
+ * package's own name resolves wherever that configuration sends it (its `paths`, or the `compilerOptions` passed
+ * here) and a wrong name fails. A `ts` / `typescript` block is compiled as TypeScript; a `js` / `javascript` block,
+ * often a devtools-console recipe, is compiled as JavaScript with `checkJs`, so a wrong member of a typed object
+ * still fails while an untyped lookup does not. The generated API reference (`docs/src/content/docs/api`) is
+ * skipped: it is rendered from the TSDoc.
+ *
+ * Three things shape what a snippet is compiled with, each but the first written in the guide as an HTML comment,
+ * invisible on the site, on the lines right above the fence:
+ *
+ * - The names every guide may use without declaring them are the package's `prelude`, compiled as a module of its
+ *   own (a `declare global` block, with the imports it needs).
+ * - `<!-- snippet-check: context <TypeScript> -->` prepends declarations to that one snippet, for the names its
+ *   prose has already introduced (`declare const linkEl: HTMLAnchorElement;`). Several such lines add up.
+ * - `<!-- snippet-check: skip <reason> -->` exempts a snippet that is deliberately not compilable, such as
+ *   pseudo-code. The reason is required, so a skip is a decision somebody wrote down, never a silent hole.
+ */
+import type { CompilerOptions } from 'typescript';
+/**
+ * Parameters for {@link assertDocsSnippetsCompile}: the same as {@link findDocsSnippetProblems} takes.
+ */
+export type AssertDocsSnippetsCompileParams = FindDocsSnippetProblemsParams;
+/**
+ * One fenced code block of a guide.
+ */
+export interface DocsSnippet {
+    /**
+     * The code, with any blockquote or indentation prefix of the fence stripped.
+     */
+    readonly code: string;
+    /**
+     * The 1-based line of the guide on which the code starts (the line after the opening fence).
+     */
+    readonly codeStartLine: number;
+    /**
+     * The declarations of the `snippet-check: context` markers above the fence, joined by newlines.
+     */
+    readonly context: string;
+    /**
+     * Whether the snippet is JavaScript rather than TypeScript.
+     */
+    readonly isJavaScript: boolean;
+    /**
+     * The language of the fence.
+     */
+    readonly language: string;
+    /**
+     * The reason given by a `snippet-check: skip` marker, or `null` when the snippet is checked.
+     */
+    readonly skipReason: null | string;
+}
+/**
+ * A problem found in a guide's snippet.
+ */
+export interface DocsSnippetProblem {
+    /**
+     * The guide's path, relative to the package root.
+     */
+    readonly filePath: string;
+    /**
+     * The 1-based line of the guide.
+     */
+    readonly line: number;
+    /**
+     * What is wrong.
+     */
+    readonly message: string;
+}
+/**
+ * Parameters for {@link findDocsSnippetProblems}.
+ */
+export interface FindDocsSnippetProblemsParams {
+    /**
+     * Compiler options laid over the ones `tsconfig.json` gives, for instance `paths` that resolve the package's own
+     * name onto its sources when its `tsconfig.json` has none. A relative path in them is not resolved, so pass
+     * absolute ones.
+     */
+    readonly compilerOptions?: CompilerOptions;
+    /**
+     * The guides directory, relative to {@link FindDocsSnippetProblemsParams.rootDirectory}.
+     *
+     * @default `'docs/src/content/docs'`
+     */
+    readonly docsDirectory?: string;
+    /**
+     * The ambient context every snippet is compiled with: the names a guide may use without declaring them, written as
+     * a module (`declare global { ... }`, with the imports it needs).
+     *
+     * @default `''`, no prelude.
+     */
+    readonly prelude?: string;
+    /**
+     * The package root, holding `tsconfig.json`.
+     */
+    readonly rootDirectory: string;
+}
+/**
+ * Type-checks every snippet of the guides and throws when one fails, for a `docs:check-snippets` script.
+ *
+ * @param params - The {@link AssertDocsSnippetsCompileParams}.
+ * @returns A promise that resolves when every snippet compiles.
+ * @throws {Error} Listing every problem, one per line.
+ */
+export declare function assertDocsSnippetsCompile(params: AssertDocsSnippetsCompileParams): Promise<void>;
+/**
+ * Extracts the fenced code blocks of the checked languages from a markdown document.
+ *
+ * A fence inside a blockquote or a list item is recognized too: its prefix (`> `, indentation) is stripped from
+ * every line of its code.
+ *
+ * @param markdown - The markdown document.
+ * @returns The snippets, in document order.
+ */
+export declare function extractDocsSnippets(markdown: string): DocsSnippet[];
+/**
+ * Type-checks every snippet of the guides.
+ *
+ * @param params - The {@link FindDocsSnippetProblemsParams}.
+ * @returns The problems found, empty when every snippet compiles.
+ */
+export declare function findDocsSnippetProblems(params: FindDocsSnippetProblemsParams): Promise<DocsSnippetProblem[]>;
+/**
+ * Formats problems one per line, as `path:line - message`.
+ *
+ * @param problems - The problems.
+ * @returns The formatted text.
+ */
+export declare function formatDocsSnippetProblems(problems: readonly DocsSnippetProblem[]): string;