Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SpyglassMC/Spyglass
Development tools for vanilla Minecraft: Java Edition data pack developers.
https://github.com/SpyglassMC/Spyglass
datapack language-server lsp mcfunction minecraft
Last synced: 2 months ago
JSON representation
Development tools for vanilla Minecraft: Java Edition data pack developers.
- Host: GitHub
- URL: https://github.com/SpyglassMC/Spyglass
- Owner: SpyglassMC
- License: mit
- Created: 2019-07-15T04:26:05.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T14:48:46.000Z (3 months ago)
- Last Synced: 2024-11-11T07:07:15.721Z (2 months ago)
- Topics: datapack, language-server, lsp, mcfunction, minecraft
- Language: TypeScript
- Homepage: https://spyglassmc.com
- Size: 34.4 MB
- Stars: 315
- Watchers: 9
- Forks: 32
- Open Issues: 184
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
🚧 Under Heavy Construction 🚧
This project is undergoing a complete rewrite. We're almost there.
For the legacy VS Code extension known as [Data-pack Helper Plus](https://marketplace.visualstudio.com/items?itemName=SPGoding.datapack-language-server), check out
* [Branch `release/3.3.0`](https://github.com/SpyglassMC/Spyglass/tree/release/3.3.0) for server-side code;
* [SpyglassMC/vscode-extension](https://github.com/SpyglassMC/vscode-datapack/tree/release/3.3.0) for client-side code;
* [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=SPGoding.datapack-language-server) for use.
# Spyglass
Spyglass aims at improving users' editing experience of Minecraft data packs by providing IntelliSense features like
real-time error reporting, auto-completion, semantic coloring, code navigation tools, and refactor utilities.
 \
_Sample image is from the legacy version of the project_
## Documentation
WIP at https://spyglassmc.com.
## Contributing
1. ```shell
$ git clone https://github.com/SpyglassMC/Spyglass.git
```
2. Install [Node.js LTS](https://nodejs.org/en/).
3. ```shell
$ npm i && npm run build
```
If you're using VS Code to develop Spyglass:
- Install the recommended [ESLint extension][eslint-extension]. Make a copy of `.vscode/settings.template.json` and rename it to `.vscode/settings.json`.
Now your VS Code should automatically fix all linting errors every time you save the file.
- Press F5 to run the VS Code extension in development environment (`Launch Client`). VS Code will automatically compile all packages and build the extension file in watch mode.
Or if you prefer the command line interface:
- `npm run build` to build all packages.
- `npm run watch` to watch changes and build all packages.
- `npm run clean` to remove all js output. Use this when there seem to be caching issues with TypeScript's compiler.
- `npm test` to test all packages.
- `npm run lint` to check linting errors.
- `npm run lint:fix` to fix all auto-fixable linting errors.
- `npm run commit` to run the [`gitmoji` CLI][gitmoji]. You actually don't have to worry about commit message as long as you're creating PR, as I can always change it.
Please refrain from using `mocha --watch`, as it might interface with and break the snapshot testing.
You can debug tests with breakpoints by running the `Run Unit Tests` configuration and setting your breakpoints accordingly. If you want to run a specific subset of tests, add `.only` after the test block (e.g. `describe.only()`, `it.only()`).
Note that the build will fail in CICD if `.only` tests are pushed to prevent mistakenly merging `.only` to `main` (it should only be used for local testing!).
### Code style
Tabs for indents, spaces for alignment. Except do not align things because the available tooling is unfortunately terrible.
### Test docs locally
1. Install Jekyll according to [its documentation](https://jekyllrb.com/docs/#instructions).
2. Run `npm run docs:start` to start a local preview at `localhost:4000`.
### Build Pipeline
The `build` script at the root level does the following steps in series:
* Run the `build` script in `./packages/locales`.
* Run the TypeScript compiler across all packages.
* Then, do the two steps in parallel:
1. Run the `build` script in `./packages/playground`.
2. Run the `build` script in `./packages/vscode-extension`.
### Module system
The whole Spyglass project, including its source code and output, uses ES module.
However, as VS Code cannot consume ES modules as extensions ([microsoft/vscode#130367](https://github.com/microsoft/vscode/issues/130367)),
the `vscode-extension` package defaults to use CommonJS modules, with file extensions `mjs` and `mts` to explicitly override that,
## Credits
The original Spyglass logo was provided by [BlackNight0315](https://github.com/BlackNight0315).
The current logo is provided by [asd988](https://github.com/asd988).
[eslint-extension]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint