@meza/adr-tools 1.0.8 → 1.0.11

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 (109) hide show
  1. package/.gitattributes +40 -0
  2. package/.github/renovate.json +5 -0
  3. package/.github/workflows/ci-pr.yml +44 -0
  4. package/.github/workflows/ci.yml +21 -22
  5. package/.github/workflows/sync-deps-to-main.yml +25 -0
  6. package/.github/workflows/sync-to-deps.yml +26 -0
  7. package/.releaserc.json +2 -7
  8. package/CHANGELOG.md +84 -0
  9. package/LICENSE +674 -0
  10. package/README.md +64 -5
  11. package/biome.json +148 -0
  12. package/dist/index.js +105 -0
  13. package/dist/index.js.map +1 -0
  14. package/dist/lib/adr.js +177 -0
  15. package/dist/lib/adr.js.map +1 -0
  16. package/dist/lib/config.js +33 -0
  17. package/dist/lib/config.js.map +1 -0
  18. package/dist/lib/links.js +25 -0
  19. package/dist/lib/links.js.map +1 -0
  20. package/dist/lib/links.test.js +65 -0
  21. package/dist/lib/links.test.js.map +1 -0
  22. package/dist/lib/manipulator.js +84 -0
  23. package/dist/lib/manipulator.js.map +1 -0
  24. package/dist/lib/manipulator.test.js +76 -0
  25. package/dist/lib/manipulator.test.js.map +1 -0
  26. package/dist/lib/numbering.js +25 -0
  27. package/dist/lib/numbering.js.map +1 -0
  28. package/dist/lib/numbering.test.js +32 -0
  29. package/dist/lib/numbering.test.js.map +1 -0
  30. package/dist/lib/prompt.js +14 -0
  31. package/dist/lib/prompt.js.map +1 -0
  32. package/dist/lib/prompt.test.js +33 -0
  33. package/dist/lib/prompt.test.js.map +1 -0
  34. package/dist/lib/template.js +21 -0
  35. package/dist/lib/template.js.map +1 -0
  36. package/{doc/adr/0001-record-architecture-decisions.md → dist/templates/init.md} +2 -2
  37. package/dist/templates/template.md +19 -0
  38. package/dist/types/index.d.ts +3 -0
  39. package/dist/types/index.d.ts.map +1 -0
  40. package/dist/types/lib/adr.d.ts +18 -0
  41. package/dist/types/lib/adr.d.ts.map +1 -0
  42. package/dist/types/lib/config.d.ts +3 -0
  43. package/dist/types/lib/config.d.ts.map +1 -0
  44. package/dist/types/lib/links.d.ts +10 -0
  45. package/dist/types/lib/links.d.ts.map +1 -0
  46. package/dist/types/lib/links.test.d.ts +2 -0
  47. package/dist/types/lib/links.test.d.ts.map +1 -0
  48. package/dist/types/lib/manipulator.d.ts +11 -0
  49. package/dist/types/lib/manipulator.d.ts.map +1 -0
  50. package/dist/types/lib/manipulator.test.d.ts +2 -0
  51. package/dist/types/lib/manipulator.test.d.ts.map +1 -0
  52. package/dist/types/lib/numbering.d.ts +2 -0
  53. package/dist/types/lib/numbering.d.ts.map +1 -0
  54. package/dist/types/lib/numbering.test.d.ts +2 -0
  55. package/dist/types/lib/numbering.test.d.ts.map +1 -0
  56. package/dist/types/lib/prompt.d.ts +2 -0
  57. package/dist/types/lib/prompt.d.ts.map +1 -0
  58. package/dist/types/lib/prompt.test.d.ts +2 -0
  59. package/dist/types/lib/prompt.test.d.ts.map +1 -0
  60. package/dist/types/lib/template.d.ts +2 -0
  61. package/dist/types/lib/template.d.ts.map +1 -0
  62. package/dist/types/version.d.ts +2 -0
  63. package/dist/types/version.d.ts.map +1 -0
  64. package/dist/version.js +2 -0
  65. package/dist/version.js.map +1 -0
  66. package/doc/adr/.adr-sequence.lock +1 -0
  67. package/doc/adr/decisions.md +3 -0
  68. package/package.json +78 -48
  69. package/src/index.ts +52 -27
  70. package/src/lib/adr.ts +67 -72
  71. package/src/lib/config.ts +3 -3
  72. package/src/lib/links.test.ts +8 -24
  73. package/src/lib/links.ts +2 -2
  74. package/src/lib/manipulator.test.ts +44 -47
  75. package/src/lib/manipulator.ts +22 -10
  76. package/src/lib/numbering.test.ts +5 -9
  77. package/src/lib/numbering.ts +4 -5
  78. package/src/lib/prompt.test.ts +42 -0
  79. package/src/lib/prompt.ts +14 -0
  80. package/src/lib/template.ts +7 -3
  81. package/src/version.ts +1 -1
  82. package/tests/.adr-dir +1 -0
  83. package/tests/__snapshots__/generate-graph.e2e.test.ts.snap +23 -23
  84. package/tests/__snapshots__/init-adr-repository.e2e.test.ts.snap +1 -1
  85. package/tests/__snapshots__/linking-records.e2e.test.ts.snap +1 -1
  86. package/tests/__snapshots__/new-adr.e2e.test.ts.snap +1 -1
  87. package/tests/__snapshots__/superseding-records.e2e.test.ts.snap +1 -1
  88. package/tests/__snapshots__/toc-prefixing.e2e.test.ts.snap +1 -1
  89. package/tests/__snapshots__/use-template-override.e2e.test.ts.snap +1 -1
  90. package/tests/edit-on-create.e2e.test.ts +17 -12
  91. package/tests/funny-characters.e2e.test.ts +28 -21
  92. package/tests/generate-graph.e2e.test.ts +21 -13
  93. package/tests/init-adr-repository.e2e.test.ts +12 -8
  94. package/tests/linking-records.e2e.test.ts +21 -14
  95. package/tests/list-adrs.e2e.test.ts +23 -18
  96. package/tests/new-adr.e2e.test.ts +15 -12
  97. package/tests/superseding-records.e2e.test.ts +16 -11
  98. package/tests/toc-prefixing.e2e.test.ts +15 -11
  99. package/tests/use-template-override.e2e.test.ts +18 -10
  100. package/tests/work-form-other-directories.e2e.test.ts +14 -12
  101. package/tsconfig.json +9 -8
  102. package/vitest.config.e2e.ts +13 -0
  103. package/vitest.config.ts +8 -1
  104. package/.eslintignore +0 -2
  105. package/.eslintrc.json +0 -23
  106. package/.github/dependabot.yml +0 -14
  107. package/.github/workflows/auto-merge.yml +0 -14
  108. package/doc/adr/0002-using-heavy-e2e-tests.md +0 -20
  109. /package/src/{environment.d.ts → types/environment.d.ts} +0 -0
package/.github/dependabot.yml DELETED
@@ -1,14 +0,0 @@
1
- # To get started with Dependabot version updates, you'll need to specify which
2
- # package ecosystems to update and where the package manifests are located.
3
- # Please see the documentation for all configuration options:
4
- # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5
-
6
- version: 2
7
- updates:
8
- - package-ecosystem: "npm" # See documentation for possible values
9
- directory: "/" # Location of package manifests
10
- versioning-strategy: increase-if-necessary
11
- commit-message:
12
- prefix: "chore: "
13
- schedule:
14
- interval: "daily"
package/.github/workflows/auto-merge.yml DELETED
@@ -1,14 +0,0 @@
1
- name: auto-merge dependabot
2
-
3
- on:
4
- pull_request:
5
-
6
- jobs:
7
- auto-merge:
8
- runs-on: ubuntu-latest
9
- steps:
10
- - uses: actions/checkout@v2
11
- - uses: ahmadnassri/action-dependabot-auto-merge@v2
12
- with:
13
- target: minor # includes patch updates!
14
- github-token: ${{ secrets.GITHUB_TOKEN }}
package/doc/adr/0002-using-heavy-e2e-tests.md DELETED
@@ -1,20 +0,0 @@
1
- # 2. Using Heavy E2E Tests
2
-
3
- Date: 2022-06-22
4
-
5
- ## Status
6
-
7
- Accepted
8
-
9
- ## Context
10
-
11
- 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.
12
-
13
- ## Decision
14
-
15
- We'll be re-implementing those tests for ourselves too. This means that we will be using the original examples,
16
- expectations and the ethos of invoking the tool with the given examples.
17
-
18
- ## Consequences
19
-
20
- The E2E test suite will be very slow to run and it can only be executed sequentially.