@meza/adr-tools 1.0.7 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/package.json +1 -1
  3. package/src/lib/adr.ts +1 -1
  4. package/tests/__snapshots__/new-adr.e2e.test.ts.snap +2 -2
  5. package/tests/__snapshots__/toc-prefixing.e2e.test.ts.snap +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # ADR Tools Changelog
2
2
 
3
+ ## [1.0.8](https://github.com/meza/adr-tools/compare/v1.0.7...v1.0.8) (2022-06-27)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * toc now generates as a list ([ecfe2aa](https://github.com/meza/adr-tools/commit/ecfe2aaf9b4431672860411b0d6fbd7ec0141beb))
9
+
3
10
  ## [1.0.7](https://github.com/meza/adr-tools/compare/v1.0.6...v1.0.7) (2022-06-27)
4
11
 
5
12
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meza/adr-tools",
3
- "version": "1.0.7",
3
+ "version": "1.0.8",
4
4
  "main": "dist/index.js",
5
5
  "bin": {
6
6
  "adr": "dist/index.js"
package/src/lib/adr.ts CHANGED
@@ -144,7 +144,7 @@ export const generateToc = async (options?: {prefix?: string}) => {
144
144
 
145
145
  const titles = toc.map(async (file) => {
146
146
  const title = getTitleFrom(await fs.readFile(path.join(adrDir, file), 'utf8'));
147
- return `[${title}](${options?.prefix || ''}${file})`;
147
+ return `- [${title}](${options?.prefix || ''}${file})`;
148
148
  });
149
149
 
150
150
  const resolvedTitles = await Promise.all(titles);
package/tests/__snapshots__/new-adr.e2e.test.ts.snap CHANGED
@@ -49,6 +49,6 @@ What becomes easier or more difficult to do and any risks introduced by the chan
49
49
  exports[`New Adrs > should create a table of contents upon creation 1`] = `
50
50
  "# Table of Contents
51
51
 
52
- [1. Record architecture decisions](0001-record-architecture-decisions.md)
53
- [2. Example ADR](0002-example-adr.md)"
52
+ - [1. Record architecture decisions](0001-record-architecture-decisions.md)
53
+ - [2. Example ADR](0002-example-adr.md)"
54
54
  `;
package/tests/__snapshots__/toc-prefixing.e2e.test.ts.snap CHANGED
@@ -3,7 +3,7 @@
3
3
  exports[`Generating TOC > should add a path prefix to the toc when there is one supplied 1`] = `
4
4
  "# Table of Contents
5
5
 
6
- [1. First Record](foo/doc/adr/0001-first-record.md)
7
- [2. Second Record](foo/doc/adr/0002-second-record.md)
8
- [3. Third Record](foo/doc/adr/0003-third-record.md)"
6
+ - [1. First Record](foo/doc/adr/0001-first-record.md)
7
+ - [2. Second Record](foo/doc/adr/0002-second-record.md)
8
+ - [3. Third Record](foo/doc/adr/0003-third-record.md)"
9
9
  `;