@chongdashu/cc-statusline 1.2.7 โ 1.3.2
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/CHANGELOG.md +157 -110
- package/CLAUDE.md +76 -61
- package/CONTRIBUTING.md +207 -207
- package/LICENSE +20 -20
- package/README.md +373 -305
- package/dist/index.js +206 -22
- package/dist/index.js.map +1 -1
- package/package.json +57 -57
- package/test/test-concurrent-locking.sh +54 -54
- package/test/test-installation.sh +335 -335
- package/test/test-statusline-with-lock.sh +67 -67
package/CONTRIBUTING.md
CHANGED
|
@@ -1,208 +1,208 @@
|
|
|
1
|
-
# Contributing to cc-statusline
|
|
2
|
-
|
|
3
|
-
Thank you for your interest in contributing to cc-statusline! This document provides guidelines and information for contributors.
|
|
4
|
-
|
|
5
|
-
## ๐ Quick Start
|
|
6
|
-
|
|
7
|
-
1. **Fork the repository** on GitHub
|
|
8
|
-
2. **Clone your fork** locally:
|
|
9
|
-
```bash
|
|
10
|
-
git clone https://github.com/YOUR-USERNAME/cc-statusline.git
|
|
11
|
-
cd cc-statusline
|
|
12
|
-
```
|
|
13
|
-
3. **Install dependencies**:
|
|
14
|
-
```bash
|
|
15
|
-
npm install
|
|
16
|
-
```
|
|
17
|
-
4. **Build the project**:
|
|
18
|
-
```bash
|
|
19
|
-
npm run build
|
|
20
|
-
```
|
|
21
|
-
5. **Test your changes**:
|
|
22
|
-
```bash
|
|
23
|
-
./dist/index.js --help
|
|
24
|
-
npx . init --no-install # Test locally
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## ๐ ๏ธ Development Workflow
|
|
28
|
-
|
|
29
|
-
### Making Changes
|
|
30
|
-
|
|
31
|
-
1. **Create a feature branch**:
|
|
32
|
-
```bash
|
|
33
|
-
git checkout -b feature/amazing-feature
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
2. **Make your changes** following our coding standards
|
|
37
|
-
|
|
38
|
-
3. **Test your changes**:
|
|
39
|
-
```bash
|
|
40
|
-
npm run build
|
|
41
|
-
./dist/index.js preview path/to/statusline.sh
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
4. **Commit your changes**:
|
|
45
|
-
```bash
|
|
46
|
-
git add .
|
|
47
|
-
git commit -m "feat: add amazing feature"
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Commit Message Format
|
|
51
|
-
|
|
52
|
-
We follow [Conventional Commits](https://conventionalcommits.org/):
|
|
53
|
-
|
|
54
|
-
- `feat:` - New features
|
|
55
|
-
- `fix:` - Bug fixes
|
|
56
|
-
- `docs:` - Documentation changes
|
|
57
|
-
- `style:` - Code style changes (formatting, etc.)
|
|
58
|
-
- `refactor:` - Code refactoring
|
|
59
|
-
- `test:` - Adding tests
|
|
60
|
-
- `chore:` - Maintenance tasks
|
|
61
|
-
|
|
62
|
-
Examples:
|
|
63
|
-
```
|
|
64
|
-
feat: add support for Python runtime
|
|
65
|
-
fix: resolve preview timeout issue
|
|
66
|
-
docs: update README installation guide
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
## ๐ฏ Types of Contributions
|
|
70
|
-
|
|
71
|
-
### ๐ Bug Reports
|
|
72
|
-
- Use GitHub Issues with the bug template
|
|
73
|
-
- Include steps to reproduce
|
|
74
|
-
- Provide sample statusline.sh if relevant
|
|
75
|
-
- Include OS and Node.js version
|
|
76
|
-
|
|
77
|
-
### โจ Feature Requests
|
|
78
|
-
- Use GitHub Issues with the feature template
|
|
79
|
-
- Explain the use case
|
|
80
|
-
- Consider implementation complexity
|
|
81
|
-
- Check if it fits the "dead simple" philosophy
|
|
82
|
-
|
|
83
|
-
### ๐ง Code Contributions
|
|
84
|
-
- **New Features**: Discuss in an issue first
|
|
85
|
-
- **Bug Fixes**: Can be submitted directly
|
|
86
|
-
- **Documentation**: Always welcome!
|
|
87
|
-
|
|
88
|
-
## ๐ Code Standards
|
|
89
|
-
|
|
90
|
-
### TypeScript
|
|
91
|
-
- **Strict typing** - All functions must have type hints
|
|
92
|
-
- **ESM modules** - Use import/export syntax
|
|
93
|
-
- **Error handling** - Always handle errors gracefully
|
|
94
|
-
|
|
95
|
-
### Code Style
|
|
96
|
-
- **2 spaces** for indentation
|
|
97
|
-
- **No semicolons** (follows project style)
|
|
98
|
-
- **Descriptive names** - Functions and variables should be self-documenting
|
|
99
|
-
- **Comments** - Only when necessary to explain "why", not "what"
|
|
100
|
-
|
|
101
|
-
### File Structure
|
|
102
|
-
```
|
|
103
|
-
src/
|
|
104
|
-
โโโ cli/ # CLI commands and prompts
|
|
105
|
-
โโโ features/ # Feature-specific code (git, usage, colors)
|
|
106
|
-
โโโ generators/ # Script generators (bash, etc.)
|
|
107
|
-
โโโ utils/ # Utilities (installer, validator, tester)
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
## ๐งช Testing
|
|
111
|
-
|
|
112
|
-
### Manual Testing
|
|
113
|
-
```bash
|
|
114
|
-
# Build and test CLI
|
|
115
|
-
npm run build
|
|
116
|
-
./dist/index.js init --output ./test-statusline.sh --no-install
|
|
117
|
-
|
|
118
|
-
# Test preview functionality
|
|
119
|
-
./dist/index.js preview ./test-statusline.sh
|
|
120
|
-
|
|
121
|
-
# Test with different configurations
|
|
122
|
-
# (Change features in prompts.ts and rebuild)
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
### Adding Tests
|
|
126
|
-
- Test new features in `src/utils/tester.ts`
|
|
127
|
-
- Ensure backwards compatibility
|
|
128
|
-
- Test error conditions
|
|
129
|
-
|
|
130
|
-
## ๐ Documentation
|
|
131
|
-
|
|
132
|
-
### README Updates
|
|
133
|
-
- Keep examples current
|
|
134
|
-
- Update command usage if changed
|
|
135
|
-
- Maintain consistent formatting
|
|
136
|
-
|
|
137
|
-
### Code Documentation
|
|
138
|
-
- Update JSDoc comments for new functions
|
|
139
|
-
- Include parameter and return types
|
|
140
|
-
- Provide usage examples for complex functions
|
|
141
|
-
|
|
142
|
-
## ๐ข Pull Request Process
|
|
143
|
-
|
|
144
|
-
1. **Update documentation** if needed
|
|
145
|
-
2. **Test your changes** thoroughly
|
|
146
|
-
3. **Update CHANGELOG.md** following Keep a Changelog format
|
|
147
|
-
4. **Submit pull request** with clear description
|
|
148
|
-
5. **Address review feedback** promptly
|
|
149
|
-
|
|
150
|
-
### Pull Request Template
|
|
151
|
-
```markdown
|
|
152
|
-
## Description
|
|
153
|
-
Brief description of changes
|
|
154
|
-
|
|
155
|
-
## Type of Change
|
|
156
|
-
- [ ] Bug fix
|
|
157
|
-
- [ ] New feature
|
|
158
|
-
- [ ] Documentation update
|
|
159
|
-
- [ ] Refactoring
|
|
160
|
-
|
|
161
|
-
## Testing
|
|
162
|
-
- [ ] Tested locally
|
|
163
|
-
- [ ] Updated tests if needed
|
|
164
|
-
- [ ] Documentation updated
|
|
165
|
-
|
|
166
|
-
## Checklist
|
|
167
|
-
- [ ] Follows code style
|
|
168
|
-
- [ ] Self-review completed
|
|
169
|
-
- [ ] CHANGELOG.md updated
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
## ๐ค Community Guidelines
|
|
173
|
-
|
|
174
|
-
### Be Respectful
|
|
175
|
-
- Use welcoming and inclusive language
|
|
176
|
-
- Respect different viewpoints and experiences
|
|
177
|
-
- Focus on constructive feedback
|
|
178
|
-
|
|
179
|
-
### Be Helpful
|
|
180
|
-
- Help newcomers get started
|
|
181
|
-
- Share knowledge and best practices
|
|
182
|
-
- Collaborate openly
|
|
183
|
-
|
|
184
|
-
### Keep It Simple
|
|
185
|
-
- Follow the "dead simple" philosophy
|
|
186
|
-
- Avoid over-engineering
|
|
187
|
-
- Prioritize user experience
|
|
188
|
-
|
|
189
|
-
## ๐ Recognition
|
|
190
|
-
|
|
191
|
-
Contributors will be:
|
|
192
|
-
- Listed in CHANGELOG.md for their contributions
|
|
193
|
-
- Mentioned in release notes for significant features
|
|
194
|
-
- Welcomed into the community with appreciation
|
|
195
|
-
|
|
196
|
-
## โ Questions?
|
|
197
|
-
|
|
198
|
-
- **GitHub Issues** - For bugs and feature requests
|
|
199
|
-
- **GitHub Discussions** - For questions and ideas
|
|
200
|
-
- **Email** - chong-u@aioriented.dev for private matters
|
|
201
|
-
|
|
202
|
-
## ๐ License
|
|
203
|
-
|
|
204
|
-
By contributing, you agree that your contributions will be licensed under the MIT License.
|
|
205
|
-
|
|
206
|
-
---
|
|
207
|
-
|
|
1
|
+
# Contributing to cc-statusline
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing to cc-statusline! This document provides guidelines and information for contributors.
|
|
4
|
+
|
|
5
|
+
## ๐ Quick Start
|
|
6
|
+
|
|
7
|
+
1. **Fork the repository** on GitHub
|
|
8
|
+
2. **Clone your fork** locally:
|
|
9
|
+
```bash
|
|
10
|
+
git clone https://github.com/YOUR-USERNAME/cc-statusline.git
|
|
11
|
+
cd cc-statusline
|
|
12
|
+
```
|
|
13
|
+
3. **Install dependencies**:
|
|
14
|
+
```bash
|
|
15
|
+
npm install
|
|
16
|
+
```
|
|
17
|
+
4. **Build the project**:
|
|
18
|
+
```bash
|
|
19
|
+
npm run build
|
|
20
|
+
```
|
|
21
|
+
5. **Test your changes**:
|
|
22
|
+
```bash
|
|
23
|
+
./dist/index.js --help
|
|
24
|
+
npx . init --no-install # Test locally
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## ๐ ๏ธ Development Workflow
|
|
28
|
+
|
|
29
|
+
### Making Changes
|
|
30
|
+
|
|
31
|
+
1. **Create a feature branch**:
|
|
32
|
+
```bash
|
|
33
|
+
git checkout -b feature/amazing-feature
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
2. **Make your changes** following our coding standards
|
|
37
|
+
|
|
38
|
+
3. **Test your changes**:
|
|
39
|
+
```bash
|
|
40
|
+
npm run build
|
|
41
|
+
./dist/index.js preview path/to/statusline.sh
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
4. **Commit your changes**:
|
|
45
|
+
```bash
|
|
46
|
+
git add .
|
|
47
|
+
git commit -m "feat: add amazing feature"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Commit Message Format
|
|
51
|
+
|
|
52
|
+
We follow [Conventional Commits](https://conventionalcommits.org/):
|
|
53
|
+
|
|
54
|
+
- `feat:` - New features
|
|
55
|
+
- `fix:` - Bug fixes
|
|
56
|
+
- `docs:` - Documentation changes
|
|
57
|
+
- `style:` - Code style changes (formatting, etc.)
|
|
58
|
+
- `refactor:` - Code refactoring
|
|
59
|
+
- `test:` - Adding tests
|
|
60
|
+
- `chore:` - Maintenance tasks
|
|
61
|
+
|
|
62
|
+
Examples:
|
|
63
|
+
```
|
|
64
|
+
feat: add support for Python runtime
|
|
65
|
+
fix: resolve preview timeout issue
|
|
66
|
+
docs: update README installation guide
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## ๐ฏ Types of Contributions
|
|
70
|
+
|
|
71
|
+
### ๐ Bug Reports
|
|
72
|
+
- Use GitHub Issues with the bug template
|
|
73
|
+
- Include steps to reproduce
|
|
74
|
+
- Provide sample statusline.sh if relevant
|
|
75
|
+
- Include OS and Node.js version
|
|
76
|
+
|
|
77
|
+
### โจ Feature Requests
|
|
78
|
+
- Use GitHub Issues with the feature template
|
|
79
|
+
- Explain the use case
|
|
80
|
+
- Consider implementation complexity
|
|
81
|
+
- Check if it fits the "dead simple" philosophy
|
|
82
|
+
|
|
83
|
+
### ๐ง Code Contributions
|
|
84
|
+
- **New Features**: Discuss in an issue first
|
|
85
|
+
- **Bug Fixes**: Can be submitted directly
|
|
86
|
+
- **Documentation**: Always welcome!
|
|
87
|
+
|
|
88
|
+
## ๐ Code Standards
|
|
89
|
+
|
|
90
|
+
### TypeScript
|
|
91
|
+
- **Strict typing** - All functions must have type hints
|
|
92
|
+
- **ESM modules** - Use import/export syntax
|
|
93
|
+
- **Error handling** - Always handle errors gracefully
|
|
94
|
+
|
|
95
|
+
### Code Style
|
|
96
|
+
- **2 spaces** for indentation
|
|
97
|
+
- **No semicolons** (follows project style)
|
|
98
|
+
- **Descriptive names** - Functions and variables should be self-documenting
|
|
99
|
+
- **Comments** - Only when necessary to explain "why", not "what"
|
|
100
|
+
|
|
101
|
+
### File Structure
|
|
102
|
+
```
|
|
103
|
+
src/
|
|
104
|
+
โโโ cli/ # CLI commands and prompts
|
|
105
|
+
โโโ features/ # Feature-specific code (git, usage, colors)
|
|
106
|
+
โโโ generators/ # Script generators (bash, etc.)
|
|
107
|
+
โโโ utils/ # Utilities (installer, validator, tester)
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## ๐งช Testing
|
|
111
|
+
|
|
112
|
+
### Manual Testing
|
|
113
|
+
```bash
|
|
114
|
+
# Build and test CLI
|
|
115
|
+
npm run build
|
|
116
|
+
./dist/index.js init --output ./test-statusline.sh --no-install
|
|
117
|
+
|
|
118
|
+
# Test preview functionality
|
|
119
|
+
./dist/index.js preview ./test-statusline.sh
|
|
120
|
+
|
|
121
|
+
# Test with different configurations
|
|
122
|
+
# (Change features in prompts.ts and rebuild)
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Adding Tests
|
|
126
|
+
- Test new features in `src/utils/tester.ts`
|
|
127
|
+
- Ensure backwards compatibility
|
|
128
|
+
- Test error conditions
|
|
129
|
+
|
|
130
|
+
## ๐ Documentation
|
|
131
|
+
|
|
132
|
+
### README Updates
|
|
133
|
+
- Keep examples current
|
|
134
|
+
- Update command usage if changed
|
|
135
|
+
- Maintain consistent formatting
|
|
136
|
+
|
|
137
|
+
### Code Documentation
|
|
138
|
+
- Update JSDoc comments for new functions
|
|
139
|
+
- Include parameter and return types
|
|
140
|
+
- Provide usage examples for complex functions
|
|
141
|
+
|
|
142
|
+
## ๐ข Pull Request Process
|
|
143
|
+
|
|
144
|
+
1. **Update documentation** if needed
|
|
145
|
+
2. **Test your changes** thoroughly
|
|
146
|
+
3. **Update CHANGELOG.md** following Keep a Changelog format
|
|
147
|
+
4. **Submit pull request** with clear description
|
|
148
|
+
5. **Address review feedback** promptly
|
|
149
|
+
|
|
150
|
+
### Pull Request Template
|
|
151
|
+
```markdown
|
|
152
|
+
## Description
|
|
153
|
+
Brief description of changes
|
|
154
|
+
|
|
155
|
+
## Type of Change
|
|
156
|
+
- [ ] Bug fix
|
|
157
|
+
- [ ] New feature
|
|
158
|
+
- [ ] Documentation update
|
|
159
|
+
- [ ] Refactoring
|
|
160
|
+
|
|
161
|
+
## Testing
|
|
162
|
+
- [ ] Tested locally
|
|
163
|
+
- [ ] Updated tests if needed
|
|
164
|
+
- [ ] Documentation updated
|
|
165
|
+
|
|
166
|
+
## Checklist
|
|
167
|
+
- [ ] Follows code style
|
|
168
|
+
- [ ] Self-review completed
|
|
169
|
+
- [ ] CHANGELOG.md updated
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
## ๐ค Community Guidelines
|
|
173
|
+
|
|
174
|
+
### Be Respectful
|
|
175
|
+
- Use welcoming and inclusive language
|
|
176
|
+
- Respect different viewpoints and experiences
|
|
177
|
+
- Focus on constructive feedback
|
|
178
|
+
|
|
179
|
+
### Be Helpful
|
|
180
|
+
- Help newcomers get started
|
|
181
|
+
- Share knowledge and best practices
|
|
182
|
+
- Collaborate openly
|
|
183
|
+
|
|
184
|
+
### Keep It Simple
|
|
185
|
+
- Follow the "dead simple" philosophy
|
|
186
|
+
- Avoid over-engineering
|
|
187
|
+
- Prioritize user experience
|
|
188
|
+
|
|
189
|
+
## ๐ Recognition
|
|
190
|
+
|
|
191
|
+
Contributors will be:
|
|
192
|
+
- Listed in CHANGELOG.md for their contributions
|
|
193
|
+
- Mentioned in release notes for significant features
|
|
194
|
+
- Welcomed into the community with appreciation
|
|
195
|
+
|
|
196
|
+
## โ Questions?
|
|
197
|
+
|
|
198
|
+
- **GitHub Issues** - For bugs and feature requests
|
|
199
|
+
- **GitHub Discussions** - For questions and ideas
|
|
200
|
+
- **Email** - chong-u@aioriented.dev for private matters
|
|
201
|
+
|
|
202
|
+
## ๐ License
|
|
203
|
+
|
|
204
|
+
By contributing, you agree that your contributions will be licensed under the MIT License.
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
208
|
**Thank you for helping make cc-statusline better!** ๐
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 Chong-U Lim (AIOriented)
|
|
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
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Chong-U Lim (AIOriented)
|
|
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
21
|
SOFTWARE.
|