@meza/adr-tools 1.0.4 → 1.0.10
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.
- package/.github/workflows/ci.yml +2 -2
- package/.releaserc.json +11 -0
- package/CHANGELOG.md +41 -3
- package/dist/lib/adr.js +1 -1
- package/dist/lib/adr.js.map +1 -1
- package/dist/templates/init.md +21 -0
- package/dist/templates/template.md +19 -0
- package/dist/types/version.d.ts +1 -1
- package/dist/types/version.d.ts.map +1 -1
- package/dist/version.js +1 -1
- package/dist/version.js.map +1 -1
- package/package.json +13 -13
- package/src/lib/adr.ts +1 -1
- package/src/version.ts +1 -1
- package/tests/__snapshots__/new-adr.e2e.test.ts.snap +2 -2
- package/tests/__snapshots__/toc-prefixing.e2e.test.ts.snap +3 -3
package/.github/workflows/ci.yml
CHANGED
|
@@ -21,7 +21,7 @@ jobs:
|
|
|
21
21
|
path: |
|
|
22
22
|
~/.cache
|
|
23
23
|
~/node_modules
|
|
24
|
-
key: ${{ runner.os }}-${{ hashFiles('**/
|
|
24
|
+
key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
|
|
25
25
|
|
|
26
26
|
- name: Get yarn cache directory path
|
|
27
27
|
id: yarn-cache-dir-path
|
|
@@ -61,7 +61,7 @@ jobs:
|
|
|
61
61
|
path: |
|
|
62
62
|
~/.cache
|
|
63
63
|
~/node_modules
|
|
64
|
-
key: ${{ runner.os }}-${{ hashFiles('**/
|
|
64
|
+
key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
|
|
65
65
|
|
|
66
66
|
- name: Get yarn cache directory path
|
|
67
67
|
id: yarn-cache-dir-path
|
package/.releaserc.json
CHANGED
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
[
|
|
19
19
|
"@semantic-release/changelog",
|
|
20
20
|
{
|
|
21
|
+
"changelogTitle": "# ADR Tools Changelog",
|
|
21
22
|
"changelogFile": "CHANGELOG.md"
|
|
22
23
|
}
|
|
23
24
|
],
|
|
@@ -35,6 +36,16 @@
|
|
|
35
36
|
}
|
|
36
37
|
]
|
|
37
38
|
}
|
|
39
|
+
],
|
|
40
|
+
[
|
|
41
|
+
"@semantic-release/git",
|
|
42
|
+
{
|
|
43
|
+
"message": "chore(release): ${nextRelease.version} as ${branch.channel} [skip ci]\n\n${nextRelease.notes}",
|
|
44
|
+
"assets": [
|
|
45
|
+
"package.json",
|
|
46
|
+
"CHANGELOG.md"
|
|
47
|
+
]
|
|
48
|
+
}
|
|
38
49
|
]
|
|
39
50
|
]
|
|
40
51
|
}
|
package/CHANGELOG.md
CHANGED
|
@@ -1,7 +1,45 @@
|
|
|
1
|
-
|
|
1
|
+
# ADR Tools Changelog
|
|
2
|
+
|
|
3
|
+
## [1.0.10](https://github.com/meza/adr-tools/compare/v1.0.9...v1.0.10) (2022-06-27)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* added missing dependencies ([b07d0a6](https://github.com/meza/adr-tools/commit/b07d0a60bb563e81e74530d90aa421cbf985edf8))
|
|
9
|
+
* **ci:** fixed the cach key ([6149a19](https://github.com/meza/adr-tools/commit/6149a19aa0708170bb249466686e219b0dc0fe91))
|
|
10
|
+
|
|
11
|
+
## [1.0.9](https://github.com/meza/adr-tools/compare/v1.0.8...v1.0.9) (2022-06-27)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Bug Fixes
|
|
15
|
+
|
|
16
|
+
* missing template ([4025740](https://github.com/meza/adr-tools/commit/40257404926e17a6c43f10d51c9809ce68e1400a))
|
|
17
|
+
|
|
18
|
+
## [1.0.8](https://github.com/meza/adr-tools/compare/v1.0.7...v1.0.8) (2022-06-27)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Bug Fixes
|
|
22
|
+
|
|
23
|
+
* toc now generates as a list ([ecfe2aa](https://github.com/meza/adr-tools/commit/ecfe2aaf9b4431672860411b0d6fbd7ec0141beb))
|
|
24
|
+
|
|
25
|
+
## [1.0.7](https://github.com/meza/adr-tools/compare/v1.0.6...v1.0.7) (2022-06-27)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
### Bug Fixes
|
|
29
|
+
|
|
30
|
+
* fixed the regression of the restricted releases ([303c19f](https://github.com/meza/adr-tools/commit/303c19fd40a31dd586feb01fd0c8209c92423898))
|
|
31
|
+
|
|
32
|
+
## [1.0.6](https://github.com/meza/adr-tools/compare/v1.0.5...v1.0.6) (2022-06-27)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Bug Fixes
|
|
36
|
+
|
|
37
|
+
* fixed the changelog title ([0f3f4d2](https://github.com/meza/adr-tools/commit/0f3f4d2b75ef6b93ce6e55c9527318e11867e28b))
|
|
38
|
+
|
|
39
|
+
## [1.0.5](https://github.com/meza/adr-tools/compare/v1.0.4...v1.0.5) (2022-06-27)
|
|
2
40
|
|
|
3
41
|
|
|
4
42
|
### Bug Fixes
|
|
5
43
|
|
|
6
|
-
*
|
|
7
|
-
*
|
|
44
|
+
* no git push on release ([51d520e](https://github.com/meza/adr-tools/commit/51d520ee07f3c638ac59dae35c74e47b397db6b7))
|
|
45
|
+
* removed unused dependencies ([7a5af74](https://github.com/meza/adr-tools/commit/7a5af74a9f592212f5272644bde713dc9bfa40b1))
|
package/dist/lib/adr.js
CHANGED
|
@@ -121,7 +121,7 @@ const generateToc = (options) => __awaiter(void 0, void 0, void 0, function* ()
|
|
|
121
121
|
const toc = files.filter((file) => file.match(/^\d{4}-.*\.md$/));
|
|
122
122
|
const titles = toc.map((file) => __awaiter(void 0, void 0, void 0, function* () {
|
|
123
123
|
const title = (0, manipulator_1.getTitleFrom)(yield promises_1.default.readFile(path_1.default.join(adrDir, file), 'utf8'));
|
|
124
|
-
return
|
|
124
|
+
return `- [${title}](${(options === null || options === void 0 ? void 0 : options.prefix) || ''}${file})`;
|
|
125
125
|
}));
|
|
126
126
|
const resolvedTitles = yield Promise.all(titles);
|
|
127
127
|
const tocFile = path_1.default.resolve(path_1.default.join(adrDir, 'decisions.md'));
|
package/dist/lib/adr.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adr.js","sourceRoot":"src/","sources":["lib/adr.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,yCAAsC;AACtC,2DAA6B;AAC7B,gDAAwB;AACxB,qCAA8C;AAC9C,uCAAkC;AAClC,kDAA0B;AAC1B,+CAAoE;AACpE,mCAA+D;AAC/D,4EAA8C;AAU9C,MAAM,mBAAmB,GAAG,CAAO,YAAoB,EAAE,OAAiB,EAAE,EAAE;IAC5E,MAAM,SAAS,GAAG,MAAM,IAAA,iBAAM,EAAC;QAC7B;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,yCAAyC,eAAK,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG;YAC7E,OAAO,EAAE,OAAO;SACjB;KACF,CAAC,CAAC;IACH,OAAO,SAAS,CAAC,MAAM,CAAC;AAC1B,CAAC,CAAA,CAAC;AAEF,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,CAAO,IAAc,EAAE,EAAE;IAC5C,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,IAAA,eAAM,GAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACjE,MAAM,aAAa,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAG,IAAA,0BAAY,EAAC,aAAa,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,IAAA,0BAAY,EAAC,aAAa,CAAC,CAAC;IAC7C,IAAI,QAAQ,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE,CAAC;IACjC,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,QAAQ,CAAC,IAAI;YAChB,QAAQ,GAAG,IAAA,wBAAU,EAAC,aAAa,EAAE,GAAG,IAAI,CAAC,WAAW,KAAK,QAAQ,KAAK,cAAI,CAAC,QAAQ,CAAC,MAAM,IAAA,eAAM,GAAE,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7H,QAAQ,GAAG,IAAA,wBAAU,EAAC,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,IAAA,uBAAS,EAAC,aAAa,EAAE,GAAG,IAAI,CAAC,WAAW,KAAK,QAAQ,KAAK,cAAI,CAAC,QAAQ,CAAC,MAAM,IAAA,eAAM,GAAE,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC5H,QAAQ,GAAG,IAAA,wBAAU,EAAC,aAAa,EAAE,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,KAAK,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;YACvF,MAAM;QACR;YACE,MAAM;KACT;IAED,MAAM,kBAAE,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzC,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAA,CAAC;AAEF,MAAM,iBAAiB,GAAG,CACxB,UAAkB,EAClB,aAAuB,EAAE,EACzB,kBAA2B,KAAK,EAChC,EAAE;IACF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,OAAO;KACR;IAED,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjG,KAAK,MAAM,aAAa,IAAI,gBAAgB,EAAE;QAC5C,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;YACpC,IAAI,eAAe,EAAE;gBACnB,MAAM,IAAI,KAAK,CAAC,gDAAgD,aAAa,CAAC,QAAQ,MAAM;sBACxF,wHAAwH,CAAC,CAAC;aAC/H;iBAAM;gBACL,IAAI,CAAC,UAAU,GAAG,MAAM,mBAAmB,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;aAC5F;SACF;QAED,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;KAC1B;AACH,CAAC,CAAA,CAAC;AAEF,MAAM,aAAa,GAAG,CACpB,UAAkB,EAClB,QAAkB,EAAE,EACpB,kBAA2B,KAAK,EAChC,EAAE;IACF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,OAAO;KACR;IAED,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjF,KAAK,MAAM,aAAa,IAAI,WAAW,EAAE;QACvC,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;YACpC,IAAI,eAAe,EAAE;gBACnB,MAAM,IAAI,KAAK,CAAC,gDAAgD,aAAa,CAAC,QAAQ,MAAM;sBACxF,wHAAwH,CAAC,CAAC;aAC/H;iBAAM;gBACL,IAAI,CAAC,UAAU,GAAG,MAAM,mBAAmB,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;aAC5F;SACF;QAED,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;KAC1B;AAEH,CAAC,CAAA,CAAC;AACF,oDAAoD;AAC7C,MAAM,WAAW,GAAG,CAAO,OAA2B,EAAE,EAAE;IAE/D,MAAM,MAAM,GAAG,MAAM,IAAA,eAAM,GAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,MAAM,kBAAE,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,CAAO,IAAI,EAAE,EAAE;QACpC,MAAM,KAAK,GAAG,IAAA,0BAAY,EAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAC/E,OAAO,
|
|
1
|
+
{"version":3,"file":"adr.js","sourceRoot":"src/","sources":["lib/adr.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,yCAAsC;AACtC,2DAA6B;AAC7B,gDAAwB;AACxB,qCAA8C;AAC9C,uCAAkC;AAClC,kDAA0B;AAC1B,+CAAoE;AACpE,mCAA+D;AAC/D,4EAA8C;AAU9C,MAAM,mBAAmB,GAAG,CAAO,YAAoB,EAAE,OAAiB,EAAE,EAAE;IAC5E,MAAM,SAAS,GAAG,MAAM,IAAA,iBAAM,EAAC;QAC7B;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,yCAAyC,eAAK,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG;YAC7E,OAAO,EAAE,OAAO;SACjB;KACF,CAAC,CAAC;IACH,OAAO,SAAS,CAAC,MAAM,CAAC;AAC1B,CAAC,CAAA,CAAC;AAEF,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,CAAO,IAAc,EAAE,EAAE;IAC5C,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,IAAA,eAAM,GAAE,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACjE,MAAM,aAAa,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAG,IAAA,0BAAY,EAAC,aAAa,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,IAAA,0BAAY,EAAC,aAAa,CAAC,CAAC;IAC7C,IAAI,QAAQ,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE,CAAC;IACjC,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,QAAQ,CAAC,IAAI;YAChB,QAAQ,GAAG,IAAA,wBAAU,EAAC,aAAa,EAAE,GAAG,IAAI,CAAC,WAAW,KAAK,QAAQ,KAAK,cAAI,CAAC,QAAQ,CAAC,MAAM,IAAA,eAAM,GAAE,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7H,QAAQ,GAAG,IAAA,wBAAU,EAAC,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,IAAA,uBAAS,EAAC,aAAa,EAAE,GAAG,IAAI,CAAC,WAAW,KAAK,QAAQ,KAAK,cAAI,CAAC,QAAQ,CAAC,MAAM,IAAA,eAAM,GAAE,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC5H,QAAQ,GAAG,IAAA,wBAAU,EAAC,aAAa,EAAE,GAAG,IAAI,CAAC,IAAI,KAAK,QAAQ,KAAK,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;YACvF,MAAM;QACR;YACE,MAAM;KACT;IAED,MAAM,kBAAE,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzC,MAAM,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAA,CAAC;AAEF,MAAM,iBAAiB,GAAG,CACxB,UAAkB,EAClB,aAAuB,EAAE,EACzB,kBAA2B,KAAK,EAChC,EAAE;IACF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,OAAO;KACR;IAED,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjG,KAAK,MAAM,aAAa,IAAI,gBAAgB,EAAE;QAC5C,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;YACpC,IAAI,eAAe,EAAE;gBACnB,MAAM,IAAI,KAAK,CAAC,gDAAgD,aAAa,CAAC,QAAQ,MAAM;sBACxF,wHAAwH,CAAC,CAAC;aAC/H;iBAAM;gBACL,IAAI,CAAC,UAAU,GAAG,MAAM,mBAAmB,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;aAC5F;SACF;QAED,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;KAC1B;AACH,CAAC,CAAA,CAAC;AAEF,MAAM,aAAa,GAAG,CACpB,UAAkB,EAClB,QAAkB,EAAE,EACpB,kBAA2B,KAAK,EAChC,EAAE;IACF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,OAAO;KACR;IAED,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEjF,KAAK,MAAM,aAAa,IAAI,WAAW,EAAE;QACvC,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;YACpC,IAAI,eAAe,EAAE;gBACnB,MAAM,IAAI,KAAK,CAAC,gDAAgD,aAAa,CAAC,QAAQ,MAAM;sBACxF,wHAAwH,CAAC,CAAC;aAC/H;iBAAM;gBACL,IAAI,CAAC,UAAU,GAAG,MAAM,mBAAmB,CAAC,aAAa,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;aAC5F;SACF;QAED,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;KAC1B;AAEH,CAAC,CAAA,CAAC;AACF,oDAAoD;AAC7C,MAAM,WAAW,GAAG,CAAO,OAA2B,EAAE,EAAE;IAE/D,MAAM,MAAM,GAAG,MAAM,IAAA,eAAM,GAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,MAAM,kBAAE,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,CAAO,IAAI,EAAE,EAAE;QACpC,MAAM,KAAK,GAAG,IAAA,0BAAY,EAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAC/E,OAAO,MAAM,KAAK,KAAK,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,KAAI,EAAE,GAAG,IAAI,GAAG,CAAC;IACzD,CAAC,CAAA,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEjD,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;IAChE,MAAM,kBAAE,CAAC,SAAS,CAAC,OAAO,EAAE,0BAA0B,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACrF,CAAC,CAAA,CAAC;AAfW,QAAA,WAAW,eAetB;AAEK,MAAM,MAAM,GAAG,CAAO,KAAa,EAAE,MAAmB,EAAE,EAAE;IACjE,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAS,GAAE,CAAC;IACjC,MAAM,aAAa,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,KAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC;IACxF,MAAM,GAAG,GAAG,MAAM,IAAA,mBAAQ,EAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,CAAC,CAAC;IAC7C,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC1I,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACxD,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAClH,MAAM,QAAQ,GAAG,GAAG,YAAY,IAAI,aAAa,KAAK,CAAC;IACvD,MAAM,YAAY,GAAG,MAAM,IAAA,eAAM,GAAE,CAAC;IACpC,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC;IAChE,MAAM,kBAAE,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACjC,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oBAAoB,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IAExF,MAAM,iBAAiB,CACrB,OAAO,EACP,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,EAClB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,CACxB,CAAC;IACF,MAAM,aAAa,CACjB,OAAO,EACP,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,EACb,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,CACxB,CAAC;IACF,MAAM,IAAA,mBAAW,GAAE,CAAC;IACpB,MAAM,UAAU,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAA,mBAAU,GAAE,EAAE,OAAO,CAAC,CAAC;IAExD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE;QACtB,MAAM,4BAAY,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;KACR;IACD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE;QACtB,MAAM,4BAAY,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;KACR;IACD,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAE1B,CAAC,CAAA,CAAC;AA1CW,QAAA,MAAM,UA0CjB;AAEK,MAAM,IAAI,GAAG,CAAO,SAAkB,EAAE,EAAE;IAC/C,MAAM,GAAG,GAAG,SAAS,KAAI,MAAM,IAAA,eAAM,GAAE,CAAA,CAAC;IACxC,MAAM,kBAAE,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,IAAA,mBAAU,GAAE,EAAE,UAAU,CAAC,EAAE,cAAI,CAAC,QAAQ,CAAC,IAAA,mBAAU,GAAE,EAAE,GAAG,CAAC,CAAC,CAAC;IAC1F,MAAM,IAAA,cAAM,EAAC,+BAA+B,EAAE;QAC5C,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ;QAC1B,QAAQ,EAAE,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,sBAAsB,CAAC;KACzE,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AARW,QAAA,IAAI,QAQf;AAEK,MAAM,IAAI,GAAG,CAAO,MAAc,EAAE,IAAY,EAAE,MAAc,EAAE,WAAmB,EAAE,OAA2B,EAAE,EAAE;IAC3H,MAAM,MAAM,GAAG,CAAO,OAAe,EAAE,EAAE;QACvC,MAAM,KAAK,GAAG,MAAM,IAAA,4BAAoB,EAAC,OAAO,CAAC,CAAC;QAClD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACtB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;SACjB;QAED,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,gDAAgD,OAAO,MAAM;kBACzE,wHAAwH,CAAC,CAAC;SAC/H;QAED,OAAO,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC,CAAA,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC;IAExC,MAAM,aAAa,CAAC,cAAI,CAAC,OAAO,CAAC,MAAM,IAAA,eAAM,GAAE,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,MAAM,IAAI,IAAI,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC;AAEtG,CAAC,CAAA,CAAC;AAnBW,QAAA,IAAI,QAmBf;AAEK,MAAM,QAAQ,GAAG,GAAS,EAAE;IACjC,MAAM,GAAG,GAAG,MAAM,IAAA,eAAM,GAAE,CAAC;IAC3B,MAAM,KAAK,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;QACxB,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACxC,IAAI,OAAO,EAAE;YACX,OAAO,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;SACtC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IACzB,OAAO,GAAG,CAAC;AACb,CAAC,CAAA,CAAC;AAXW,QAAA,QAAQ,YAWnB"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# 1. Record architecture decisions
|
|
2
|
+
|
|
3
|
+
Date: DATE
|
|
4
|
+
|
|
5
|
+
## Status
|
|
6
|
+
|
|
7
|
+
Accepted
|
|
8
|
+
|
|
9
|
+
## Context
|
|
10
|
+
|
|
11
|
+
We need to record the architectural decisions made on this project.
|
|
12
|
+
|
|
13
|
+
## Decision
|
|
14
|
+
|
|
15
|
+
We will use Architecture Decision Records, as [described by Michael Nygard](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions).
|
|
16
|
+
|
|
17
|
+
## Consequences
|
|
18
|
+
|
|
19
|
+
See Michael Nygard's article, linked above.
|
|
20
|
+
For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).
|
|
21
|
+
> For a node version of the same tooling, see Meza's [adr-tools](https://github.com/meza/adr-tools).
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# NUMBER. TITLE
|
|
2
|
+
|
|
3
|
+
Date: DATE
|
|
4
|
+
|
|
5
|
+
## Status
|
|
6
|
+
|
|
7
|
+
STATUS
|
|
8
|
+
|
|
9
|
+
## Context
|
|
10
|
+
|
|
11
|
+
The issue motivating this decision, and any context that influences or constrains the decision.
|
|
12
|
+
|
|
13
|
+
## Decision
|
|
14
|
+
|
|
15
|
+
The change that we're proposing or have agreed to implement.
|
|
16
|
+
|
|
17
|
+
## Consequences
|
|
18
|
+
|
|
19
|
+
What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.
|
package/dist/types/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const LIB_VERSION = "1.0.
|
|
1
|
+
export declare const LIB_VERSION = "1.0.10";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.ts","sourceRoot":"src/","sources":["version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"src/","sources":["version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,WAAW,CAAC"}
|
package/dist/version.js
CHANGED
package/dist/version.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"src/","sources":["version.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"src/","sources":["version.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,QAAQ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,32 +1,29 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@meza/adr-tools",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.10",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"bin": {
|
|
6
6
|
"adr": "dist/index.js"
|
|
7
7
|
},
|
|
8
|
-
"publishConfig": {
|
|
9
|
-
"access": "public"
|
|
10
|
-
},
|
|
11
|
-
"license": "MIT",
|
|
12
8
|
"types": "dist/index.d.ts",
|
|
13
9
|
"private": false,
|
|
14
10
|
"scripts": {
|
|
15
|
-
"
|
|
16
|
-
"
|
|
17
|
-
"
|
|
11
|
+
"prebuild": "./scripts/inject-version.sh ./src/version.ts",
|
|
12
|
+
"prepack": "./scripts/inject-version.sh ./src/version.ts && tsc && yarn copy ",
|
|
13
|
+
"copy": "copyfiles -u 1 ./src/templates/** ./dist",
|
|
14
|
+
"build": "tsc && yarn copy",
|
|
18
15
|
"start": "ts-node src/index.ts",
|
|
19
16
|
"commit": "commit",
|
|
20
17
|
"ci": "npm set editor '' && yarn lint && yarn test",
|
|
21
18
|
"ci:dev": "exit 0",
|
|
22
|
-
"clean": "
|
|
19
|
+
"clean": "rimraf dist .cache/tsbuildinfo",
|
|
23
20
|
"clean:all": "yarn clean && rm -rf node_modules .cache",
|
|
24
21
|
"lint:eslint": "eslint . --ext .ts --ext .json --cache --cache-location .cache/",
|
|
25
22
|
"lint:tsc": "tsc --noEmit",
|
|
26
23
|
"lint:fix": "yarn lint:eslint --fix && yarn lint:tsc",
|
|
27
24
|
"lint": "yarn lint:eslint && yarn lint:tsc",
|
|
28
25
|
"test": "vitest",
|
|
29
|
-
"prepare": "husky install",
|
|
26
|
+
"prepare": "is-ci || husky install",
|
|
30
27
|
"report": "exit 0",
|
|
31
28
|
"semantic-release": "semantic-release",
|
|
32
29
|
"release": "semantic-release"
|
|
@@ -59,7 +56,6 @@
|
|
|
59
56
|
"@commitlint/config-conventional": "^17.0.2",
|
|
60
57
|
"@commitlint/prompt-cli": "^17.0.0",
|
|
61
58
|
"@meza/tsconfig-base": "^1.1.0",
|
|
62
|
-
"@release-it/conventional-changelog": "^5.0.0",
|
|
63
59
|
"@semantic-release/changelog": "^6.0.1",
|
|
64
60
|
"@semantic-release/commit-analyzer": "^9.0.2",
|
|
65
61
|
"@semantic-release/git": "^10.0.1",
|
|
@@ -71,16 +67,17 @@
|
|
|
71
67
|
"@typescript-eslint/parser": "^5.3.0",
|
|
72
68
|
"@vitest/ui": "^0.15.2",
|
|
73
69
|
"c8": "^7.11.3",
|
|
70
|
+
"copyfiles": "^2.4.1",
|
|
74
71
|
"eslint": "^8.1.0",
|
|
75
72
|
"eslint-config-tailored-tunes": "^5.0.2",
|
|
76
73
|
"eslint-plugin-json": "^3.1.0",
|
|
77
74
|
"eslint-plugin-security": "^1.5.0",
|
|
78
75
|
"husky": "^8.0.1",
|
|
79
76
|
"install-deps-postmerge": "^2.0.1",
|
|
77
|
+
"is-ci": "^3.0.1",
|
|
80
78
|
"mock-cwd": "^1.0.0",
|
|
81
|
-
"
|
|
79
|
+
"rimraf": "^3.0.2",
|
|
82
80
|
"semantic-release": "^19.0.3",
|
|
83
|
-
"standard-version": "^9.3.2",
|
|
84
81
|
"ts-node": "^10.8.1",
|
|
85
82
|
"typescript": "^4.4.4",
|
|
86
83
|
"uuid": "^8.3.2",
|
|
@@ -90,5 +87,8 @@
|
|
|
90
87
|
"repository": {
|
|
91
88
|
"type": "git",
|
|
92
89
|
"url": "https://github.com/meza/adr-tools.git"
|
|
90
|
+
},
|
|
91
|
+
"publishConfig": {
|
|
92
|
+
"access": "public"
|
|
93
93
|
}
|
|
94
94
|
}
|
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
|
|
147
|
+
return `- [${title}](${options?.prefix || ''}${file})`;
|
|
148
148
|
});
|
|
149
149
|
|
|
150
150
|
const resolvedTitles = await Promise.all(titles);
|
package/src/version.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const LIB_VERSION = '1.0.
|
|
1
|
+
export const LIB_VERSION = '1.0.10';
|
|
2
2
|
|
|
@@ -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
|
`;
|
|
@@ -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
|
`;
|