@savvy-web/changesets 0.1.0 → 0.1.1

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 (25) hide show
  1. package/README.md +14 -36
  2. package/cjs/changelog.cjs +670 -0
  3. package/cjs/index.cjs +1302 -0
  4. package/cjs/markdownlint.cjs +312 -0
  5. package/cjs/remark.cjs +559 -0
  6. package/{bin → esm/bin}/savvy-changesets.js +143 -17
  7. package/esm/changelog.d.ts +21 -0
  8. package/esm/index.d.ts +795 -0
  9. package/esm/markdownlint.d.ts +61 -0
  10. package/esm/remark.d.ts +92 -0
  11. package/package.json +21 -27
  12. /package/{changelog.d.ts → cjs/changelog.d.cts} +0 -0
  13. /package/{index.d.ts → cjs/index.d.cts} +0 -0
  14. /package/{markdownlint.d.ts → cjs/markdownlint.d.cts} +0 -0
  15. /package/{remark.d.ts → cjs/remark.d.cts} +0 -0
  16. /package/{160.js → esm/160.js} +0 -0
  17. /package/{234.js → esm/234.js} +0 -0
  18. /package/{245.js → esm/245.js} +0 -0
  19. /package/{273.js → esm/273.js} +0 -0
  20. /package/{60.js → esm/60.js} +0 -0
  21. /package/{689.js → esm/689.js} +0 -0
  22. /package/{changelog.js → esm/changelog.js} +0 -0
  23. /package/{index.js → esm/index.js} +0 -0
  24. /package/{markdownlint.js → esm/markdownlint.js} +0 -0
  25. /package/{remark.js → esm/remark.js} +0 -0
package/README.md CHANGED
@@ -3,33 +3,17 @@
3
3
  [![npm version][npm-badge]][npm-url]
4
4
  [![License: MIT][license-badge]][license-url]
5
5
 
6
- Custom changelog formatter and markdown processing pipeline
7
- for the Silk Suite. Replaces the default
8
- `@changesets/cli/changelog` formatter with a three-layer
9
- architecture that validates changeset files, formats
10
- structured changelog entries, and post-processes the
11
- generated CHANGELOG.md.
6
+ Custom changelog formatter and markdown processing pipeline for the Silk Suite. Replaces the default `@changesets/cli/changelog` formatter with a three-layer architecture that validates changeset files, formats structured changelog entries, and post-processes the generated CHANGELOG.md.
12
7
 
13
8
  ## Features
14
9
 
15
- - **Section-aware changesets** -- Use h2 headings in
16
- changeset files to categorize changes (Features,
17
- Bug Fixes, Breaking Changes, etc.)
18
- - **Three-layer pipeline** -- Pre-validation
19
- (remark-lint), changelog formatting (Changesets API),
20
- and post-processing (remark-transform)
21
- - **13 section categories** -- Consistent categorization
22
- with priority-based ordering across all layers
23
- - **CLI tooling** -- `savvy-changesets` binary with init,
24
- lint, transform, check, and version subcommands for CI
25
- and local use
26
- - **GitHub integration** -- Automatic PR links, commit
27
- references, and contributor attribution
28
- - **Remark plugins** -- Lint rules and transform plugins
29
- via `@savvy-web/changesets/remark`
30
- - **markdownlint rules** -- Custom rules compatible with
31
- markdownlint-cli2 and the VS Code extension via
32
- `@savvy-web/changesets/markdownlint`
10
+ - **Section-aware changesets** -- Use h2 headings in changeset files to categorize changes (Features, Bug Fixes, Breaking Changes, etc.)
11
+ - **Three-layer pipeline** -- Pre-validation (remark-lint), changelog formatting (Changesets API), and post-processing (remark-transform)
12
+ - **13 section categories** -- Consistent categorization with priority-based ordering across all layers
13
+ - **CLI tooling** -- `savvy-changesets` binary with init, lint, transform, check, and version subcommands for CI and local use
14
+ - **GitHub integration** -- Automatic PR links, commit references, and contributor attribution
15
+ - **Remark plugins** -- Lint rules and transform plugins via `@savvy-web/changesets/remark`
16
+ - **markdownlint rules** -- Custom rules compatible with [markdownlint-cli2](https://www.npmjs.com/package/markdownlint-cli2) and the VS Code extension via `@savvy-web/changesets/markdownlint`
33
17
 
34
18
  ## Installation
35
19
 
@@ -45,8 +29,7 @@ Bootstrap your repository:
45
29
  savvy-changesets init
46
30
  ```
47
31
 
48
- This creates `.changeset/config.json` with auto-detected
49
- GitHub repo settings. Or configure manually:
32
+ This creates `.changeset/config.json` with auto-detected GitHub repo settings. Or configure manually:
50
33
 
51
34
  ```json
52
35
  {
@@ -57,7 +40,7 @@ GitHub repo settings. Or configure manually:
57
40
  }
58
41
  ```
59
42
 
60
- Write section-aware changeset files:
43
+ Write [section-aware changeset files](docs/section-aware-pipeline.md):
61
44
 
62
45
  ```markdown
63
46
  ---
@@ -76,8 +59,7 @@ Added a new authentication system with OAuth2 support.
76
59
 
77
60
  ## markdownlint Integration
78
61
 
79
- Register the custom rules in your base config
80
- (e.g., `lib/configs/.markdownlint-cli2.jsonc`):
62
+ Register the custom rules in your base config (e.g., `lib/configs/.markdownlint-cli2.jsonc`):
81
63
 
82
64
  ```jsonc
83
65
  {
@@ -92,8 +74,7 @@ Register the custom rules in your base config
92
74
  }
93
75
  ```
94
76
 
95
- Then enable the rules only for changeset files by
96
- creating `.changeset/.markdownlint.json`:
77
+ Then enable the rules only for changeset files by creating `.changeset/.markdownlint.json`:
97
78
 
98
79
  ```json
99
80
  {
@@ -108,11 +89,8 @@ creating `.changeset/.markdownlint.json`:
108
89
 
109
90
  ## Documentation
110
91
 
111
- - [Section-Aware Pipeline](./docs/section-aware-pipeline.md) --
112
- End-to-end walkthrough of how section-aware changesets
113
- flow through the three-layer pipeline
114
- - [Full documentation](./docs/) -- CLI usage, API
115
- reference, configuration, and architecture
92
+ - [Section-Aware Pipeline](./docs/section-aware-pipeline.md) -- End-to-end walkthrough of how section-aware changesets flow through the three-layer pipeline
93
+ - [Full documentation](./docs/) -- CLI usage, API reference, configuration, and architecture
116
94
 
117
95
  ## License
118
96