SongTxt README
SongTxt is a simple Visual Studio Code extension that improves the experience around typing in music transcriptions in plain text files. It is built to follow the formatting guidelines used by Ultimate Guitar.
Install
Install the extension from the Visual Studio Marketplace or search for SongTxt from the Extensions pane in Visual Studio Code.
Features
See the list of features and documentation at the SongTxt Wiki.
Screenshot
Known Issues
- The two commands the extension adds currently do nothing other than pop up a notification when executed. More to come soon there as well.
Release Notes
Requirements
Extension Settings
Testing
Currently only grammar/regex tests are maintained.
Prerequisites
npm install
Run Tests
Compile then run the grammar test suite:
npm run compile
npm test
You should see output ending with something like 8 passing (count may grow as new cases are added).
Add More Tests
Edit src/test/suite/grammar.test.ts, add new test(...) blocks, then rerun:
npm test
Lint
npm run lint
Troubleshooting
- If patterns disappear, confirm
syntaxes/songtxt.tmLanguage.json still has the expected repository entries.
- After changing regex order, update indices in the test file or refactor to search by
comment.
Acknowledgments / Open Source
SongTxt is built on and benefits from the wider open source ecosystem:
- Visual Studio Code Extension API – Copyright (c) Microsoft Corporation. Licensed under the MIT License.
- TypeScript – (c) Microsoft Corporation. Apache 2.0.
- Mocha (test framework) – (c) OpenJS Foundation and contributors. MIT.
- ESLint and @typescript-eslint – (c) OpenJS Foundation & Contributors. MIT.
- Node.js type definitions (@types/node) – DefinitelyTyped contributors. MIT.
- VS Code type definitions (@types/vscode) – Microsoft. MIT.
Tab / chord formatting inspiration: Community conventions as documented by Ultimate Guitar contribution rubric.
If you believe additional attribution is required for any component, please open an issue or pull request.
