Skip to content

Commit 0fbb7b4

Browse files
committed
docs: fix incorrect --check-plugin references
The --check-plugin flag is for TypeScript/JavaScript plugins only, not for language packs. It checks if a plugin can be bundled/transpiled. For language packs, validation is done via: - ./validate.sh (package.json schema) - Installing locally and checking logs (grammar compatibility) Removed misleading --check-plugin references from language pack docs.
1 parent 62a0480 commit 0fbb7b4

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

docs/plugins/development/language-packs.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -179,9 +179,8 @@ Before writing a grammar from scratch, search online for existing Sublime Text o
179179
- Standalone grammars from Package Control that don't use `extends`
180180

181181
**To test compatibility:**
182-
```bash
183-
fresh --check-plugin /path/to/your-language-pack
184-
```
182+
183+
Try installing your language pack locally (see Testing section below) and check the logs for parse errors.
185184

186185
If you find a grammar that uses `extends`, you'll need to either:
187186
1. Find an alternative standalone grammar
@@ -323,8 +322,8 @@ Always validate your package before publishing:
323322
# Validate package.json schema
324323
./validate.sh
325324

326-
# Check grammar compatibility
327-
fresh --check-plugin /path/to/your-language-pack
325+
# Test by installing locally and checking logs
326+
# (see Troubleshooting section for log commands)
328327
```
329328

330329
## Troubleshooting
@@ -335,15 +334,14 @@ fresh --check-plugin /path/to/your-language-pack
335334
# Show log locations
336335
fresh --show-paths
337336

338-
# View Fresh logs
337+
# View Fresh logs (check for grammar parse errors)
339338
tail -f ~/.local/state/fresh/logs/fresh-*.log
340339

341340
# Check LSP logs
342341
tail -f ~/.local/state/fresh/logs/lsp/<language>-*.log
343342

344-
# Validate package
343+
# Validate package.json
345344
./validate.sh
346-
fresh --check-plugin /path/to/your-language-pack
347345
```
348346

349347
### Common Issues

0 commit comments

Comments
 (0)