From 81b5d52c8ca2a2bcc7190db3fc7325bb18f4b532 Mon Sep 17 00:00:00 2001 From: Shibo Lyu Date: Thu, 3 Nov 2022 16:45:19 +0000 Subject: [PATCH] doc: Update to reflect `tree-sitter` related changes. --- CHANGELOG.md | 8 ++++++++ README.md | 13 ++++++++++--- build_scripts/README.md | 11 +++++++---- 3 files changed, 25 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c27dd7..2ca6ec9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +# v0.2.0 + +- 🌲 **`tree-sitter`-based syntax highlighting and folding**, powered by + [`Himujjal/tree-sitter-svelte`](https://github.com/Himujjal/tree-sitter-svelte). + - `tree-sitter` support requires **Nova 10**. Older Nova versions will still + use only RegEx-based highlighting. +- Updated Svelte Language Server to `0.14.37`. + # v0.1.8 - Updated Svelte Language Server to `0.14.29`. diff --git a/README.md b/README.md index 7a0759d..c969c9a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ # Svelte Nova -Svelte support for Nova. +Svelte support for Nova, with `tree-sitter`-based syntax highlighting and +language server support. -Needs `node` installed for starting [Svelte Language Server](https://github.com/sveltejs/language-tools/tree/master/packages/language-server). +Needs `node` installed for starting +[Svelte Language Server](https://github.com/sveltejs/language-tools/tree/master/packages/language-server). -Inspired by & took code pieces from [`nova-vue`](https://github.com/tommasongr/nova-vue) and [`nova-typescript`](https://github.com/apexskier/nova-typescript). +Inspired by & took code pieces from +[`nova-vue`](https://github.com/tommasongr/nova-vue) and +[`nova-typescript`](https://github.com/apexskier/nova-typescript). + +For Nova 10 & up, this extension is using `tree-sitter` grammar from +[`Himujjal/tree-sitter-svelte`](https://github.com/Himujjal/tree-sitter-svelte). Thanks for Svelte team & Panic for delivering their masterpieces! diff --git a/build_scripts/README.md b/build_scripts/README.md index e6c061c..176087f 100644 --- a/build_scripts/README.md +++ b/build_scripts/README.md @@ -5,12 +5,15 @@ Both `compile_parser.sh` and `Makefile` are provided by Panic and may be retrieved from [here](https://docs.nova.app/syntax-reference/build_script.zip). -Run `build_parser.sh` (from project root) to build the -`tree-sitter-svelte.dylib`: +Assuming you have Nova.app installed at `/Applications/Nova.app`, run +`yarn build:tree-sitter` to build `libtree-sitter-svelte.dylib`. This command is +also included in `yarn build`. + +If you installed Nova.app elsewhere, run `build_parser.sh` (from project root) +to build, specifying the path to Nova.app as the first argument: ```sh ./build_scripts/build_parser.sh /Applications/Nova.app ``` -You may need to adjust the path to `Nova.app`. It will also copy the build -output to correct place and cleanup temp files. +It will also copy the build output to correct place and cleanup temp files.