@meza/adr-tools 2.0.3 → 2.0.4

package/tests/__snapshots__/init-adr-repository.e2e.test.ts.snap

@@ -1,51 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Init an ADR Repository > should use an alternate directory 1`] = `
-"# 1. Record architecture decisions
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-## Context
-
-We need to record the architectural decisions made on this project.
-
-## Decision
-
-We will use Architecture Decision Records, as [described by Michael Nygard](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions).
-
-## Consequences
-
-See Michael Nygard's article, linked above.
-For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
-> For a node version of the same tooling, see Meza's [adr-tools](https://github.com/meza/adr-tools).
-"
-`;
-
-exports[`Init an ADR Repository > should use the default directory 1`] = `
-"# 1. Record architecture decisions
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-## Context
-
-We need to record the architectural decisions made on this project.
-
-## Decision
-
-We will use Architecture Decision Records, as [described by Michael Nygard](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions).
-
-## Consequences
-
-See Michael Nygard's article, linked above.
-For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
-> For a node version of the same tooling, see Meza's [adr-tools](https://github.com/meza/adr-tools).
-"
-`;

package/tests/__snapshots__/linking-records.e2e.test.ts.snap

@@ -1,155 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Linking Adrs > should link adrs as expected with adr link 1`] = `
-"# 1. First Record
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-Amended by [3. Third Record](0003-third-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Linking Adrs > should link adrs as expected with adr link 2`] = `
-"# 2. Second Record
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-Clarified by [3. Third Record](0003-third-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Linking Adrs > should link adrs as expected with adr link 3`] = `
-"# 3. Third Record
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-Amends [1. First Record](0001-first-record.md)
-
-Clarifies [2. Second Record](0002-second-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Linking Adrs > should link adrs as expected with adr new 1`] = `
-"# 1. First Record
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-Amended by [3. Third Record](0003-third-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Linking Adrs > should link adrs as expected with adr new 2`] = `
-"# 2. Second Record
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-Clarified by [3. Third Record](0003-third-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Linking Adrs > should link adrs as expected with adr new 3`] = `
-"# 3. Third Record
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-Amends [1. First Record](0001-first-record.md)
-
-Clarifies [2. Second Record](0002-second-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;

package/tests/__snapshots__/new-adr.e2e.test.ts.snap

@@ -1,54 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`New Adrs > should create a new one even if no config exists 1`] = `
-"# 1. Example ADR
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`New Adrs > should create a new one normally 1`] = `
-"# 2. Example ADR
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`New Adrs > should create a table of contents upon creation 1`] = `
-"# Table of Contents
-
-- [1. Record architecture decisions](0001-record-architecture-decisions.md)
-- [2. Example ADR](0002-example-adr.md)"
-`;

package/tests/__snapshots__/superseding-records.e2e.test.ts.snap

@@ -1,122 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Superseding Adrs > should be able to supersede multiple records 1`] = `
-"# 1. First Record
-
-Date: 1992-01-12
-
-## Status
-
-Superseded by [3. Third Record](0003-third-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Superseding Adrs > should be able to supersede multiple records 2`] = `
-"# 2. Second Record
-
-Date: 1992-01-12
-
-## Status
-
-Superseded by [3. Third Record](0003-third-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Superseding Adrs > should be able to supersede multiple records 3`] = `
-"# 3. Third Record
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-Supersedes [1. First Record](0001-first-record.md)
-
-Supersedes [2. Second Record](0002-second-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Superseding Adrs > should be able to supersede previous adrs 1`] = `
-"# 1. First Record
-
-Date: 1992-01-12
-
-## Status
-
-Superseded by [2. Second Record](0002-second-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;
-
-exports[`Superseding Adrs > should be able to supersede previous adrs 2`] = `
-"# 2. Second Record
-
-Date: 1992-01-12
-
-## Status
-
-Accepted
-
-Supersedes [1. First Record](0001-first-record.md)
-
-## Context
-
-The issue motivating this decision, and any context that influences or constrains the decision.
-
-## Decision
-
-The change that we're proposing or have agreed to implement.
-
-## Consequences
-
-What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
-"
-`;

package/tests/__snapshots__/toc-prefixing.e2e.test.ts.snap

@@ -1,9 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Generating TOC > should add a path prefix to the toc when there is one supplied 1`] = `
-"# Table of Contents
-
-- [1. First Record](foo/doc/adr/0001-first-record.md)
-- [2. Second Record](foo/doc/adr/0002-second-record.md)
-- [3. Third Record](foo/doc/adr/0003-third-record.md)"
-`;

package/tests/__snapshots__/use-template-override.e2e.test.ts.snap

@@ -1,17 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`Overriding templates > should use an override template if one exists 1`] = `
-"# This is an override template
-Example ADR
-1992-01-12
-2
-Accepted"
-`;
-
-exports[`Overriding templates > should use an override template if one exists 2`] = `
-"# This is an override template
-Another Example ADR
-1992-01-12
-3
-Accepted"
-`;

package/tests/edit-on-create.e2e.test.ts

@@ -1,90 +0,0 @@
-import * as fs from 'node:fs';
-import * as os from 'os';
-import * as path from 'path';
-/* eslint-disable no-sync */
-import { afterEach, beforeEach, describe, expect, it } from 'vitest';
-import { createAdrCli } from './helpers/adr-cli';
-
-const waitForFile = async (filePath: string, timeoutMs: number) => {
-  const startedAt = Date.now();
-  while (Date.now() - startedAt < timeoutMs) {
-    if (fs.existsSync(filePath)) {
-      return;
-    }
-    await new Promise((r) => setTimeout(r, 25));
-  }
-  throw new Error(`Timed out waiting for file: ${filePath}`);
-};
-
-describe('Edit new Adrs on creation', () => {
-  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
-  const cli = createAdrCli(adr);
-  const visualHelper =
-    process.platform === 'win32'
-      ? path.resolve(path.dirname(__filename), './fake-visual.cmd')
-      : path.resolve(path.dirname(__filename), './fake-visual');
-  const editorHelper =
-    process.platform === 'win32'
-      ? path.resolve(path.dirname(__filename), './fake-editor.cmd')
-      : path.resolve(path.dirname(__filename), './fake-editor');
-
-  let adrDirectory: string;
-  let workDir: string;
-
-  beforeEach(() => {
-    // @ts-ignore
-    process.env.ADR_DATE = '1992-01-12';
-    workDir = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'adr-')));
-    adrDirectory = path.resolve(path.join(workDir, 'doc/adr'));
-  });
-
-  afterEach(() => {
-    fs.rmSync(workDir, {
-      recursive: true,
-      force: true,
-      maxRetries: 3,
-      retryDelay: 500
-    });
-  });
-
-  it('should open a new ADR in the VISUAL', async () => {
-    cli.run(['new', '--open', 'Example', 'ADR'], {
-      cwd: workDir,
-      env: { VISUAL: visualHelper }
-    });
-
-    const expectedNewFile: string = path.join(workDir, 'visual.out');
-    await waitForFile(expectedNewFile, 2000);
-    const fileContents = fs.readFileSync(expectedNewFile, 'utf8');
-    const reported = fileContents.trim().replace(/^VISUAL\s+/, '');
-    expect(path.normalize(reported)).toEqual(path.normalize(`${adrDirectory}/0001-example-adr.md`));
-  });
-
-  it('should open a new ADR in the EDITOR', async () => {
-    cli.run(['new', '--open', 'Example', 'ADR'], {
-      cwd: workDir,
-      env: { EDITOR: editorHelper }
-    });
-
-    const expectedNewFile: string = path.join(workDir, 'editor.out');
-    await waitForFile(expectedNewFile, 2000);
-    const fileContents = fs.readFileSync(expectedNewFile, 'utf8');
-    const reported = fileContents.trim().replace(/^EDITOR\s+/, '');
-    expect(path.normalize(reported)).toEqual(path.normalize(`${adrDirectory}/0001-example-adr.md`));
-  });
-
-  it('should open a new ADR in the VISUAL if both VISUAL and EDITOR is supplied', async () => {
-    cli.run(['new', '--open', 'Example', 'ADR'], {
-      cwd: workDir,
-      env: { EDITOR: editorHelper, VISUAL: visualHelper }
-    });
-
-    expect(fs.existsSync(path.join(workDir, 'editor.out'))).toBeFalsy();
-
-    const expectedNewFile: string = path.join(workDir, 'visual.out');
-    await waitForFile(expectedNewFile, 2000);
-    const fileContents = fs.readFileSync(expectedNewFile, 'utf8');
-    const reported = fileContents.trim().replace(/^VISUAL\s+/, '');
-    expect(path.normalize(reported)).toEqual(path.normalize(`${adrDirectory}/0001-example-adr.md`));
-  });
-});

package/tests/fake-editor

@@ -1,5 +0,0 @@
-#!/bin/bash
-
-output="$PWD/editor.out"
-cd "${TMPDIR:-/tmp}"
-echo EDITOR "$@" > "$output"

package/tests/fake-editor.cmd

@@ -1,4 +0,0 @@
-@echo off
-set "OUTPUT=%CD%\editor.out"
-cd /d "%TEMP%"
-echo EDITOR %~1 > "%OUTPUT%"

package/tests/fake-visual

@@ -1,5 +0,0 @@
-#!/bin/bash
-
-output="$PWD/visual.out"
-cd "${TMPDIR:-/tmp}"
-echo VISUAL "$@" > "$output"

package/tests/fake-visual.cmd

@@ -1,4 +0,0 @@
-@echo off
-set "OUTPUT=%CD%\visual.out"
-cd /d "%TEMP%"
-echo VISUAL %~1 > "%OUTPUT%"

package/tests/funny-characters.e2e.test.ts

@@ -1,51 +0,0 @@
-import * as fs from 'node:fs';
-import { fileURLToPath } from 'node:url';
-import os from 'os';
-import * as path from 'path';
-
-/* eslint-disable no-sync */
-import { afterEach, beforeEach, describe, expect, it } from 'vitest';
-import { createAdrCli } from './helpers/adr-cli';
-
-const __filename = fileURLToPath(import.meta.url);
-
-describe('Funny Characters', () => {
-  const adr: string = path.resolve(path.dirname(__filename), '../src/index.ts');
-  const cli = createAdrCli(adr);
-
-  let adrDirectory: string;
-  let workDir: string;
-
-  afterEach(() => {
-    fs.rmSync(workDir, {
-      recursive: true,
-      force: true,
-      maxRetries: 3,
-      retryDelay: 500
-    });
-  });
-
-  beforeEach(() => {
-    workDir = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'adr-')));
-    adrDirectory = path.resolve(path.join(workDir, 'doc/adr'));
-    cli.run(['init', adrDirectory], { cwd: workDir });
-  });
-
-  it('should handle titles with periods in them', async () => {
-    cli.run(['new', 'Something', 'About', 'Node.JS'], { cwd: workDir });
-    const expectedFile: string = path.join(adrDirectory, '0002-something-about-node-js.md');
-    expect(fs.existsSync(expectedFile)).toBeTruthy();
-  });
-
-  it('should handle titles with slashes in them', async () => {
-    cli.run(['new', 'Slash/Slash/Slash/'], { cwd: workDir });
-    const expectedFile: string = path.join(adrDirectory, '0002-slash-slash-slash.md');
-    expect(fs.existsSync(expectedFile)).toBeTruthy();
-  });
-
-  it('should handle titles with other weirdness in them', async () => {
-    cli.run(['new', '--', '-Bar-'], { cwd: workDir });
-    const expectedFile: string = path.join(adrDirectory, '0002-bar.md');
-    expect(fs.existsSync(expectedFile)).toBeTruthy();
-  });
-});

package/tests/generate-graph.e2e.test.ts

@@ -1,49 +0,0 @@
-import { realpathSync, rmSync } from 'node:fs';
-import * as fs from 'fs/promises';
-import * as os from 'os';
-import * as path from 'path';
-/* eslint-disable no-sync */
-import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
-import { createAdrCli } from './helpers/adr-cli';
-
-describe('Generating Graphs', () => {
-  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
-  const cli = createAdrCli(adr);
-  let workDir: string;
-
-  beforeAll(async () => {
-    // @ts-ignore
-    process.env.ADR_DATE = '1992-01-12';
-    workDir = path.resolve(realpathSync(await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'))));
-    cli.run(['init'], { cwd: workDir });
-    cli.run(['new', 'An', 'idea', 'that', 'seems', 'good', 'at', 'the', 'time'], { cwd: workDir });
-    cli.run(['new', '-s', '2', 'A', 'better', 'idea'], { cwd: workDir });
-    cli.run(['new', 'This', 'will', 'work'], { cwd: workDir });
-    cli.run(['new', '-s', '3', 'The', 'end'], { cwd: workDir });
-  });
-
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
-  afterAll(() => {
-    rmSync(workDir, {
-      recursive: true,
-      force: true,
-      maxRetries: 3,
-      retryDelay: 500
-    });
-  });
-
-  it('should generate a graph', async () => {
-    const childContent = cli.run(['generate', 'graph'], { cwd: workDir });
-
-    expect(childContent).toMatchSnapshot();
-  });
-
-  it('should generate a graph with specified route and extension ', async () => {
-    const childContent = cli.run(['generate', 'graph', '-p', 'http://example.com/', '-e', '.xxx'], { cwd: workDir });
-
-    expect(childContent).toMatchSnapshot();
-  });
-});

package/tests/helpers/adr-cli.ts

@@ -1,24 +0,0 @@
-import childProcess, { type SpawnSyncOptionsWithStringEncoding } from 'node:child_process';
-import path from 'node:path';
-
-export interface AdrCli {
-  run(args: string[], options?: { cwd?: string; env?: Record<string, string | undefined>; timeoutMs?: number }): string;
-}
-
-export const createAdrCli = (entrypoint: string): AdrCli => {
-  const absoluteEntrypoint = path.resolve(entrypoint);
-  const tsxCli = path.resolve(process.cwd(), 'node_modules', 'tsx', 'dist', 'cli.mjs');
-
-  const run: AdrCli['run'] = (args, options) => {
-    const result = childProcess.execFileSync(process.execPath, [tsxCli, absoluteEntrypoint, ...args], {
-      cwd: options?.cwd,
-      env: { ...process.env, ...options?.env },
-      timeout: options?.timeoutMs ?? 20000,
-      encoding: 'utf8'
-    } satisfies SpawnSyncOptionsWithStringEncoding);
-
-    return result.trimEnd();
-  };
-
-  return { run };
-};