https://github.com/savetheclocktower/pulsar-ide-json
Rich language support for JSON files in Pulsar
https://github.com/savetheclocktower/pulsar-ide-json
Last synced: 8 months ago
JSON representation
Rich language support for JSON files in Pulsar
- Host: GitHub
- URL: https://github.com/savetheclocktower/pulsar-ide-json
- Owner: savetheclocktower
- License: mit
- Created: 2025-06-22T04:56:00.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-05T01:13:50.000Z (12 months ago)
- Last Synced: 2025-10-07T07:34:51.054Z (9 months ago)
- Language: JavaScript
- Size: 119 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# pulsar-ide-json
Rich language support for JSON files in Pulsar. Uses [vscode-langservers-extracted](https://www.npmjs.com/package/vscode-langservers-extracted).
## Features
* Code completion (via `autocomplete-plus`) for JSON properties and values based on the document’s [JSON schema](https://json-schema.org/) or based on existing properties/values used at other places in the document. JSON Schemas for some common types of JSON files are included; others can be configured.
* Document symbol resolution (via `symbols-view`) for JSON properties in the document.
* Hover (via `pulsar-hover`) for rich tooltip content based on descriptions in the document’s JSON schema.
* Code formatting (via `pulsar-code-format`) — able to format specific ranges or the entire document.
* Jump-to-declaration support (via `symbols-view`) for `$ref` references in JSON schemas.
## TODO
* Validation (i.e., diagnostics) doesn’t seem to work yet.
## Configuration
### Node path
> [!TIP]
> Soon `pulsar-ide-json` will be able to use Pulsar’s built-in version of Node. For now, though, the built-in version is too old; you’ll have to tell the language server the path to your local version of Node.
The version of Node inherited from your shell environment will usually suffice; if Pulsar fails to find it, you may specify the absolute path to your version of `node` in the “Path To Node Binary” configuration field.
### JSON schemas
#### Builtin schemas
Several common schemas are included out of the box:
* `tsconfig.json` and `jsconfig.json` (TypeScript configuration)
* `package.json` (NPM metadata file)
* `schema.json` (JSON Schema meta-schema)
#### Explicit schemas
An explicit `$schema` property at the root of a JSON file will be used as the document’s schema if its value is either an `http`/`https` URL or a `file` URL that refers to an absolute path on disk.
#### Custom schemas
Other JSON schemas can be added — not through the settings UI, but via your `config.cson`. For each new JSON schema you want to add, create a new object property like so:
```coffeescript
"*":
"pulsar-ide-json":
jsonSchemas:
eslintrc:
fileMatch: [".eslintrc", ".eslintrc.json"],
uri: "https://www.schemastore.org/eslintrc.json"
```
The key (`"eslintrc"` in the example above) is not used for anything, but it should be somewhat unique from other keys to avoid collisions. As for the properties:
* `fileMatch` should be an array of glob-like patterns to match against files.
* `uri` should have either an `http`/`https` scheme or a `file` scheme; in the latter case, it should point to an absolute path on disk. ~~It can also start with a relative path on disk, in which case it will be resolved relative to the project root (TODO).~~
You can also define project-specific schemas with the help of a package like [atomic-management][] or [project-config][].
[atomic-management]: https://web.pulsar-edit.dev/packages/atomic-management
[project-config]: https://web.pulsar-edit.dev/packages/project-config