ivuorinen/tree-sitter-shellspec
1
0
Fork 0
mirror of https://github.com/ivuorinen/tree-sitter-shellspec.git synced 2026-01-26 11:43:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve documentation and memory files

Browse Source 
- Update CONTRIBUTING.md code style check commands with actual available scripts
- Use npx tree-sitter in test examples to avoid assuming global installation
- Improve project status memory file with proper JSON formatting
- Add CI enforcement recommendation for zero-conflict grammar generation
- Align prerequisites with CI requirements (Node 22+)
This commit is contained in:
Ismo Vuorinen
2025-12-11 19:28:15 +02:00
parent a26f726351
commit 5bc95f0bcd
2 changed files with 23 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -149,11 +149,11 @@ ShellSpec code here
npm test
# Test specific patterns
tree-sitter test --filter "describe_blocks"
tree-sitter test --filter "real_world_patterns"
npx tree-sitter test --filter "describe_blocks"
npx tree-sitter test --filter "real_world_patterns"
# Test with debug output
tree-sitter test --debug
npx tree-sitter test --debug
```
### Test Coverage Requirements
@@ -200,7 +200,7 @@ tree-sitter test --debug
### Before Submitting
1. **Ensure all tests pass:** `npm test`
2. **Check code style:** `npm run lint && npm run format:check`
2. **Check code style:** `npm run lint && npm run lint:editorconfig && npm run lint:markdown`
3. **Update documentation** if needed
4. **Test with real ShellSpec files** when possible
5. **Run the full development cycle:** `npm run rebuild`