@meza/adr-tools 1.0.1

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

@@ -0,0 +1,64 @@
+/* eslint-disable no-sync */
+import { describe, it, expect, afterEach, beforeEach, vi } from 'vitest';
+import * as childProcess from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs/promises';
+import * as os from 'os';
+
+describe('Linking Adrs', () => {
+  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
+  const command = `npx ts-node ${adr}`;
+
+  let adrDirectory: string;
+  let workDir: string;
+
+  beforeEach(async () => {
+    // @ts-ignore
+    process.env.ADR_DATE = '1992-01-12';
+    workDir = await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'));
+    adrDirectory = path.join(workDir, 'doc/adr');
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+    childProcess.execSync(`rm -rf ${workDir}`);
+  });
+
+  it('should link adrs as expected with adr new', async () => {
+    childProcess.execSync(`${command} new First Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new Second Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new -q -l "1:Amends:Amended by" -l "2:Clarifies:Clarified by" Third Record`, { cwd: workDir });
+
+    const first: string = path.join(adrDirectory, '0001-first-record.md');
+    const second: string = path.join(adrDirectory, '0002-second-record.md');
+    const third: string = path.join(adrDirectory, '0003-third-record.md');
+
+    const firstContent = await fs.readFile(first, 'utf8');
+    const secondContent = await fs.readFile(second, 'utf8');
+    const thirdContent = await fs.readFile(third, 'utf8');
+
+    expect(firstContent).toMatchSnapshot();
+    expect(secondContent).toMatchSnapshot();
+    expect(thirdContent).toMatchSnapshot();
+  });
+
+  it('should link adrs as expected with adr link', async () => {
+    childProcess.execSync(`${command} new First Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new Second Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new Third Record`, { cwd: workDir });
+    childProcess.execSync(`${command} link 3 Amends 1 "Amended by"`, { cwd: workDir });
+    childProcess.execSync(`${command} link 3 Clarifies 2 "Clarified by"`, { cwd: workDir });
+
+    const first: string = path.join(adrDirectory, '0001-first-record.md');
+    const second: string = path.join(adrDirectory, '0002-second-record.md');
+    const third: string = path.join(adrDirectory, '0003-third-record.md');
+
+    const firstContent = await fs.readFile(first, 'utf8');
+    const secondContent = await fs.readFile(second, 'utf8');
+    const thirdContent = await fs.readFile(third, 'utf8');
+
+    expect(firstContent).toMatchSnapshot();
+    expect(secondContent).toMatchSnapshot();
+    expect(thirdContent).toMatchSnapshot();
+  });
+});

package/tests/list-adrs.e2e.test.ts

@@ -0,0 +1,48 @@
+/* eslint-disable no-sync */
+import { describe, it, expect, afterEach, beforeEach } from 'vitest';
+import * as childProcess from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs/promises';
+import * as os from 'os';
+
+describe('Listing', () => {
+  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
+  const command = `npx ts-node ${adr}`;
+
+  let adrDirectory: string;
+  let workDir: string;
+
+  beforeEach(async () => {
+    workDir = await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'));
+    adrDirectory = path.join(workDir, 'doc/adr');
+    childProcess.execSync(`${command} init ${adrDirectory}`, { cwd: workDir });
+  });
+
+  afterEach(() => {
+    childProcess.execSync(`rm -rf ${workDir}`);
+  });
+
+  it('should list an empty directory', async () => {
+    const child = childProcess.execSync(`${command} list`, { cwd: workDir });
+    const output = child.toString().trim();
+    expect(output).toEqual('doc/adr/0001-record-architecture-decisions.md');
+  });
+
+  it('should list when there is an additional one', async () => {
+    childProcess.execSync(`${command} new first`, { cwd: workDir });
+    const child = childProcess.execSync(`${command} list`, { cwd: workDir });
+    const output = child.toString().trim();
+    expect(output).toEqual('doc/adr/0001-record-architecture-decisions.md\ndoc/adr/0002-first.md');
+  });
+
+  it('should list when there are more', async () => {
+    childProcess.execSync(`${command} new first`, { cwd: workDir });
+    childProcess.execSync(`${command} new second`, { cwd: workDir });
+    childProcess.execSync(`${command} new third`, { cwd: workDir });
+    const child = childProcess.execSync(`${command} list`, { cwd: workDir });
+    const output = child.toString().trim();
+    expect(output).toEqual('doc/adr/0001-record-architecture-decisions.md\ndoc/adr/0002-first.md\ndoc/adr/0003-second.md\ndoc/adr/0004-third.md');
+  });
+
+});
+

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

@@ -0,0 +1,58 @@
+/* eslint-disable no-sync */
+import { describe, it, expect, afterEach, beforeEach } from 'vitest';
+import * as childProcess from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs';
+import * as os from 'os';
+
+describe('New Adrs', () => {
+  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
+  const command = `npx ts-node ${adr}`;
+
+  let adrDirectory: string;
+  let workDir: string;
+
+  beforeEach(() => {
+    // @ts-ignore
+    process.env.ADR_DATE = '1992-01-12';
+    workDir = fs.mkdtempSync(path.join(os.tmpdir(), 'adr-'));
+    adrDirectory = path.join(workDir, 'doc/adr');
+  });
+
+  afterEach(() => {
+    childProcess.execSync(`rm -rf ${workDir}`);
+  });
+
+  it('should create a new one normally', () => {
+    childProcess.execSync(`${command} init ${adrDirectory}`, { cwd: workDir });
+    childProcess.execSync(`${command} new Example ADR`, { cwd: workDir });
+
+    const expectedNewFile: string = path.join(adrDirectory, '0002-example-adr.md');
+    expect(fs.existsSync(expectedNewFile)).toBeTruthy();
+
+    const fileContents = fs.readFileSync(expectedNewFile, 'utf8');
+    expect(fileContents).toMatchSnapshot();
+  });
+
+  it('should create a new one even if no config exists', () => {
+    childProcess.execSync(`${command} new Example ADR`, { cwd: workDir });
+
+    const expectedNewFile: string = path.join(adrDirectory, '0001-example-adr.md');
+    expect(fs.existsSync(expectedNewFile)).toBeTruthy();
+
+    const fileContents = fs.readFileSync(expectedNewFile, 'utf8');
+    expect(fileContents).toMatchSnapshot();
+  });
+
+  it('should create a table of contents upon creation', () => {
+    childProcess.execSync(`${command} init ${adrDirectory}`, { cwd: workDir });
+    childProcess.execSync(`${command} new Example ADR`, { cwd: workDir });
+
+    const expectedNewFile: string = path.join(adrDirectory, 'decisions.md');
+    expect(fs.existsSync(expectedNewFile)).toBeTruthy();
+
+    const fileContents = fs.readFileSync(expectedNewFile, 'utf8');
+    expect(fileContents).toMatchSnapshot();
+  });
+
+});

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

@@ -0,0 +1,58 @@
+/* eslint-disable no-sync */
+import { describe, it, expect, afterEach, beforeEach, vi } from 'vitest';
+import * as childProcess from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs/promises';
+import * as os from 'os';
+
+describe('Superseding Adrs', () => {
+  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
+  const command = `npx ts-node ${adr}`;
+
+  let adrDirectory: string;
+  let workDir: string;
+
+  beforeEach(async () => {
+    // @ts-ignore
+    process.env.ADR_DATE = '1992-01-12';
+    workDir = await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'));
+    adrDirectory = path.join(workDir, 'doc/adr');
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+    childProcess.execSync(`rm -rf ${workDir}`);
+  });
+
+  it('should be able to supersede previous adrs', async () => {
+    childProcess.execSync(`${command} new First Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new -s 1 Second Record`, { cwd: workDir });
+
+    const first: string = path.join(adrDirectory, '0001-first-record.md');
+    const second: string = path.join(adrDirectory, '0002-second-record.md');
+
+    const firstContent = await fs.readFile(first, 'utf8');
+    const secondContent = await fs.readFile(second, 'utf8');
+
+    expect(firstContent).toMatchSnapshot();
+    expect(secondContent).toMatchSnapshot();
+  });
+
+  it('should be able to supersede multiple records', async () => {
+    childProcess.execSync(`${command} new First Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new Second Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new -s 1 -s 2 Third Record`, { cwd: workDir });
+
+    const first: string = path.join(adrDirectory, '0001-first-record.md');
+    const second: string = path.join(adrDirectory, '0002-second-record.md');
+    const third: string = path.join(adrDirectory, '0003-third-record.md');
+
+    const firstContent = await fs.readFile(first, 'utf8');
+    const secondContent = await fs.readFile(second, 'utf8');
+    const thirdContent = await fs.readFile(third, 'utf8');
+
+    expect(firstContent).toMatchSnapshot();
+    expect(secondContent).toMatchSnapshot();
+    expect(thirdContent).toMatchSnapshot();
+  });
+});

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

@@ -0,0 +1,38 @@
+/* eslint-disable no-sync */
+import { describe, it, expect, afterEach, beforeEach, vi } from 'vitest';
+import * as childProcess from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs/promises';
+import * as os from 'os';
+
+describe('Generating TOC', () => {
+  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
+  const command = `npx ts-node ${adr}`;
+
+  let adrDirectory: string;
+  let workDir: string;
+
+  beforeEach(async () => {
+    // @ts-ignore
+    process.env.ADR_DATE = '1992-01-12';
+    workDir = await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'));
+    adrDirectory = path.join(workDir, 'doc/adr');
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+    childProcess.execSync(`rm -rf ${workDir}`);
+  });
+
+  it('should add a path prefix to the toc when there is one supplied', async () => {
+    childProcess.execSync(`${command} new First Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new Second Record`, { cwd: workDir });
+    childProcess.execSync(`${command} new Third Record`, { cwd: workDir });
+    childProcess.execSync(`${command} generate toc -p foo/doc/adr/`, { cwd: workDir });
+
+    const tocFilePath: string = path.join(adrDirectory, 'decisions.md');
+    const tocContent = await fs.readFile(tocFilePath, 'utf8');
+    expect(tocContent).toMatchSnapshot();
+  });
+
+});

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

@@ -0,0 +1,43 @@
+/* eslint-disable no-sync */
+import { describe, it, expect, afterEach, beforeEach } from 'vitest';
+import * as childProcess from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs/promises';
+import * as os from 'os';
+
+describe('Overriding templates', () => {
+  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
+  const command = `npx ts-node ${adr}`;
+
+  let adrDirectory: string;
+  let workDir: string;
+
+  beforeEach(async () => {
+    // @ts-ignore
+    process.env.ADR_DATE = '1992-01-12';
+    workDir = await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'));
+    adrDirectory = path.join(workDir, 'doc/adr');
+    childProcess.execSync(`${command} init ${adrDirectory}`, { cwd: workDir });
+  });
+
+  afterEach(() => {
+    childProcess.execSync(`rm -rf ${workDir}`);
+  });
+
+  it('should use an override template if one exists', async () => {
+    await fs.mkdir(path.join(adrDirectory, 'templates'), { recursive: true });
+    await fs.writeFile(path.join(adrDirectory, 'templates', 'template.md'), '# This is an override template\nTITLE\nDATE\nNUMBER\nSTATUS');
+
+    childProcess.execSync(`${command} new Example ADR`, { cwd: workDir });
+    childProcess.execSync(`${command} new Another Example ADR`, { cwd: workDir });
+
+    const expectedFile: string = path.join(adrDirectory, '0002-example-adr.md');
+    const expectedFile2: string = path.join(adrDirectory, '0003-another-example-adr.md');
+
+    const fileContents = await fs.readFile(expectedFile, 'utf8');
+    const fileContents2 = await fs.readFile(expectedFile2, 'utf8');
+
+    expect(fileContents).toMatchSnapshot();
+    expect(fileContents2).toMatchSnapshot();
+  });
+});

package/tests/work-form-other-directories.e2e.test.ts

@@ -0,0 +1,44 @@
+/* eslint-disable no-sync */
+import { describe, it, expect, afterEach, beforeEach } from 'vitest';
+import * as childProcess from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs';
+import * as os from 'os';
+
+describe('deep directories', () => {
+
+  const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
+  const command = `npx ts-node ${adr}`;
+
+  let adrDirectory: string;
+  let workDir: string;
+
+  beforeEach(() => {
+    workDir = fs.mkdtempSync(path.join(os.tmpdir(), 'adr-'));
+    adrDirectory = path.join(workDir, 'doc/adr');
+    childProcess.execSync(`${command} init ${adrDirectory}`, { cwd: workDir });
+  });
+
+  afterEach(() => {
+    childProcess.execSync(`rm -rf ${workDir}`);
+  });
+
+  it('can work', () => {
+    const innerPath = path.join(fs.mkdtempSync(path.resolve(workDir) + '/'), 'inner');
+    fs.mkdirSync(innerPath, { recursive: true });
+    childProcess.execSync(`${command} new this should exist`, { cwd: innerPath });
+    const expectedFile: string = path.join(adrDirectory, '0002-this-should-exist.md');
+    expect(fs.existsSync(expectedFile)).toBeTruthy();
+  });
+
+  it('can work when there has been no config initiated', () => {
+    childProcess.execSync(`rm -rf ${adrDirectory} ${workDir}/.adr-dir`);
+
+    const innerPath = path.join(fs.mkdtempSync(path.resolve(workDir) + '/'), 'inner');
+    fs.mkdirSync(innerPath, { recursive: true });
+    childProcess.execSync(`${command} new this should exist`, { cwd: innerPath });
+    const expectedFile: string = path.join(innerPath, 'doc', 'adr', '0001-this-should-exist.md');
+    expect(fs.existsSync(expectedFile)).toBeTruthy();
+  });
+});
+

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "@meza/tsconfig-base",
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "emitDeclarationOnly": false,
+    "skipDefaultLibCheck": true,
+    "skipLibCheck": true,
+    "outDir": "./dist",
+    "declarationDir": "./dist/types",
+    "isolatedModules": true,
+    "sourceRoot": "src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "tests/**/*"],
+  "ts-node": {
+    "compilerOptions": {
+      "module": "commonjs",
+      "noPropertyAccessFromIndexSignature": false
+    }
+  }
+}

package/vitest.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    testTimeout: 10000,
+    watch: false,
+    coverage: {
+      reportsDirectory: './reports/coverage',
+      reporter: ['text', 'json', 'html']
+    }
+  }
+});