@programinglive/commiter 1.0.5 → 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.
- package/.github/ISSUE_TEMPLATE/bug_report.md +28 -28
- package/.github/ISSUE_TEMPLATE/config.yml +5 -5
- package/.github/ISSUE_TEMPLATE/feature_request.md +20 -20
- package/.github/PULL_REQUEST_TEMPLATE.md +24 -24
- package/CHANGELOG.md +49 -33
- package/CODE_OF_CONDUCT.md +36 -36
- package/LICENSE +21 -21
- package/PUBLISH.md +116 -116
- package/README.md +181 -181
- package/SECURITY.md +30 -30
- package/commitlint.config.cjs +4 -4
- package/index.js +148 -129
- package/package.json +94 -94
- package/scripts/release.js +97 -0
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: Bug report
|
|
3
|
-
about: Create a report to help us improve
|
|
4
|
-
labels: bug
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Describe the bug
|
|
8
|
-
A clear and concise description of what the bug is.
|
|
9
|
-
|
|
10
|
-
## To Reproduce
|
|
11
|
-
Steps to reproduce the behavior:
|
|
12
|
-
1. Go to '...'
|
|
13
|
-
2. Click on '...'
|
|
14
|
-
3. See error
|
|
15
|
-
|
|
16
|
-
## Expected behavior
|
|
17
|
-
A clear and concise description of what you expected to happen.
|
|
18
|
-
|
|
19
|
-
## Screenshots or logs
|
|
20
|
-
If applicable, add screenshots, logs, or stack traces to help explain your problem.
|
|
21
|
-
|
|
22
|
-
## Environment
|
|
23
|
-
- Package version:
|
|
24
|
-
- Node.js version:
|
|
25
|
-
- OS:
|
|
26
|
-
|
|
27
|
-
## Additional context
|
|
28
|
-
Add any other context about the problem here.
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Create a report to help us improve
|
|
4
|
+
labels: bug
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Describe the bug
|
|
8
|
+
A clear and concise description of what the bug is.
|
|
9
|
+
|
|
10
|
+
## To Reproduce
|
|
11
|
+
Steps to reproduce the behavior:
|
|
12
|
+
1. Go to '...'
|
|
13
|
+
2. Click on '...'
|
|
14
|
+
3. See error
|
|
15
|
+
|
|
16
|
+
## Expected behavior
|
|
17
|
+
A clear and concise description of what you expected to happen.
|
|
18
|
+
|
|
19
|
+
## Screenshots or logs
|
|
20
|
+
If applicable, add screenshots, logs, or stack traces to help explain your problem.
|
|
21
|
+
|
|
22
|
+
## Environment
|
|
23
|
+
- Package version:
|
|
24
|
+
- Node.js version:
|
|
25
|
+
- OS:
|
|
26
|
+
|
|
27
|
+
## Additional context
|
|
28
|
+
Add any other context about the problem here.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
blank_issues_enabled: false
|
|
2
|
-
contact_links:
|
|
3
|
-
- name: Security Report
|
|
4
|
-
url: https://github.com/programinglive/commiter/security/policy
|
|
5
|
-
about: Please read our security policy before reporting vulnerabilities.
|
|
1
|
+
blank_issues_enabled: false
|
|
2
|
+
contact_links:
|
|
3
|
+
- name: Security Report
|
|
4
|
+
url: https://github.com/programinglive/commiter/security/policy
|
|
5
|
+
about: Please read our security policy before reporting vulnerabilities.
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: Feature request
|
|
3
|
-
about: Suggest an idea for this project
|
|
4
|
-
labels: enhancement
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Summary
|
|
8
|
-
Describe the feature you would like to see.
|
|
9
|
-
|
|
10
|
-
## Problem or Use Case
|
|
11
|
-
What problem does this feature solve? Why is it needed?
|
|
12
|
-
|
|
13
|
-
## Proposed Solution
|
|
14
|
-
Describe your proposed solution or implementation ideas.
|
|
15
|
-
|
|
16
|
-
## Alternatives
|
|
17
|
-
List any alternative solutions or features you've considered.
|
|
18
|
-
|
|
19
|
-
## Additional context
|
|
20
|
-
Add any other context, mockups, or screenshots about the feature request here.
|
|
1
|
+
---
|
|
2
|
+
name: Feature request
|
|
3
|
+
about: Suggest an idea for this project
|
|
4
|
+
labels: enhancement
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Summary
|
|
8
|
+
Describe the feature you would like to see.
|
|
9
|
+
|
|
10
|
+
## Problem or Use Case
|
|
11
|
+
What problem does this feature solve? Why is it needed?
|
|
12
|
+
|
|
13
|
+
## Proposed Solution
|
|
14
|
+
Describe your proposed solution or implementation ideas.
|
|
15
|
+
|
|
16
|
+
## Alternatives
|
|
17
|
+
List any alternative solutions or features you've considered.
|
|
18
|
+
|
|
19
|
+
## Additional context
|
|
20
|
+
Add any other context, mockups, or screenshots about the feature request here.
|
|
@@ -1,24 +1,24 @@
|
|
|
1
|
-
# Pull Request Checklist
|
|
2
|
-
|
|
3
|
-
## Summary
|
|
4
|
-
|
|
5
|
-
Describe the changes in this pull request.
|
|
6
|
-
|
|
7
|
-
## Related Issues
|
|
8
|
-
|
|
9
|
-
Link related issues (e.g. closes #123).
|
|
10
|
-
|
|
11
|
-
## Testing
|
|
12
|
-
|
|
13
|
-
- [ ] `npm install`
|
|
14
|
-
- [ ] `npm test`
|
|
15
|
-
- [ ] `npm run release -- --dry-run` (if release-related)
|
|
16
|
-
|
|
17
|
-
## Checklist
|
|
18
|
-
|
|
19
|
-
- [ ] I've read the [Code of Conduct](../CODE_OF_CONDUCT.md)
|
|
20
|
-
- [ ] I've read the [Contributing Guidelines](../CONTRIBUTING.md)
|
|
21
|
-
- [ ] My commits follow the Conventional Commits format (`type(scope): subject`)
|
|
22
|
-
- [ ] Documentation has been updated if needed
|
|
23
|
-
- [ ] New dependencies are justified and added to `package.json`
|
|
24
|
-
- [ ] No `any` types were introduced (TypeScript rule)
|
|
1
|
+
# Pull Request Checklist
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
|
|
5
|
+
Describe the changes in this pull request.
|
|
6
|
+
|
|
7
|
+
## Related Issues
|
|
8
|
+
|
|
9
|
+
Link related issues (e.g. closes #123).
|
|
10
|
+
|
|
11
|
+
## Testing
|
|
12
|
+
|
|
13
|
+
- [ ] `npm install`
|
|
14
|
+
- [ ] `npm test`
|
|
15
|
+
- [ ] `npm run release -- --dry-run` (if release-related)
|
|
16
|
+
|
|
17
|
+
## Checklist
|
|
18
|
+
|
|
19
|
+
- [ ] I've read the [Code of Conduct](../CODE_OF_CONDUCT.md)
|
|
20
|
+
- [ ] I've read the [Contributing Guidelines](../CONTRIBUTING.md)
|
|
21
|
+
- [ ] My commits follow the Conventional Commits format (`type(scope): subject`)
|
|
22
|
+
- [ ] Documentation has been updated if needed
|
|
23
|
+
- [ ] New dependencies are justified and added to `package.json`
|
|
24
|
+
- [ ] No `any` types were introduced (TypeScript rule)
|
package/CHANGELOG.md
CHANGED
|
@@ -2,44 +2,60 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
-
### [1.0.
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
### 🐛 Bug Fixes
|
|
9
|
-
|
|
10
|
-
* allow release commits with emoji ([26c4afa](https://github.com/programinglive/commiter/commit/26c4afa26fc7c11c91ac576dcba197cba5d3d98a))
|
|
11
|
-
|
|
12
|
-
### [1.0.4](https://github.com/programinglive/commiter/compare/v1.0.3...v1.0.4) (2025-10-19)
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
### 🐛 Bug Fixes
|
|
16
|
-
|
|
17
|
-
* ensure safe test default for initial release ([27d2ee3](https://github.com/programinglive/commiter/commit/27d2ee35d1e558ef459a61e41627305997621392))
|
|
18
|
-
|
|
19
|
-
### [1.0.3](https://github.com/programinglive/commiter/compare/v1.0.2...v1.0.3) (2025-10-19)
|
|
20
|
-
|
|
21
|
-
### [1.0.2](https://github.com/programinglive/commiter/compare/v1.0.1...v1.0.2) (2025-10-19)
|
|
22
|
-
|
|
23
|
-
### [1.0.1](https://github.com/programinglive/commiter/compare/v1.0.0...v1.0.1) (2025-10-18)
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
### 🐛 Bug Fixes
|
|
27
|
-
|
|
28
|
-
* align commitlint config with project module type ([d051eac](https://github.com/programinglive/commiter/commit/d051eace5471d0c54fd8de6a3bede6a0df020dad))
|
|
29
|
-
|
|
30
|
-
## 1.0.0 (2025-10-17)
|
|
5
|
+
### [1.0.8](https://github.com/programinglive/commiter/compare/v1.0.7...v1.0.8) (2025-10-29)
|
|
31
6
|
|
|
32
7
|
|
|
33
8
|
### ✨ Features
|
|
34
9
|
|
|
35
|
-
*
|
|
36
|
-
|
|
10
|
+
* add release helper script and tests ([085af63](https://github.com/programinglive/commiter/commit/085af631d2c53725f125d0f48b1221bc81830288))
|
|
37
11
|
|
|
38
|
-
###
|
|
12
|
+
### [1.0.7](https://github.com/programinglive/commiter/compare/v1.0.6...v1.0.7) (2025-10-29)
|
|
39
13
|
|
|
40
|
-
* add community health files and apply package tooling ([0fa802b](https://github.com/programinglive/commiter/commit/0fa802b6129053d3f32030cec561e5926dd09c42))
|
|
41
14
|
|
|
15
|
+
### ✨ Features
|
|
42
16
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
17
|
+
* add release helper script and tests ([93f4235](https://github.com/programinglive/commiter/commit/93f4235c3cf2e34b77b78ba51c0337cf89e564df))
|
|
18
|
+
|
|
19
|
+
### [1.0.6](https://github.com/programinglive/commiter/compare/v1.0.5...v1.0.6) (2025-10-19)
|
|
20
|
+
|
|
21
|
+
### [1.0.5](https://github.com/programinglive/commiter/compare/v1.0.4...v1.0.5) (2025-10-19)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### 🐛 Bug Fixes
|
|
25
|
+
|
|
26
|
+
* allow release commits with emoji ([26c4afa](https://github.com/programinglive/commiter/commit/26c4afa26fc7c11c91ac576dcba197cba5d3d98a))
|
|
27
|
+
|
|
28
|
+
### [1.0.4](https://github.com/programinglive/commiter/compare/v1.0.3...v1.0.4) (2025-10-19)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### 🐛 Bug Fixes
|
|
32
|
+
|
|
33
|
+
* ensure safe test default for initial release ([27d2ee3](https://github.com/programinglive/commiter/commit/27d2ee35d1e558ef459a61e41627305997621392))
|
|
34
|
+
|
|
35
|
+
### [1.0.3](https://github.com/programinglive/commiter/compare/v1.0.2...v1.0.3) (2025-10-19)
|
|
36
|
+
|
|
37
|
+
### [1.0.2](https://github.com/programinglive/commiter/compare/v1.0.1...v1.0.2) (2025-10-19)
|
|
38
|
+
|
|
39
|
+
### [1.0.1](https://github.com/programinglive/commiter/compare/v1.0.0...v1.0.1) (2025-10-18)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### 🐛 Bug Fixes
|
|
43
|
+
|
|
44
|
+
* align commitlint config with project module type ([d051eac](https://github.com/programinglive/commiter/commit/d051eace5471d0c54fd8de6a3bede6a0df020dad))
|
|
45
|
+
|
|
46
|
+
## 1.0.0 (2025-10-17)
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### ✨ Features
|
|
50
|
+
|
|
51
|
+
* initial project setup with standard-version and conventional commits ([0accf6d](https://github.com/programinglive/commiter/commit/0accf6dba678c1946629aa3f1b691bea7e20cd95))
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### 📝 Documentation
|
|
55
|
+
|
|
56
|
+
* add community health files and apply package tooling ([0fa802b](https://github.com/programinglive/commiter/commit/0fa802b6129053d3f32030cec561e5926dd09c42))
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### 🧹 Chores
|
|
60
|
+
|
|
61
|
+
* update package metadata ([7c112f3](https://github.com/programinglive/commiter/commit/7c112f3d82e2c92ed31fa3e60fafd5ca0429184d))
|
package/CODE_OF_CONDUCT.md
CHANGED
|
@@ -1,36 +1,36 @@
|
|
|
1
|
-
# Contributor Covenant Code of Conduct
|
|
2
|
-
|
|
3
|
-
## Our Pledge
|
|
4
|
-
We pledge to make participation in `@programinglive/commiter` open, welcoming, and harassment-free for everyone, regardless of age, body size, disability, ethnicity, gender identity or expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
5
|
-
|
|
6
|
-
## Our Standards
|
|
7
|
-
**Positive behaviours**
|
|
8
|
-
- Showing empathy and kindness toward other people
|
|
9
|
-
- Respecting differing opinions, viewpoints, and experiences
|
|
10
|
-
- Giving and gracefully accepting constructive feedback
|
|
11
|
-
- Accepting responsibility and apologizing when mistakes occur
|
|
12
|
-
|
|
13
|
-
**Unacceptable behaviours**
|
|
14
|
-
- Use of sexualized language or imagery, or unwelcome sexual attention
|
|
15
|
-
- Trolling, insulting or derogatory comments, and personal attacks
|
|
16
|
-
- Public or private harassment
|
|
17
|
-
- Publishing others' private information without permission
|
|
18
|
-
- Other conduct which would reasonably be considered inappropriate in a professional setting
|
|
19
|
-
|
|
20
|
-
## Enforcement Responsibilities
|
|
21
|
-
Project maintainers are responsible for clarifying standards of acceptable behaviour and will take appropriate corrective action in response to unacceptable behaviour. Maintainers have the right to remove, edit, or reject contributions that do not align with this Code of Conduct.
|
|
22
|
-
|
|
23
|
-
## Scope
|
|
24
|
-
This Code of Conduct applies within all project spaces and when an individual is officially representing the project in public spaces.
|
|
25
|
-
|
|
26
|
-
## Enforcement
|
|
27
|
-
Report incidents to `security@programinglive.com`. All complaints will be reviewed promptly and treated confidentially.
|
|
28
|
-
|
|
29
|
-
## Enforcement Guidelines
|
|
30
|
-
1. **Correction** – Private warning for minor violations and clarification of expectations.
|
|
31
|
-
2. **Warning** – Consequence for a single serious violation or repeated minor violations.
|
|
32
|
-
3. **Temporary Ban** – Temporary exclusion from community interactions when behaviour is unacceptable.
|
|
33
|
-
4. **Permanent Ban** – Permanent removal from the community for sustained inappropriate behaviour or harassment.
|
|
34
|
-
|
|
35
|
-
## Attribution
|
|
36
|
-
Adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
We pledge to make participation in `@programinglive/commiter` open, welcoming, and harassment-free for everyone, regardless of age, body size, disability, ethnicity, gender identity or expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
5
|
+
|
|
6
|
+
## Our Standards
|
|
7
|
+
**Positive behaviours**
|
|
8
|
+
- Showing empathy and kindness toward other people
|
|
9
|
+
- Respecting differing opinions, viewpoints, and experiences
|
|
10
|
+
- Giving and gracefully accepting constructive feedback
|
|
11
|
+
- Accepting responsibility and apologizing when mistakes occur
|
|
12
|
+
|
|
13
|
+
**Unacceptable behaviours**
|
|
14
|
+
- Use of sexualized language or imagery, or unwelcome sexual attention
|
|
15
|
+
- Trolling, insulting or derogatory comments, and personal attacks
|
|
16
|
+
- Public or private harassment
|
|
17
|
+
- Publishing others' private information without permission
|
|
18
|
+
- Other conduct which would reasonably be considered inappropriate in a professional setting
|
|
19
|
+
|
|
20
|
+
## Enforcement Responsibilities
|
|
21
|
+
Project maintainers are responsible for clarifying standards of acceptable behaviour and will take appropriate corrective action in response to unacceptable behaviour. Maintainers have the right to remove, edit, or reject contributions that do not align with this Code of Conduct.
|
|
22
|
+
|
|
23
|
+
## Scope
|
|
24
|
+
This Code of Conduct applies within all project spaces and when an individual is officially representing the project in public spaces.
|
|
25
|
+
|
|
26
|
+
## Enforcement
|
|
27
|
+
Report incidents to `security@programinglive.com`. All complaints will be reviewed promptly and treated confidentially.
|
|
28
|
+
|
|
29
|
+
## Enforcement Guidelines
|
|
30
|
+
1. **Correction** – Private warning for minor violations and clarification of expectations.
|
|
31
|
+
2. **Warning** – Consequence for a single serious violation or repeated minor violations.
|
|
32
|
+
3. **Temporary Ban** – Temporary exclusion from community interactions when behaviour is unacceptable.
|
|
33
|
+
4. **Permanent Ban** – Permanent removal from the community for sustained inappropriate behaviour or harassment.
|
|
34
|
+
|
|
35
|
+
## Attribution
|
|
36
|
+
Adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 Programming Live
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Programming Live
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/PUBLISH.md
CHANGED
|
@@ -1,116 +1,116 @@
|
|
|
1
|
-
# Publishing to NPM
|
|
2
|
-
|
|
3
|
-
This guide explains how to publish the `@programinglive/commiter` package to npm.
|
|
4
|
-
|
|
5
|
-
## Prerequisites
|
|
6
|
-
|
|
7
|
-
1. **NPM Account**: Create an account at [npmjs.com](https://www.npmjs.com/)
|
|
8
|
-
2. **Login to NPM**: Run `npm login` in your terminal
|
|
9
|
-
3. **Organization Access**: Ensure you have access to the `@programinglive` organization on npm
|
|
10
|
-
|
|
11
|
-
## Publishing Steps
|
|
12
|
-
|
|
13
|
-
### 1. Login to NPM
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npm login
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
Enter your npm credentials when prompted.
|
|
20
|
-
|
|
21
|
-
### 2. Verify Package Configuration
|
|
22
|
-
|
|
23
|
-
Check that `package.json` is correctly configured:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
npm pack --dry-run
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
This shows what files will be included in the package.
|
|
30
|
-
|
|
31
|
-
### 3. Publish the Package
|
|
32
|
-
|
|
33
|
-
For the first publish:
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
npm publish --access public
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
**Note**: The `--access public` flag is required for scoped packages (@programinglive/commiter) to be publicly accessible.
|
|
40
|
-
|
|
41
|
-
### 4. Verify Publication
|
|
42
|
-
|
|
43
|
-
Check your package on npm:
|
|
44
|
-
```
|
|
45
|
-
https://www.npmjs.com/package/@programinglive/commiter
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Releasing New Versions
|
|
49
|
-
|
|
50
|
-
After the initial publish, use the built-in release commands:
|
|
51
|
-
|
|
52
|
-
### Patch Release (1.0.0 → 1.0.1)
|
|
53
|
-
```bash
|
|
54
|
-
npm run release:patch
|
|
55
|
-
git push --follow-tags origin main
|
|
56
|
-
npm publish
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
### Minor Release (1.0.0 → 1.1.0)
|
|
60
|
-
```bash
|
|
61
|
-
npm run release:minor
|
|
62
|
-
git push --follow-tags origin main
|
|
63
|
-
npm publish
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
### Major Release (1.0.0 → 2.0.0)
|
|
67
|
-
```bash
|
|
68
|
-
npm run release:major
|
|
69
|
-
git push --follow-tags origin main
|
|
70
|
-
npm publish
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
## Automated Release Workflow
|
|
74
|
-
|
|
75
|
-
1. Make changes and commit using conventional commits
|
|
76
|
-
2. Run the appropriate release command
|
|
77
|
-
3. Push to GitHub with tags
|
|
78
|
-
4. Publish to npm
|
|
79
|
-
|
|
80
|
-
Example:
|
|
81
|
-
```bash
|
|
82
|
-
# Make changes
|
|
83
|
-
git add .
|
|
84
|
-
git commit -m "feat(cli): add interactive setup wizard"
|
|
85
|
-
|
|
86
|
-
# Create release
|
|
87
|
-
npm run release:minor
|
|
88
|
-
|
|
89
|
-
# Push to GitHub
|
|
90
|
-
git push --follow-tags origin main
|
|
91
|
-
|
|
92
|
-
# Publish to npm
|
|
93
|
-
npm publish
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
## Unpublishing (Emergency Only)
|
|
97
|
-
|
|
98
|
-
If you need to unpublish a version within 72 hours:
|
|
99
|
-
|
|
100
|
-
```bash
|
|
101
|
-
npm unpublish @programinglive/commiter@1.0.0
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
**Warning**: Unpublishing is permanent and should only be used in emergencies.
|
|
105
|
-
|
|
106
|
-
## Package Visibility
|
|
107
|
-
|
|
108
|
-
- **Public**: Anyone can install and use the package
|
|
109
|
-
- **Open Source**: MIT licensed - users can modify and distribute
|
|
110
|
-
- **Free**: No cost to install or use
|
|
111
|
-
|
|
112
|
-
## Support
|
|
113
|
-
|
|
114
|
-
For issues or questions:
|
|
115
|
-
- GitHub Issues: https://github.com/programinglive/commiter/issues
|
|
116
|
-
- NPM Package: https://www.npmjs.com/package/@programinglive/commiter
|
|
1
|
+
# Publishing to NPM
|
|
2
|
+
|
|
3
|
+
This guide explains how to publish the `@programinglive/commiter` package to npm.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
1. **NPM Account**: Create an account at [npmjs.com](https://www.npmjs.com/)
|
|
8
|
+
2. **Login to NPM**: Run `npm login` in your terminal
|
|
9
|
+
3. **Organization Access**: Ensure you have access to the `@programinglive` organization on npm
|
|
10
|
+
|
|
11
|
+
## Publishing Steps
|
|
12
|
+
|
|
13
|
+
### 1. Login to NPM
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm login
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Enter your npm credentials when prompted.
|
|
20
|
+
|
|
21
|
+
### 2. Verify Package Configuration
|
|
22
|
+
|
|
23
|
+
Check that `package.json` is correctly configured:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm pack --dry-run
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
This shows what files will be included in the package.
|
|
30
|
+
|
|
31
|
+
### 3. Publish the Package
|
|
32
|
+
|
|
33
|
+
For the first publish:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npm publish --access public
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Note**: The `--access public` flag is required for scoped packages (@programinglive/commiter) to be publicly accessible.
|
|
40
|
+
|
|
41
|
+
### 4. Verify Publication
|
|
42
|
+
|
|
43
|
+
Check your package on npm:
|
|
44
|
+
```
|
|
45
|
+
https://www.npmjs.com/package/@programinglive/commiter
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Releasing New Versions
|
|
49
|
+
|
|
50
|
+
After the initial publish, use the built-in release commands:
|
|
51
|
+
|
|
52
|
+
### Patch Release (1.0.0 → 1.0.1)
|
|
53
|
+
```bash
|
|
54
|
+
npm run release:patch
|
|
55
|
+
git push --follow-tags origin main
|
|
56
|
+
npm publish
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Minor Release (1.0.0 → 1.1.0)
|
|
60
|
+
```bash
|
|
61
|
+
npm run release:minor
|
|
62
|
+
git push --follow-tags origin main
|
|
63
|
+
npm publish
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Major Release (1.0.0 → 2.0.0)
|
|
67
|
+
```bash
|
|
68
|
+
npm run release:major
|
|
69
|
+
git push --follow-tags origin main
|
|
70
|
+
npm publish
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Automated Release Workflow
|
|
74
|
+
|
|
75
|
+
1. Make changes and commit using conventional commits
|
|
76
|
+
2. Run the appropriate release command
|
|
77
|
+
3. Push to GitHub with tags
|
|
78
|
+
4. Publish to npm
|
|
79
|
+
|
|
80
|
+
Example:
|
|
81
|
+
```bash
|
|
82
|
+
# Make changes
|
|
83
|
+
git add .
|
|
84
|
+
git commit -m "feat(cli): add interactive setup wizard"
|
|
85
|
+
|
|
86
|
+
# Create release
|
|
87
|
+
npm run release:minor
|
|
88
|
+
|
|
89
|
+
# Push to GitHub
|
|
90
|
+
git push --follow-tags origin main
|
|
91
|
+
|
|
92
|
+
# Publish to npm
|
|
93
|
+
npm publish
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Unpublishing (Emergency Only)
|
|
97
|
+
|
|
98
|
+
If you need to unpublish a version within 72 hours:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
npm unpublish @programinglive/commiter@1.0.0
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
**Warning**: Unpublishing is permanent and should only be used in emergencies.
|
|
105
|
+
|
|
106
|
+
## Package Visibility
|
|
107
|
+
|
|
108
|
+
- **Public**: Anyone can install and use the package
|
|
109
|
+
- **Open Source**: MIT licensed - users can modify and distribute
|
|
110
|
+
- **Free**: No cost to install or use
|
|
111
|
+
|
|
112
|
+
## Support
|
|
113
|
+
|
|
114
|
+
For issues or questions:
|
|
115
|
+
- GitHub Issues: https://github.com/programinglive/commiter/issues
|
|
116
|
+
- NPM Package: https://www.npmjs.com/package/@programinglive/commiter
|