@meza/adr-tools 1.0.10 → 1.0.12

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

@@ -1,13 +1,14 @@
-/* eslint-disable no-sync */
-import { describe, it, expect, afterEach, beforeEach, vi } from 'vitest';
 import * as childProcess from 'child_process';
+import { realpathSync, rmdirSync } from 'node:fs';
+import * as os from 'os';
 import * as path from 'path';
 import * as fs from 'fs/promises';
-import * as os from 'os';
+/* eslint-disable no-sync */
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
 describe('Superseding Adrs', () => {
   const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
-  const command = `npx ts-node ${adr}`;
+  const command = `npx tsx ${adr}`;
 
   let adrDirectory: string;
   let workDir: string;
@@ -15,18 +16,22 @@ describe('Superseding Adrs', () => {
   beforeEach(async () => {
     // @ts-ignore
     process.env.ADR_DATE = '1992-01-12';
-    workDir = await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'));
+    workDir = path.resolve(realpathSync(await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'))));
     adrDirectory = path.join(workDir, 'doc/adr');
   });
 
   afterEach(() => {
     vi.clearAllMocks();
-    childProcess.execSync(`rm -rf ${workDir}`);
+    rmdirSync(workDir, {
+      recursive: true,
+      maxRetries: 3,
+      retryDelay: 500
+    });
   });
 
   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 });
+    childProcess.execSync(`${command} new First Record`, { timeout: 10000, cwd: workDir });
+    childProcess.execSync(`${command} new -s 1 Second Record`, { timeout: 10000, cwd: workDir });
 
     const first: string = path.join(adrDirectory, '0001-first-record.md');
     const second: string = path.join(adrDirectory, '0002-second-record.md');
@@ -39,9 +44,9 @@ describe('Superseding Adrs', () => {
   });
 
   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 });
+    childProcess.execSync(`${command} new First Record`, { timeout: 10000, cwd: workDir });
+    childProcess.execSync(`${command} new Second Record`, { timeout: 10000, cwd: workDir });
+    childProcess.execSync(`${command} new -s 1 -s 2 Third Record`, { timeout: 10000, cwd: workDir });
 
     const first: string = path.join(adrDirectory, '0001-first-record.md');
     const second: string = path.join(adrDirectory, '0002-second-record.md');

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

@@ -1,13 +1,14 @@
-/* eslint-disable no-sync */
-import { describe, it, expect, afterEach, beforeEach, vi } from 'vitest';
 import * as childProcess from 'child_process';
+import { realpathSync, rmdirSync } from 'node:fs';
+import * as os from 'os';
 import * as path from 'path';
 import * as fs from 'fs/promises';
-import * as os from 'os';
+/* eslint-disable no-sync */
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
 describe('Generating TOC', () => {
   const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
-  const command = `npx ts-node ${adr}`;
+  const command = `npx tsx ${adr}`;
 
   let adrDirectory: string;
   let workDir: string;
@@ -15,24 +16,27 @@ describe('Generating TOC', () => {
   beforeEach(async () => {
     // @ts-ignore
     process.env.ADR_DATE = '1992-01-12';
-    workDir = await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'));
+    workDir = path.resolve(realpathSync(await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'))));
     adrDirectory = path.join(workDir, 'doc/adr');
   });
 
   afterEach(() => {
     vi.clearAllMocks();
-    childProcess.execSync(`rm -rf ${workDir}`);
+    rmdirSync(workDir, {
+      recursive: true,
+      maxRetries: 3,
+      retryDelay: 500
+    });
   });
 
   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 });
+    childProcess.execSync(`${command} new First Record`, { timeout: 10000, cwd: workDir });
+    childProcess.execSync(`${command} new Second Record`, { timeout: 10000, cwd: workDir });
+    childProcess.execSync(`${command} new Third Record`, { timeout: 10000, cwd: workDir });
+    childProcess.execSync(`${command} generate toc -p foo/doc/adr/`, { timeout: 10000, 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

@@ -1,13 +1,14 @@
-/* eslint-disable no-sync */
-import { describe, it, expect, afterEach, beforeEach } from 'vitest';
 import * as childProcess from 'child_process';
+import { realpathSync, rmdirSync } from 'node:fs';
+import * as os from 'os';
 import * as path from 'path';
 import * as fs from 'fs/promises';
-import * as os from 'os';
+/* eslint-disable no-sync */
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
 describe('Overriding templates', () => {
   const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
-  const command = `npx ts-node ${adr}`;
+  const command = `npx tsx ${adr}`;
 
   let adrDirectory: string;
   let workDir: string;
@@ -15,21 +16,28 @@ describe('Overriding templates', () => {
   beforeEach(async () => {
     // @ts-ignore
     process.env.ADR_DATE = '1992-01-12';
-    workDir = await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'));
+    workDir = path.resolve(realpathSync(await fs.mkdtemp(path.join(os.tmpdir(), 'adr-'))));
     adrDirectory = path.join(workDir, 'doc/adr');
-    childProcess.execSync(`${command} init ${adrDirectory}`, { cwd: workDir });
+    childProcess.execSync(`${command} init ${adrDirectory}`, { timeout: 10000, cwd: workDir });
   });
 
   afterEach(() => {
-    childProcess.execSync(`rm -rf ${workDir}`);
+    rmdirSync(workDir, {
+      recursive: true,
+      maxRetries: 3,
+      retryDelay: 500
+    });
   });
 
   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');
+    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 });
+    childProcess.execSync(`${command} new Example ADR`, { timeout: 10000, cwd: workDir });
+    childProcess.execSync(`${command} new Another Example ADR`, { timeout: 10000, cwd: workDir });
 
     const expectedFile: string = path.join(adrDirectory, '0002-example-adr.md');
     const expectedFile2: string = path.join(adrDirectory, '0003-another-example-adr.md');

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

@@ -1,44 +1,46 @@
-/* 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';
+import * as path from 'path';
+/* eslint-disable no-sync */
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
 
 describe('deep directories', () => {
-
   const adr = path.resolve(path.dirname(__filename), '../src/index.ts');
-  const command = `npx ts-node ${adr}`;
+  const command = `npx tsx ${adr}`;
 
   let adrDirectory: string;
   let workDir: string;
 
   beforeEach(() => {
-    workDir = fs.mkdtempSync(path.join(os.tmpdir(), 'adr-'));
+    workDir = path.resolve(fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'adr-'))));
     adrDirectory = path.join(workDir, 'doc/adr');
-    childProcess.execSync(`${command} init ${adrDirectory}`, { cwd: workDir });
+    childProcess.execSync(`${command} init ${adrDirectory}`, { timeout: 10000, cwd: workDir });
   });
 
   afterEach(() => {
-    childProcess.execSync(`rm -rf ${workDir}`);
+    fs.rmdirSync(workDir, {
+      recursive: true,
+      maxRetries: 3,
+      retryDelay: 500
+    });
   });
 
   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 });
+    childProcess.execSync(`${command} new this should exist`, { timeout: 10000, 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`);
+    childProcess.execSync(`rimraf ${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 });
+    childProcess.execSync(`${command} new this should exist`, { timeout: 10000, cwd: innerPath });
     const expectedFile: string = path.join(innerPath, 'doc', 'adr', '0001-this-should-exist.md');
     expect(fs.existsSync(expectedFile)).toBeTruthy();
   });
 });
-

package/tsconfig.json

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

package/vitest.config.e2e.ts

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

package/vitest.config.ts

@@ -2,10 +2,17 @@ import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
   test: {
+    dir: 'src',
     testTimeout: 10000,
     watch: false,
+    poolOptions: {
+      forks: {
+        singleFork: true,
+        isolate: true
+      }
+    },
     coverage: {
-      reportsDirectory: './reports/coverage',
+      reportsDirectory: './reports/coverage/unit',
       reporter: ['text', 'json', 'html']
     }
   }

package/.eslintignore

@@ -1,2 +0,0 @@
-node_modules
-dist

package/.eslintrc.json

@@ -1,23 +0,0 @@
-{
-  "extends": [
-    "tailored-tunes",
-    "plugin:json/recommended",
-    "plugin:security/recommended"
-  ],
-  "root": true,
-  "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "json",
-    "@typescript-eslint"
-  ],
-  "rules": {
-    "no-console": "off",
-    "security/detect-object-injection": 0,
-    "security/detect-non-literal-fs-filename": 0
-  },
-  "env": {
-    "commonjs": false,
-    "es6": true,
-    "node": true
-  }
-}

package/.github/dependabot.yml

@@ -1,14 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    versioning-strategy: increase-if-necessary
-    commit-message:
-      prefix: "chore: "
-    schedule:
-      interval: "daily"

package/.github/workflows/auto-merge.yml

@@ -1,14 +0,0 @@
-name: auto-merge dependabot
-
-on:
-  pull_request:
-
-jobs:
-  auto-merge:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ahmadnassri/action-dependabot-auto-merge@v2
-        with:
-          target: minor # includes patch updates!
-          github-token: ${{ secrets.GITHUB_TOKEN }}

package/doc/adr/0001-record-architecture-decisions.md

@@ -1,21 +0,0 @@
-# 1. Record architecture decisions
-
-Date: 2022-06-22
-
-## 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](http://thinkrelevance.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/doc/adr/0002-using-heavy-e2e-tests.md

@@ -1,20 +0,0 @@
-# 2. Using Heavy E2E Tests
-
-Date: 2022-06-22
-
-## Status
-
-Accepted
-
-## Context
-
-The original tool has an [exhaustive test suite](https://github.com/npryce/adr-tools/tree/master/tests) that allows us to make sure that we're backwards compatible.
-
-## Decision
-
-We'll be re-implementing those tests for ourselves too. This means that we will be using the original examples,
-expectations and the ethos of invoking the tool with the given examples.
-
-## Consequences
-
-The E2E test suite will be very slow to run and it can only be executed sequentially.