@meza/adr-tools 1.0.8 → 1.0.11

package/README.md

@@ -1,14 +1,73 @@
 # ADR-TOOLS
 
-> THIS REPO IS UNDER HEAVY DEVELOPMENT. CODE YOU SEE HERE IS... NOT QUITE READY OR PRETTY (yet).
+> This is a Typescript fork of Nat Pryce's [ADR-TOOLS](https://github.com/npryce/adr-tools).
+>There are a few other forks out there which do some parts of the original tool but none actually do it fully.
+>This does.
+>More documentation to follow very soon!
 
-This is a Typescript fork of Nat Pryce's [ADR-TOOLS](https://github.com/npryce/adr-tools).
+# Using ADRs
 
-There are a few other forks out there which do some parts of the original tool but none actually do it fully.
+If you’re interested in reading more about what ADRs are and why they’re important, [check this article out](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions).
 
-This does.
+## **ADR Location Convention**
 
-More documentation to follow very soon!
+By convention we store the decisions in **<project_root>/docs/decisions**
+
+You can also check where the directory is by inspecting the **.adr-dir** file’s contents.
+
+## **ADR CLI in node land**
+
+Managing the files and templates by hand is laborious and is not expected from anyone. We have a tool capable of handling that.
+
+You can install it by running
+
+```
+npm install --save-dev @meza/adr-tools
+```
+
+This will give you the following shorthands:
+
+### **Creating new records**
+
+```
+adr new A new decision the team has made
+```
+
+This will automatically figure out the numbering sequence, get the correct filename format and use the title inside of an ADR template.
+
+If you have an EDITOR or VISUAL environment variable set, that editor will open the newly created file.
+
+### **Superseding previous decisions**
+
+We work in an agile environment where we aim to fail fast. Some of our decisions will turn out to be invalid within a new context. In those situations we would want to record a new decision to supersede our previous one.
+
+Let’s say we had a decision “[0003-use-jest-for-testing.md](http://0003-use-jest-for-testing.md/)” but we recently learned that vitest is faster. Then we would want to record that but also update 0003 to reflect the fact that it’s no longer valid.
+
+```
+adr new -s 3 Use vitest for testing
+```
+
+The -s flag tells the tool to update record #3 with a link to the newly created decision.
+
+### **Linking decisions**
+
+Sometimes there are situations when a new decision has another type of link to a previous record and not a supersede.
+
+That can be expressed as follows:
+
+```
+adr new -l "3:Amends:Amended by" use jest only for pact testing
+```
+
+This will link the new and old issues together. The old one will get a link looking like “Amended by: Use jest only for pact testing” while the newly created ADR will have a section saying: “Amends: Use Jest For Testing”. Both with the appropriate numbering and navigational links set up.
+
+### **Other things**
+
+There’s more to the tool. You can get help with
+
+```
+adr help
+```
 
 ## Conventions
 

package/biome.json

@@ -0,0 +1,148 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+  "organizeImports": { "enabled": true },
+  "vcs": {
+    "enabled": false,
+    "clientKind": "git",
+    "useIgnoreFile": true,
+    "defaultBranch": "main"
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 120,
+    "lineEnding": "lf",
+    "include": ["**/*.ts", "**/*.json"],
+    "ignore": [".cache/**"],
+    "attributePosition": "auto"
+  },
+  "files": { "include": ["**/*.ts", "**/*.json"], "ignore": ["package*.json"] },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": false,
+      "complexity": {
+        "noBannedTypes": "error",
+        "noExtraBooleanCast": "error",
+        "noMultipleSpacesInRegularExpressionLiterals": "error",
+        "noUselessCatch": "error",
+        "noUselessLoneBlockStatements": "error",
+        "noUselessTernary": "error",
+        "noUselessThisAlias": "error",
+        "noUselessTypeConstraint": "error",
+        "noVoid": "error",
+        "noWith": "error",
+        "useArrowFunction": "error",
+        "useLiteralKeys": "error"
+      },
+      "correctness": {
+        "noConstAssign": "error",
+        "noConstantCondition": "error",
+        "noEmptyCharacterClassInRegex": "error",
+        "noEmptyPattern": "error",
+        "noGlobalObjectCalls": "error",
+        "noInnerDeclarations": "error",
+        "noInvalidConstructorSuper": "error",
+        "noInvalidUseBeforeDeclaration": "error",
+        "noNewSymbol": "error",
+        "noNonoctalDecimalEscape": "error",
+        "noPrecisionLoss": "error",
+        "noSelfAssign": "error",
+        "noSetterReturn": "error",
+        "noSwitchDeclarations": "error",
+        "noUndeclaredVariables": "error",
+        "noUnreachable": "error",
+        "noUnreachableSuper": "error",
+        "noUnsafeFinally": "error",
+        "noUnsafeOptionalChaining": "error",
+        "noUnusedLabels": "error",
+        "noUnusedVariables": "error",
+        "useArrayLiterals": "off",
+        "useIsNan": "error",
+        "useValidForDirection": "error",
+        "useYield": "error"
+      },
+      "security": { "noGlobalEval": "error" },
+      "style": {
+        "noCommaOperator": "error",
+        "noNamespace": "off",
+        "noParameterAssign": "error",
+        "noUselessElse": "error",
+        "noVar": "off",
+        "useAsConstAssertion": "error",
+        "useBlockStatements": "error",
+        "useCollapsedElseIf": "error",
+        "useConst": "error",
+        "useShorthandAssign": "error",
+        "useSingleVarDeclarator": "off"
+      },
+      "suspicious": {
+        "noAssignInExpressions": "error",
+        "noAsyncPromiseExecutor": "error",
+        "noCatchAssign": "error",
+        "noClassAssign": "error",
+        "noCompareNegZero": "error",
+        "noConfusingLabels": "error",
+        "noConsoleLog": "off",
+        "noControlCharactersInRegex": "error",
+        "noDebugger": "error",
+        "noDoubleEquals": "error",
+        "noDuplicateCase": "error",
+        "noDuplicateClassMembers": "error",
+        "noDuplicateObjectKeys": "error",
+        "noDuplicateParameters": "error",
+        "noEmptyBlockStatements": "error",
+        "noExplicitAny": "error",
+        "noExtraNonNullAssertion": "error",
+        "noFallthroughSwitchClause": "error",
+        "noFunctionAssign": "error",
+        "noGlobalAssign": "error",
+        "noImportAssign": "error",
+        "noLabelVar": "error",
+        "noMisleadingCharacterClass": "error",
+        "noMisleadingInstantiator": "error",
+        "noPrototypeBuiltins": "error",
+        "noRedeclare": "error",
+        "noSelfCompare": "error",
+        "noShadowRestrictedNames": "error",
+        "noUnsafeDeclarationMerging": "error",
+        "noUnsafeNegation": "error",
+        "useGetterReturn": "error",
+        "useValidTypeof": "error"
+      }
+    },
+    "ignore": ["**/node_modules", "**/dist", "lib/murmurhash3.ts"]
+  },
+  "json": {
+    "formatter": {
+      "trailingCommas": "none",
+      "enabled": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "enabled": true,
+      "semicolons": "always",
+      "quoteProperties": "asNeeded",
+      "trailingCommas": "none",
+      "bracketSpacing": true,
+      "bracketSameLine": true,
+      "attributePosition": "auto"
+    },
+    "globals": []
+  },
+  "overrides": [
+    {
+      "include": ["**/*.test.ts", "test/**/*.ts"],
+      "linter": {
+        "rules": {
+          "correctness": { "noInvalidUseBeforeDeclaration": "off" },
+          "style": { "noNonNullAssertion": "off" },
+          "suspicious": { "noEmptyBlockStatements": "off", "noExplicitAny": "off" }
+        }
+      }
+    }
+  ]
+}

package/dist/index.js

@@ -0,0 +1,105 @@
+#!/usr/bin/env node
+import * as path from 'path';
+import chalk from 'chalk';
+import { Command } from 'commander';
+import fs from 'fs/promises';
+import { generateToc, init, link, listAdrs, newAdr } from './lib/adr.js';
+import { workingDir } from './lib/config.js';
+import { getLinksFrom, getTitleFrom } from './lib/manipulator.js';
+import { LIB_VERSION } from './version.js';
+const program = new Command();
+const collectLinks = (val, memo) => {
+    memo.push(val);
+    return memo;
+};
+const collectSupersedes = (val, memo) => {
+    memo.push(val);
+    return memo;
+};
+const generateGraph = async (options) => {
+    let text = 'digraph {\n';
+    text += '  node [shape=plaintext];\n';
+    text += '  subgraph {\n';
+    const adrs = await listAdrs();
+    for (let i = 0; i < adrs.length; i++) {
+        const n = i + 1;
+        const adrPath = adrs[i];
+        const contents = await fs.readFile(adrPath, 'utf8');
+        const title = getTitleFrom(contents);
+        text += `    _${n} [label="${title}"; URL="${options?.prefix || ''}${path.basename(adrPath, '.md')}${options?.extension}"];\n`;
+        if (n > 1) {
+            text += `    _${n - 1} -> _${n} [style="dotted", weight=1];\n`;
+        }
+    }
+    text += '  }\n';
+    for (let i = 0; i < adrs.length; i++) {
+        const n = i + 1;
+        const adrPath = adrs[i];
+        const contents = await fs.readFile(adrPath, 'utf8');
+        const linksInADR = getLinksFrom(contents);
+        for (let j = 0; j < linksInADR.length; j++) {
+            if (!linksInADR[j].label.endsWith('by')) {
+                text += `  _${n} -> _${linksInADR[j].targetNumber} [label="${linksInADR[j].label}", weight=0]\n`;
+            }
+        }
+    }
+    text += '}\n';
+    console.log(text);
+};
+program.name('adr').version(LIB_VERSION).description('Manage Architecture Decision Logs');
+program
+    .command('new')
+    .argument('<title...>', 'The title of the decision')
+    .option('-q, --quiet', 'Do not ask for clarification. If multiple files match the search pattern, an error will be thrown.')
+    .option('-s, --supersede <SUPERSEDE>', 'A reference (number or partial filename) of a previous decision that the new decision supercedes.\n' +
+    'A Markdown link to the superceded ADR is inserted into the Status section.\n' +
+    'The status of the superceded ADR is changed to record that it has been superceded by the new ADR.', collectSupersedes, [])
+    .option('-l, --link "<TARGET:LINK:REVERSE-LINK>"', 'Links the new ADR to a previous ADR.\n' +
+    `${chalk.bold('TARGET')} is a reference (number or partial filename) of a previous decision.\n` +
+    `${chalk.bold('LINK')} is the description of the link created in the new ADR.\n` +
+    `${chalk.bold('REVERSE-LINK')} is the description of the link created in the existing ADR that will refer to the new ADR`, collectLinks, [])
+    .action(async (title, options) => {
+    try {
+        await newAdr(title.join(' '), {
+            supersedes: options.supersede,
+            date: process.env.ADR_DATE,
+            suppressPrompts: options.quiet || false,
+            links: options.link
+        });
+    }
+    catch (e) {
+        program.error(chalk.red(e.message), { exitCode: 1 });
+    }
+});
+const generate = program.command('generate');
+generate
+    .command('toc')
+    .option('-p, --prefix <PREFIX>', 'The prefix to use for each file link in the generated TOC.')
+    .action((options) => generateToc(options));
+generate
+    .command('graph')
+    .option('-p, --prefix <PREFIX>', 'Prefix each decision file link with PREFIX.')
+    .option('-e, --extension <EXTENSION>', 'the file extension of the documents to which generated links refer. Defaults to .html', '.html')
+    .action(async (options) => {
+    await generateGraph(options);
+});
+program
+    .command('link')
+    .argument('<SOURCE>', 'Full or Partial reference number to an ADR')
+    .argument('<LINK>', 'The description of the link created in the SOURCE')
+    .argument('<TARGET>', 'Full or Partial reference number to an ADR')
+    .argument('<REVERSE-LINK>', 'The description of the link created in the TARGET')
+    .option('-q, --quiet', 'Do not ask for clarification. If multiple files match the search pattern, an error will be thrown.')
+    .action(link);
+program
+    .command('init')
+    .argument('[directory]', 'Initialize a new ADR directory')
+    .action(async (directory) => {
+    await init(directory);
+});
+program.command('list').action(async () => {
+    const adrs = await listAdrs();
+    console.log(adrs.map((adr) => path.relative(workingDir(), adr)).join('\n'));
+});
+program.parse();
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,IAAc,EAAE,EAAE;IACnD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACf,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,GAAW,EAAE,IAAc,EAAE,EAAE;IACxD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACf,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,KAAK,EAAE,OAA+C,EAAE,EAAE;IAC9E,IAAI,IAAI,GAAG,aAAa,CAAC;IACzB,IAAI,IAAI,6BAA6B,CAAC;IACtC,IAAI,IAAI,gBAAgB,CAAC;IAEzB,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAC;IAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACxB,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACpD,MAAM,KAAK,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,IAAI,QAAQ,CAAC,YAAY,KAAK,WAAW,OAAO,EAAE,MAAM,IAAI,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,OAAO,EAAE,SAAS,OAAO,CAAC;QAC/H,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACV,IAAI,IAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,gCAAgC,CAAC;QACjE,CAAC;IACH,CAAC;IACD,IAAI,IAAI,OAAO,CAAC;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACxB,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxC,IAAI,IAAI,MAAM,CAAC,QAAQ,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,YAAY,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,gBAAgB,CAAC;YACnG,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,IAAI,KAAK,CAAC;IACd,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC,CAAC;AAEF,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,WAAW,CAAC,mCAAmC,CAAC,CAAC;AAE1F,OAAO;KACJ,OAAO,CAAC,KAAK,CAAC;KACd,QAAQ,CAAC,YAAY,EAAE,2BAA2B,CAAC;KACnD,MAAM,CACL,aAAa,EACb,oGAAoG,CACrG;KACA,MAAM,CACL,6BAA6B,EAC7B,qGAAqG;IACnG,8EAA8E;IAC9E,mGAAmG,EACrG,iBAAiB,EACjB,EAAE,CACH;KACA,MAAM,CACL,yCAAyC,EACzC,wCAAwC;IACtC,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,wEAAwE;IAC/F,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,2DAA2D;IAChF,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,4FAA4F,EAC3H,YAAY,EACZ,EAAE,CACH;KACA,MAAM,CAAC,KAAK,EAAE,KAAe,EAAE,OAAO,EAAE,EAAE;IACzC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC5B,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ;YAC1B,eAAe,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK;YACvC,KAAK,EAAE,OAAO,CAAC,IAAI;SACpB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAE,CAAW,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAE7C,QAAQ;KACL,OAAO,CAAC,KAAK,CAAC;KACd,MAAM,CAAC,uBAAuB,EAAE,4DAA4D,CAAC;KAC7F,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAE7C,QAAQ;KACL,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CAAC,uBAAuB,EAAE,6CAA6C,CAAC;KAC9E,MAAM,CACL,6BAA6B,EAC7B,uFAAuF,EACvF,OAAO,CACR;KACA,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,QAAQ,CAAC,UAAU,EAAE,4CAA4C,CAAC;KAClE,QAAQ,CAAC,QAAQ,EAAE,mDAAmD,CAAC;KACvE,QAAQ,CAAC,UAAU,EAAE,4CAA4C,CAAC;KAClE,QAAQ,CAAC,gBAAgB,EAAE,mDAAmD,CAAC;KAC/E,MAAM,CACL,aAAa,EACb,oGAAoG,CACrG;KACA,MAAM,CAAC,IAAI,CAAC,CAAC;AAEhB,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,QAAQ,CAAC,aAAa,EAAE,gCAAgC,CAAC;KACzD,MAAM,CAAC,KAAK,EAAE,SAAkB,EAAE,EAAE;IACnC,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC;AACxB,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE;IACxC,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAC;IAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9E,CAAC,CAAC,CAAC;AAEH,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/lib/adr.js

@@ -0,0 +1,177 @@
+import childProcess from 'node:child_process';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import fs from 'fs/promises';
+import { getDir, workingDir } from './config.js';
+import { findMatchingFilesFor, getLinkDetails } from './links.js';
+import { getTitleFrom, injectLink, supersede } from './manipulator.js';
+import { newNumber } from './numbering.js';
+import { askForClarification } from './prompt.js';
+import { template } from './template.js';
+const __filename = fileURLToPath(import.meta.url);
+// eslint-disable-next-line no-unused-vars
+var LinkType;
+(function (LinkType) {
+    // eslint-disable-next-line no-unused-vars
+    LinkType["LINK"] = "link";
+    // eslint-disable-next-line no-unused-vars
+    LinkType["SUPERSEDE"] = "supersede";
+})(LinkType || (LinkType = {}));
+const actuallyLink = async (task) => {
+    const linkedFile = path.join(await getDir(), task.targetPath);
+    const newAdrContent = await fs.readFile(task.sourcePath, 'utf8');
+    const oldAdrContent = await fs.readFile(linkedFile, 'utf8');
+    const oldTitle = getTitleFrom(oldAdrContent);
+    const newTitle = getTitleFrom(newAdrContent);
+    let dirtyOld = '', dirtyNew = '';
+    switch (task.type) {
+        case LinkType.LINK:
+            dirtyOld = injectLink(oldAdrContent, `${task.reverseLink} [${newTitle}](${path.relative(await getDir(), task.sourcePath)})`);
+            dirtyNew = injectLink(newAdrContent, `${task.link} [${oldTitle}](${task.targetPath})`);
+            break;
+        case LinkType.SUPERSEDE:
+            dirtyOld = supersede(oldAdrContent, `${task.reverseLink} [${newTitle}](${path.relative(await getDir(), task.sourcePath)})`);
+            dirtyNew = injectLink(newAdrContent, `${task.link} [${oldTitle}](${task.targetPath})`);
+            break;
+        default:
+            break;
+    }
+    await fs.writeFile(linkedFile, dirtyOld);
+    await fs.writeFile(task.sourcePath, dirtyNew);
+};
+const processSupersedes = async (sourcePath, supersedes = [], suppressPrompts = false) => {
+    if (supersedes.length === 0) {
+        return;
+    }
+    const supersedeStrings = await Promise.all(supersedes.map((link) => getLinkDetails(link, true)));
+    for (const targetDetails of supersedeStrings) {
+        const task = {
+            type: LinkType.SUPERSEDE,
+            sourcePath: sourcePath,
+            link: targetDetails.link,
+            reverseLink: targetDetails.reverseLink,
+            targetPath: targetDetails.matches[0]
+        };
+        if (targetDetails.matches.length > 1) {
+            if (suppressPrompts) {
+                throw new Error(`Multiple files match the search pattern for "${targetDetails.original}".\n` +
+                    'Please specify which file you want to targetDetails to more or remove the -q or --quiet options from the command line.');
+            }
+            task.targetPath = await askForClarification(targetDetails.original, targetDetails.matches);
+        }
+        await actuallyLink(task);
+    }
+};
+const injectLinksTo = async (sourcePath, links = [], suppressPrompts = false) => {
+    if (links.length === 0) {
+        return;
+    }
+    const linkStrings = await Promise.all(links.map((link) => getLinkDetails(link)));
+    for (const targetDetails of linkStrings) {
+        const task = {
+            type: LinkType.LINK,
+            sourcePath: sourcePath,
+            link: targetDetails.link,
+            reverseLink: targetDetails.reverseLink,
+            targetPath: targetDetails.matches[0]
+        };
+        if (targetDetails.matches.length > 1) {
+            if (suppressPrompts) {
+                throw new Error(`Multiple files match the search pattern for "${targetDetails.original}".\n` +
+                    'Please specify which file you want to targetDetails to more or remove the -q or --quiet options from the command line.');
+            }
+            task.targetPath = await askForClarification(targetDetails.original, targetDetails.matches);
+        }
+        await actuallyLink(task);
+    }
+};
+//Generate a table of contents for the adr directory
+export const generateToc = async (options) => {
+    const adrDir = await getDir();
+    const files = await fs.readdir(adrDir);
+    const toc = files.filter((file) => file.match(/^\d{4}-.*\.md$/));
+    const titles = toc.map(async (file) => {
+        const title = getTitleFrom(await fs.readFile(path.join(adrDir, file), 'utf8'));
+        return `- [${title}](${options?.prefix || ''}${file})`;
+    });
+    const resolvedTitles = await Promise.all(titles);
+    const tocFile = path.resolve(path.join(adrDir, 'decisions.md'));
+    await fs.writeFile(tocFile, `# Table of Contents\n\n${resolvedTitles.join('\n')}`);
+};
+export const newAdr = async (title, config) => {
+    const newNum = await newNumber();
+    const formattedDate = config?.date || new Date().toISOString().split('T')[0] || 'ERROR';
+    const tpl = await template(config?.template);
+    const adr = tpl
+        .replace('DATE', formattedDate)
+        .replace('TITLE', title)
+        .replace('NUMBER', newNum.toString())
+        .replace('STATUS', 'Accepted');
+    const paddedNumber = newNum.toString().padStart(4, '0');
+    const cleansedTitle = title
+        .toLowerCase()
+        .replace(/\W/g, '-')
+        .replace(/^(.*)\W$/, '$1')
+        .replace(/^\W(.*)$/, '$1');
+    const fileName = `${paddedNumber}-${cleansedTitle}.md`;
+    const adrDirectory = await getDir();
+    const adrPath = path.resolve(path.join(adrDirectory, fileName));
+    await fs.writeFile(adrPath, adr);
+    await fs.writeFile(path.resolve(adrDirectory, '.adr-sequence.lock'), newNum.toString());
+    await processSupersedes(adrPath, config?.supersedes, config?.suppressPrompts);
+    await injectLinksTo(adrPath, config?.links, config?.suppressPrompts);
+    await generateToc();
+    if (process.env.VISUAL) {
+        await childProcess.spawn(process.env.VISUAL, [adrPath], {
+            stdio: 'inherit',
+            shell: true
+        });
+        return;
+    }
+    if (process.env.EDITOR) {
+        await childProcess.spawn(process.env.EDITOR, [adrPath], {
+            stdio: 'inherit',
+            shell: true
+        });
+        return;
+    }
+};
+export const init = async (directory) => {
+    const dir = directory || (await getDir());
+    await fs.mkdir(dir, { recursive: true });
+    await fs.writeFile(path.join(workingDir(), '.adr-dir'), path.relative(workingDir(), dir));
+    await newAdr('Record Architecture Decisions', {
+        date: process.env.ADR_DATE,
+        template: path.resolve(path.dirname(__filename), '../templates/init.md')
+    });
+};
+export const link = async (source, link, target, reverseLink, options) => {
+    const getFor = async (pattern) => {
+        const found = await findMatchingFilesFor(pattern);
+        if (found.length === 1) {
+            return found[0];
+        }
+        if (options?.quiet) {
+            throw new Error(`Multiple files match the search pattern for "${pattern}".\n` +
+                'Please specify which file you want to targetDetails to more or remove the -q or --quiet options from the command line.');
+        }
+        return askForClarification(pattern, found);
+    };
+    const sourceFile = await getFor(source);
+    await injectLinksTo(path.resolve(await getDir(), sourceFile), [`${target}:${link}:${reverseLink}`]);
+};
+export const listAdrs = async () => {
+    const dir = await getDir();
+    const files = await fs.readdir(dir);
+    const toc = files
+        .map((f) => {
+        const adrFile = f.match(/^0*(\d+)-.*$/);
+        if (adrFile) {
+            return path.resolve(dir, adrFile[0]);
+        }
+        return '';
+    })
+        .filter((f) => f !== '');
+    return toc;
+};
+//# sourceMappingURL=adr.js.map

package/dist/lib/adr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adr.js","sourceRoot":"src/","sources":["lib/adr.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAUlD,0CAA0C;AAC1C,IAAK,QAKJ;AALD,WAAK,QAAQ;IACX,0CAA0C;IAC1C,yBAAa,CAAA;IACb,0CAA0C;IAC1C,mCAAuB,CAAA;AACzB,CAAC,EALI,QAAQ,KAAR,QAAQ,QAKZ;AAUD,MAAM,YAAY,GAAG,KAAK,EAAE,IAAc,EAAE,EAAE;IAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,MAAM,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACjE,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;IAC7C,IAAI,QAAQ,GAAG,EAAE,EACf,QAAQ,GAAG,EAAE,CAAC;IAChB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ,CAAC,IAAI;YAChB,QAAQ,GAAG,UAAU,CACnB,aAAa,EACb,GAAG,IAAI,CAAC,WAAW,KAAK,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,MAAM,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CACvF,CAAC;YACF,QAAQ,GAAG,UAAU,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,KAAK,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;YACvF,MAAM;QACR,KAAK,QAAQ,CAAC,SAAS;YACrB,QAAQ,GAAG,SAAS,CAClB,aAAa,EACb,GAAG,IAAI,CAAC,WAAW,KAAK,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,MAAM,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CACvF,CAAC;YACF,QAAQ,GAAG,UAAU,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,KAAK,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;YACvF,MAAM;QACR;YACE,MAAM;IACV,CAAC;IAED,MAAM,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,KAAK,EAAE,UAAkB,EAAE,aAAuB,EAAE,EAAE,kBAA2B,KAAK,EAAE,EAAE;IAClH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO;IACT,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjG,KAAK,MAAM,aAAa,IAAI,gBAAgB,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAa;YACrB,IAAI,EAAE,QAAQ,CAAC,SAAS;YACxB,UAAU,EAAE,UAAU;YACtB,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,WAAW,EAAE,aAAa,CAAC,WAAW;YACtC,UAAU,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;SACrC,CAAC;QAEF,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrC,IAAI,eAAe,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CACb,gDAAgD,aAAa,CAAC,QAAQ,MAAM;oBAC1E,wHAAwH,CAC3H,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,MAAM,mBAAmB,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,KAAK,EAAE,UAAkB,EAAE,QAAkB,EAAE,EAAE,kBAA2B,KAAK,EAAE,EAAE;IACzG,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjF,KAAK,MAAM,aAAa,IAAI,WAAW,EAAE,CAAC;QACxC,MAAM,IAAI,GAAa;YACrB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,UAAU,EAAE,UAAU;YACtB,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,WAAW,EAAE,aAAa,CAAC,WAAW;YACtC,UAAU,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;SACrC,CAAC;QAEF,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrC,IAAI,eAAe,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CACb,gDAAgD,aAAa,CAAC,QAAQ,MAAM;oBAC1E,wHAAwH,CAC3H,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,MAAM,mBAAmB,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC,CAAC;AACF,oDAAoD;AACpD,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,OAA6B,EAAE,EAAE;IACjE,MAAM,MAAM,GAAG,MAAM,MAAM,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEjE,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QACpC,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAC/E,OAAO,MAAM,KAAK,KAAK,OAAO,EAAE,MAAM,IAAI,EAAE,GAAG,IAAI,GAAG,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEjD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;IAChE,MAAM,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,0BAA0B,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACrF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EAAE,KAAa,EAAE,MAAmB,EAAE,EAAE;IACjE,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;IACjC,MAAM,aAAa,GAAG,MAAM,EAAE,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC;IACxF,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC7C,MAAM,GAAG,GAAG,GAAG;SACZ,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC;SAC9B,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC;SACvB,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;SACpC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACjC,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACxD,MAAM,aAAa,GAAG,KAAK;SACxB,WAAW,EAAE;SACb,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC;SACzB,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC7B,MAAM,QAAQ,GAAG,GAAG,YAAY,IAAI,aAAa,KAAK,CAAC;IACvD,MAAM,YAAY,GAAG,MAAM,MAAM,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;IAChE,MAAM,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACjC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oBAAoB,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IAExF,MAAM,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;IAC9E,MAAM,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;IACrE,MAAM,WAAW,EAAE,CAAC;IAEpB,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE;YACtD,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE;YACtD,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QACH,OAAO;IACT,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EAAE,SAAkB,EAAE,EAAE;IAC/C,MAAM,GAAG,GAAG,SAAS,IAAI,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC;IAC1C,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1F,MAAM,MAAM,CAAC,+BAA+B,EAAE;QAC5C,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ;QAC1B,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,sBAAsB,CAAC;KACzE,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EACvB,MAAc,EACd,IAAY,EACZ,MAAc,EACd,WAAmB,EACnB,OAA6B,EAC7B,EAAE;IACF,MAAM,MAAM,GAAG,KAAK,EAAE,OAAe,EAAE,EAAE;QACvC,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,OAAO,EAAE,KAAK,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,gDAAgD,OAAO,MAAM;gBAC3D,wHAAwH,CAC3H,CAAC;QACJ,CAAC;QAED,OAAO,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;IAExC,MAAM,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,MAAM,EAAE,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,MAAM,IAAI,IAAI,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC;AACtG,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;IACjC,MAAM,GAAG,GAAG,MAAM,MAAM,EAAE,CAAC;IAC3B,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,GAAG,GAAG,KAAK;SACd,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACxC,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAC3B,OAAO,GAAG,CAAC;AACb,CAAC,CAAC"}

package/dist/lib/config.js

@@ -0,0 +1,33 @@
+import { constants } from 'fs';
+import path from 'path';
+import fs from 'fs/promises';
+export const workingDir = () => process.cwd();
+const findTopLevelDir = async (dir) => {
+    try {
+        await fs.access(path.join(dir, '.adr-dir'), constants.F_OK);
+        return dir;
+    }
+    catch (_e) {
+        if (dir === '/') {
+            throw new Error('No ADR directory config found');
+        }
+        const newDir = path.join(dir, '..');
+        return findTopLevelDir(newDir);
+    }
+};
+const getDirPath = async () => {
+    try {
+        const configDir = await findTopLevelDir(workingDir());
+        const configFile = await fs.readFile(path.join(configDir, '.adr-dir'), 'utf8');
+        return path.relative(workingDir(), path.join(configDir, configFile.trim()));
+    }
+    catch (_e) {
+        return path.resolve(path.join(workingDir(), 'doc/adr'));
+    }
+};
+export const getDir = async () => {
+    const dir = await getDirPath();
+    await fs.mkdir(dir, { recursive: true });
+    return dir;
+};
+//# sourceMappingURL=config.js.map

package/dist/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"src/","sources":["lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC/B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,aAAa,CAAC;AAE7B,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;AAE9C,MAAM,eAAe,GAAG,KAAK,EAAE,GAAW,EAAmB,EAAE;IAC7D,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5D,OAAO,GAAG,CAAC;IACb,CAAC;IAAC,OAAO,EAAE,EAAE,CAAC;QACZ,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,KAAK,IAAqB,EAAE;IAC7C,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,UAAU,EAAE,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;QAC/E,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAAC,OAAO,EAAE,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,IAAqB,EAAE;IAChD,MAAM,GAAG,GAAG,MAAM,UAAU,EAAE,CAAC;IAC/B,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,OAAO,GAAG,CAAC;AACb,CAAC,CAAC"}

package/dist/lib/links.js

@@ -0,0 +1,25 @@
+import fs from 'fs/promises';
+import { getDir } from './config.js';
+export const findMatchingFilesFor = async (pattern) => {
+    const files = await fs.readdir(await getDir());
+    return files.filter((file) => file.includes(pattern));
+};
+export const getLinkDetails = async (linkString, isSupersede = false) => {
+    const parts = linkString.split(':');
+    const pattern = parts[0];
+    let link = 'Supersedes';
+    let reverseLink = 'Superseded by';
+    if (!isSupersede) {
+        link = parts[1];
+        reverseLink = parts[2];
+    }
+    const files = await findMatchingFilesFor(pattern);
+    return {
+        pattern: pattern,
+        original: linkString,
+        link: link,
+        reverseLink: reverseLink,
+        matches: files
+    };
+};
+//# sourceMappingURL=links.js.map

package/dist/lib/links.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"links.js","sourceRoot":"src/","sources":["lib/links.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUrC,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAAE,OAAe,EAAE,EAAE;IAC5D,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC;IAC/C,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,UAAkB,EAAE,cAAuB,KAAK,EAAwB,EAAE;IAC7G,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,IAAI,GAAG,YAAY,CAAC;IACxB,IAAI,WAAW,GAAG,eAAe,CAAC;IAClC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAChB,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAClD,OAAO;QACL,OAAO,EAAE,OAAO;QAChB,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,IAAI;QACV,WAAW,EAAE,WAAW;QACxB,OAAO,EAAE,KAAK;KACf,CAAC;AACJ,CAAC,CAAC"}