@meza/adr-tools 1.0.12 → 2.0.0

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 (111) hide show
  1. package/.github/renovate.json +2 -1
  2. package/.github/workflows/ci-pr.yml +2 -25
  3. package/.github/workflows/ci.yml +12 -46
  4. package/.releaserc.json +11 -6
  5. package/AGENTS.engineer.md +236 -0
  6. package/AGENTS.md +11 -0
  7. package/AGENTS.reviewer.md +115 -0
  8. package/CONTRIBUTING.md +102 -0
  9. package/README.md +16 -4
  10. package/biome.json +18 -139
  11. package/dist/index.js +164 -81
  12. package/dist/index.js.map +1 -1
  13. package/dist/index.test.js +189 -0
  14. package/dist/index.test.js.map +1 -0
  15. package/dist/inject-version.test.js +27 -0
  16. package/dist/inject-version.test.js.map +1 -0
  17. package/dist/lib/adr.js +132 -27
  18. package/dist/lib/adr.js.map +1 -1
  19. package/dist/lib/adr.test.js +308 -0
  20. package/dist/lib/adr.test.js.map +1 -0
  21. package/dist/lib/config.js +3 -2
  22. package/dist/lib/config.js.map +1 -1
  23. package/dist/lib/config.test.js +60 -0
  24. package/dist/lib/config.test.js.map +1 -0
  25. package/dist/lib/links.test.js +5 -4
  26. package/dist/lib/links.test.js.map +1 -1
  27. package/dist/lib/manipulator-errors.test.js +21 -0
  28. package/dist/lib/manipulator-errors.test.js.map +1 -0
  29. package/dist/lib/manipulator.test.js +21 -1
  30. package/dist/lib/manipulator.test.js.map +1 -1
  31. package/dist/lib/numbering.js +1 -1
  32. package/dist/lib/numbering.js.map +1 -1
  33. package/dist/lib/numbering.test.js +7 -0
  34. package/dist/lib/numbering.test.js.map +1 -1
  35. package/dist/lib/opening.test.js +81 -0
  36. package/dist/lib/opening.test.js.map +1 -0
  37. package/dist/lib/prompt.js +1 -1
  38. package/dist/lib/prompt.js.map +1 -1
  39. package/dist/lib/template.test.js +62 -0
  40. package/dist/lib/template.test.js.map +1 -0
  41. package/dist/types/index.d.ts +25 -0
  42. package/dist/types/index.d.ts.map +1 -1
  43. package/dist/types/index.test.d.ts +2 -0
  44. package/dist/types/index.test.d.ts.map +1 -0
  45. package/dist/types/inject-version.test.d.ts +2 -0
  46. package/dist/types/inject-version.test.d.ts.map +1 -0
  47. package/dist/types/lib/adr.d.ts +15 -0
  48. package/dist/types/lib/adr.d.ts.map +1 -1
  49. package/dist/types/lib/adr.test.d.ts +2 -0
  50. package/dist/types/lib/adr.test.d.ts.map +1 -0
  51. package/dist/types/lib/config.d.ts.map +1 -1
  52. package/dist/types/lib/config.test.d.ts +2 -0
  53. package/dist/types/lib/config.test.d.ts.map +1 -0
  54. package/dist/types/lib/manipulator-errors.test.d.ts +2 -0
  55. package/dist/types/lib/manipulator-errors.test.d.ts.map +1 -0
  56. package/dist/types/lib/opening.test.d.ts +2 -0
  57. package/dist/types/lib/opening.test.d.ts.map +1 -0
  58. package/dist/types/lib/prompt.d.ts.map +1 -1
  59. package/dist/types/lib/template.test.d.ts +2 -0
  60. package/dist/types/lib/template.test.d.ts.map +1 -0
  61. package/dist/types/version.d.ts +1 -1
  62. package/dist/types/version.d.ts.map +1 -1
  63. package/dist/version.js +1 -1
  64. package/dist/version.js.map +1 -1
  65. package/doc/adr/.adr-sequence.lock +1 -1
  66. package/doc/adr/0001-record-architecture-decisions.md +21 -0
  67. package/doc/adr/0002-using-heavy-e2e-tests.md +20 -0
  68. package/doc/adr/0003-esm.md +34 -0
  69. package/doc/adr/0004-gate-editor-opening-behind---open-and---open-with.md +55 -0
  70. package/doc/adr/decisions.md +4 -1
  71. package/lefthook.yml +14 -0
  72. package/package.json +24 -26
  73. package/scripts/inject-version.mjs +34 -0
  74. package/src/index.test.ts +212 -0
  75. package/src/index.ts +229 -108
  76. package/src/inject-version.test.ts +31 -0
  77. package/src/lib/adr.test.ts +376 -0
  78. package/src/lib/adr.ts +173 -27
  79. package/src/lib/config.test.ts +69 -0
  80. package/src/lib/config.ts +3 -2
  81. package/src/lib/links.test.ts +8 -4
  82. package/src/lib/manipulator-errors.test.ts +22 -0
  83. package/src/lib/manipulator.test.ts +25 -1
  84. package/src/lib/numbering.test.ts +8 -0
  85. package/src/lib/numbering.ts +1 -1
  86. package/src/lib/opening.test.ts +96 -0
  87. package/src/lib/prompt.ts +1 -1
  88. package/src/lib/template.test.ts +74 -0
  89. package/src/version.ts +1 -2
  90. package/tests/edit-on-create.e2e.test.ts +47 -16
  91. package/tests/fake-editor.cmd +2 -0
  92. package/tests/fake-visual.cmd +2 -0
  93. package/tests/funny-characters.e2e.test.ts +12 -11
  94. package/tests/generate-graph.e2e.test.ts +13 -17
  95. package/tests/helpers/adr-cli.ts +24 -0
  96. package/tests/init-adr-repository.e2e.test.ts +7 -6
  97. package/tests/linking-records.e2e.test.ts +14 -13
  98. package/tests/list-adrs.e2e.test.ts +26 -19
  99. package/tests/new-adr.e2e.test.ts +10 -9
  100. package/tests/open-with.e2e.test.ts +53 -0
  101. package/tests/superseding-records.e2e.test.ts +11 -10
  102. package/tests/toc-prefixing.e2e.test.ts +10 -9
  103. package/tests/use-template-override.e2e.test.ts +9 -8
  104. package/tests/work-form-other-directories.e2e.test.ts +10 -8
  105. package/vitest.config.e2e.ts +8 -1
  106. package/vitest.config.ts +20 -4
  107. package/.github/workflows/sync-deps-to-main.yml +0 -25
  108. package/.github/workflows/sync-to-deps.yml +0 -26
  109. package/.husky/commit-msg +0 -4
  110. package/CHANGELOG.md +0 -121
  111. package/scripts/inject-version.sh +0 -4
package/CHANGELOG.md DELETED
@@ -1,121 +0,0 @@
1
- # ADR Tools Changelog
2
-
3
- ## [1.0.12](https://github.com/meza/adr-tools/compare/v1.0.11...v1.0.12) (2025-05-30)
4
-
5
-
6
- ### Bug Fixes
7
-
8
- * consistent sorting of files for the toc ([86db508](https://github.com/meza/adr-tools/commit/86db508720acf519403f4e0e4e4aa4cdfa7cb0f3)), closes [#393](https://github.com/meza/adr-tools/issues/393)
9
-
10
- ## [1.0.11](https://github.com/meza/adr-tools/compare/v1.0.10...v1.0.11) (2025-05-30)
11
-
12
-
13
- ### Bug Fixes
14
-
15
- * **deps:** update dependency @types/inquirer to v9.0.8 ([52a8cc2](https://github.com/meza/adr-tools/commit/52a8cc25df8c472d40046d793df46f059f8b35a1))
16
- * **deps:** update dependency @types/node to v22.10.0 ([b2fde38](https://github.com/meza/adr-tools/commit/b2fde38c1071967028a3d453a7607947342c4be0))
17
- * **deps:** update dependency @types/node to v22.10.1 ([0578ee3](https://github.com/meza/adr-tools/commit/0578ee392ad19ce580cf6dddf6457141caf7d6b1))
18
- * **deps:** update dependency @types/node to v22.10.10 ([1ceca57](https://github.com/meza/adr-tools/commit/1ceca579cf9fe41425f551cc9959b45b7ab80752))
19
- * **deps:** update dependency @types/node to v22.10.2 ([996143d](https://github.com/meza/adr-tools/commit/996143db50e4b1e91600a4bf40f35708c49c5a22))
20
- * **deps:** update dependency @types/node to v22.10.3 ([2e32e83](https://github.com/meza/adr-tools/commit/2e32e83227890a6d67c7d140930ea930e667d9a1))
21
- * **deps:** update dependency @types/node to v22.10.4 ([af6a728](https://github.com/meza/adr-tools/commit/af6a7286b644c926d5712e393f2b2d91bae47066))
22
- * **deps:** update dependency @types/node to v22.10.5 ([5f7805a](https://github.com/meza/adr-tools/commit/5f7805a826aa89218aa3353502d7dd964d34cc37))
23
- * **deps:** update dependency @types/node to v22.10.6 ([0a07622](https://github.com/meza/adr-tools/commit/0a07622ee374f9dc90de165dfce5beb54c71e0c7))
24
- * **deps:** update dependency @types/node to v22.10.7 ([ef966f5](https://github.com/meza/adr-tools/commit/ef966f5eb70e3beea93ed62289bc7ddfb9cd2f70))
25
- * **deps:** update dependency @types/node to v22.12.0 ([4f59ed6](https://github.com/meza/adr-tools/commit/4f59ed660571267e965c49c39b53176292c96426))
26
- * **deps:** update dependency @types/node to v22.13.0 ([95613d4](https://github.com/meza/adr-tools/commit/95613d45a18692c240e457bb9c44d91cf737fcf3))
27
- * **deps:** update dependency @types/node to v22.13.1 ([a307a6e](https://github.com/meza/adr-tools/commit/a307a6ef9d071a4b56bdad2c2461fcb8f0c3e364))
28
- * **deps:** update dependency @types/node to v22.13.10 ([2954e7a](https://github.com/meza/adr-tools/commit/2954e7a88fe93173f047bcad6109540398cd6565))
29
- * **deps:** update dependency @types/node to v22.13.11 ([087fe1d](https://github.com/meza/adr-tools/commit/087fe1d21c9316249151e86408de125f8c30935f))
30
- * **deps:** update dependency @types/node to v22.13.13 ([034410e](https://github.com/meza/adr-tools/commit/034410e2b8e44cf45a38dc0dc820786b435d1d08))
31
- * **deps:** update dependency @types/node to v22.13.14 ([068f963](https://github.com/meza/adr-tools/commit/068f963d472518d819e2d593234ddb4cdd6b0081))
32
- * **deps:** update dependency @types/node to v22.13.17 ([4c6c807](https://github.com/meza/adr-tools/commit/4c6c80750b35c7db942826af2f7c9faf78870ad6))
33
- * **deps:** update dependency @types/node to v22.13.2 ([33ef79b](https://github.com/meza/adr-tools/commit/33ef79bb95224ef44ecf85fdb0c76a52a1241845))
34
- * **deps:** update dependency @types/node to v22.13.5 ([d874c3d](https://github.com/meza/adr-tools/commit/d874c3d07bfce465d0fac5a2172750a5747c1abf))
35
- * **deps:** update dependency @types/node to v22.13.7 ([94ac128](https://github.com/meza/adr-tools/commit/94ac128d843295a1c606faa22284459bcc35a7ee))
36
- * **deps:** update dependency @types/node to v22.13.8 ([890cbbe](https://github.com/meza/adr-tools/commit/890cbbec2e127ce65e4b9f8de4a6b4737c34f3b1))
37
- * **deps:** update dependency @types/node to v22.13.9 ([831d666](https://github.com/meza/adr-tools/commit/831d6661e73344a39ec6c39a5d37d1f0314f7a39))
38
- * **deps:** update dependency @types/node to v22.14.0 ([ca8c04f](https://github.com/meza/adr-tools/commit/ca8c04f7b85ad5d502a8677679c502ea30089c70))
39
- * **deps:** update dependency @types/node to v22.14.1 ([21ff31f](https://github.com/meza/adr-tools/commit/21ff31fe34a0051bdd02c6a2f1692dfd343aa15d))
40
- * **deps:** update dependency @types/node to v22.15.0 ([ab97411](https://github.com/meza/adr-tools/commit/ab974114f23aa3ad73365c2a64cc51f0c033e1a9))
41
- * **deps:** update dependency @types/node to v22.15.11 ([31e3442](https://github.com/meza/adr-tools/commit/31e3442d753b974d17ccbb004a98a48b999ffe2a))
42
- * **deps:** update dependency @types/node to v22.15.15 ([683c43e](https://github.com/meza/adr-tools/commit/683c43eec2572d7b8204e402bbf94462b4c3bd75))
43
- * **deps:** update dependency @types/node to v22.15.17 ([856d584](https://github.com/meza/adr-tools/commit/856d584335807fceaf64db64860facd779f5c06f))
44
- * **deps:** update dependency @types/node to v22.15.18 ([7031975](https://github.com/meza/adr-tools/commit/70319757781528b2ecb9b0f5baca90705d3e5376))
45
- * **deps:** update dependency @types/node to v22.15.19 ([fad7a00](https://github.com/meza/adr-tools/commit/fad7a00bd5c08c32b8cb0216796b23fe22158479))
46
- * **deps:** update dependency @types/node to v22.15.2 ([e5e6498](https://github.com/meza/adr-tools/commit/e5e64981110628b38332c686c80896ec1aa696b1))
47
- * **deps:** update dependency @types/node to v22.15.21 ([aaacc9a](https://github.com/meza/adr-tools/commit/aaacc9ae1b7a820264b8a3718e3ee014278bb7be))
48
- * **deps:** update dependency @types/node to v22.15.3 ([3acbf9e](https://github.com/meza/adr-tools/commit/3acbf9e1413226f5e0afa16a4b653e6b679be2bc))
49
- * **deps:** update dependency @types/node to v22.4.0 ([bd93cb6](https://github.com/meza/adr-tools/commit/bd93cb6e0fc32760760d5f873f47e472307cc9f1))
50
- * **deps:** update dependency @types/node to v22.4.1 ([3a61cbe](https://github.com/meza/adr-tools/commit/3a61cbea9b86ca6883b8c44e9498d71f636290ee))
51
- * **deps:** update dependency @types/node to v22.4.2 ([5918b12](https://github.com/meza/adr-tools/commit/5918b129761978c94bee761c785e38b668dd8c65))
52
- * **deps:** update dependency @types/node to v22.5.0 ([10fc832](https://github.com/meza/adr-tools/commit/10fc832e188fd98045aa7f69872e9b4de71928f6))
53
- * **deps:** update dependency @types/node to v22.5.1 ([07f9cd0](https://github.com/meza/adr-tools/commit/07f9cd021aac78fab0fa45e4ae238cdf496a9431))
54
- * **deps:** update dependency @types/node to v22.5.2 ([3427f61](https://github.com/meza/adr-tools/commit/3427f61949b8bf4c2884e0bb696a6f4ffaf5c81e))
55
- * **deps:** update dependency @types/node to v22.5.3 ([f6096e5](https://github.com/meza/adr-tools/commit/f6096e556ce0a05ec80101436bfe0d0fd98940e2))
56
- * **deps:** update dependency @types/node to v22.5.4 ([c252908](https://github.com/meza/adr-tools/commit/c25290877bede248f426e6c8fe152823af078f58))
57
- * **deps:** update dependency @types/node to v22.5.5 ([bde74e8](https://github.com/meza/adr-tools/commit/bde74e8bea7c39b9934ae55280c35e8419c0c6a7))
58
- * **deps:** update dependency @types/node to v22.7.0 ([1a80aa3](https://github.com/meza/adr-tools/commit/1a80aa388c19f96ad8c779131439e761938e6eea))
59
- * **deps:** update dependency @types/node to v22.7.4 ([e5694d6](https://github.com/meza/adr-tools/commit/e5694d65951463cf5695f8da0c5542d713d5b4fa))
60
- * **deps:** update dependency @types/node to v22.7.5 ([e2e303c](https://github.com/meza/adr-tools/commit/e2e303c3b5e4e6b7efa54eb0cdbc11bb4250d91b))
61
- * **deps:** update dependency @types/node to v22.7.6 ([4afb3c5](https://github.com/meza/adr-tools/commit/4afb3c5c49401db45f12a40ebe32bea6dd503da2))
62
- * **deps:** update dependency @types/node to v22.7.7 ([9edd88c](https://github.com/meza/adr-tools/commit/9edd88c692b9402d7788eaeed4d727c6f4c799aa))
63
- * **deps:** update dependency @types/node to v22.7.8 ([887ee9b](https://github.com/meza/adr-tools/commit/887ee9b377fedd883815ccf5322c6f6fc6ac7f7b))
64
- * **deps:** update dependency @types/node to v22.7.9 ([0e10658](https://github.com/meza/adr-tools/commit/0e10658f806885f1705d0ee46379fceaeece4f27))
65
- * **deps:** update dependency @types/node to v22.8.1 ([05569ff](https://github.com/meza/adr-tools/commit/05569ffc812d6c184ecf4e0aa5dc5b15ae12a355))
66
- * **deps:** update dependency @types/node to v22.8.2 ([79cbc2c](https://github.com/meza/adr-tools/commit/79cbc2c5e235509327de98b3e853acac12086c20))
67
- * **deps:** update dependency @types/node to v22.8.4 ([24c0723](https://github.com/meza/adr-tools/commit/24c07236c3365a681fecbbb8180b596ead84182a))
68
- * **deps:** update dependency @types/node to v22.8.7 ([c4c4a24](https://github.com/meza/adr-tools/commit/c4c4a24ae19fae595a58bb41b62fc0fcd96c7b55))
69
- * **deps:** update dependency @types/node to v22.9.0 ([d6916a7](https://github.com/meza/adr-tools/commit/d6916a797af0a0ebdd1ae04777e75e240ac33fc7))
70
- * **deps:** update dependency chalk to v5.4.0 ([e3a610a](https://github.com/meza/adr-tools/commit/e3a610a298cd2a194b15fe2794d47df30934009a))
71
- * **deps:** update dependency chalk to v5.4.1 ([66dd075](https://github.com/meza/adr-tools/commit/66dd07599778fef01c047bc48f50a2c559dc39af))
72
- * **deps:** update dependency core-js to v3.38.1 ([ecc0667](https://github.com/meza/adr-tools/commit/ecc0667c5753275329065911c91f4b7b887f54e7))
73
- * **deps:** update dependency core-js to v3.39.0 ([cd22b67](https://github.com/meza/adr-tools/commit/cd22b67384275a04f139d99b7717413c2eff3656))
74
- * **deps:** update dependency core-js to v3.40.0 ([abdf128](https://github.com/meza/adr-tools/commit/abdf1282e590428a248ac30c854f98637745f74b))
75
- * **deps:** update dependency core-js to v3.41.0 ([178ade5](https://github.com/meza/adr-tools/commit/178ade5f55a3224584a245824d1fe0d3c3c584b9))
76
- * **deps:** update dependency core-js to v3.42.0 ([b16110b](https://github.com/meza/adr-tools/commit/b16110bb4f77af9c2005bc18cdde78928501de1d))
77
- * **deps:** update dependency inquirer to v9.3.7 ([586a66b](https://github.com/meza/adr-tools/commit/586a66b26f1e9dab3df32e040f3710c1d1ffc55b))
78
-
79
- ## [1.0.10](https://github.com/meza/adr-tools/compare/v1.0.9...v1.0.10) (2022-06-27)
80
-
81
-
82
- ### Bug Fixes
83
-
84
- * added missing dependencies ([b07d0a6](https://github.com/meza/adr-tools/commit/b07d0a60bb563e81e74530d90aa421cbf985edf8))
85
- * **ci:** fixed the cach key ([6149a19](https://github.com/meza/adr-tools/commit/6149a19aa0708170bb249466686e219b0dc0fe91))
86
-
87
- ## [1.0.9](https://github.com/meza/adr-tools/compare/v1.0.8...v1.0.9) (2022-06-27)
88
-
89
-
90
- ### Bug Fixes
91
-
92
- * missing template ([4025740](https://github.com/meza/adr-tools/commit/40257404926e17a6c43f10d51c9809ce68e1400a))
93
-
94
- ## [1.0.8](https://github.com/meza/adr-tools/compare/v1.0.7...v1.0.8) (2022-06-27)
95
-
96
-
97
- ### Bug Fixes
98
-
99
- * toc now generates as a list ([ecfe2aa](https://github.com/meza/adr-tools/commit/ecfe2aaf9b4431672860411b0d6fbd7ec0141beb))
100
-
101
- ## [1.0.7](https://github.com/meza/adr-tools/compare/v1.0.6...v1.0.7) (2022-06-27)
102
-
103
-
104
- ### Bug Fixes
105
-
106
- * fixed the regression of the restricted releases ([303c19f](https://github.com/meza/adr-tools/commit/303c19fd40a31dd586feb01fd0c8209c92423898))
107
-
108
- ## [1.0.6](https://github.com/meza/adr-tools/compare/v1.0.5...v1.0.6) (2022-06-27)
109
-
110
-
111
- ### Bug Fixes
112
-
113
- * fixed the changelog title ([0f3f4d2](https://github.com/meza/adr-tools/commit/0f3f4d2b75ef6b93ce6e55c9527318e11867e28b))
114
-
115
- ## [1.0.5](https://github.com/meza/adr-tools/compare/v1.0.4...v1.0.5) (2022-06-27)
116
-
117
-
118
- ### Bug Fixes
119
-
120
- * no git push on release ([51d520e](https://github.com/meza/adr-tools/commit/51d520ee07f3c638ac59dae35c74e47b397db6b7))
121
- * removed unused dependencies ([7a5af74](https://github.com/meza/adr-tools/commit/7a5af74a9f592212f5272644bde713dc9bfa40b1))
package/scripts/inject-version.sh DELETED
@@ -1,4 +0,0 @@
1
- #!/bin/sh
2
-
3
- PKG_VERSION=$(node -p "require('./package.json').version")
4
- echo "export const LIB_VERSION = '${PKG_VERSION}';\n" > $1