branch: elpa/typst-ts-mode
commit 3f5dba69fd30a555d2a3f5508d54af7cf58f39d3
Author: Meow King <mr.meowk...@anche.no>
Commit: Meow King <mr.meowk...@anche.no>
doc: README
---
README.md | 146 ++------------------------------------------------
highlight.compare.scm | 79 ---------------------------
2 files changed, 5 insertions(+), 220 deletions(-)
diff --git a/README.md b/README.md
index 8ad2601200..95934f52ff 100644
--- a/README.md
+++ b/README.md
@@ -1,154 +1,18 @@
# Typst Tree-Sitter Mode
-**NOTE** This package is migrated to
[codeberg](https://codeberg.org/meow_king/typst-ts-mode)
+> This package is migrated to
[codeberg](https://codeberg.org/meow_king/typst-ts-mode)
+>
+> The mirror of this package on other git forges like SourceHut or GitHub may
not be updated or updated less frequently.
-The mirror of this package on other git forges like SourceHut or GitHub may
not be updated or updated less frequently.
+Tree Sitter support for [Typst](https://github.com/typst/typst). Minimum Emacs
version requirement: 29.
-Tree Sitter support for Typst. Minimum Emacs version requirement: 29.
-
-## Installation
-
-See [wiki](https://codeberg.org/meow_king/typst-ts-mode/wiki/Installation)
-
-
-(Document is currently under construction)
-
-## Keys
-
-**C-c C-c c** : **typst-ts-compile-and-preview**
-**C-c C-c C** : **typst-ts-compile**
-**C-c C-c w** : **typst-ts-watch-mode**
-**C-c C-c p** : **typst-ts-mode-preview**
-**M-\<left\>** : **typst-ts-mode-heading-decrease**
-**M-\<right\>** : **typst-ts-mode-heading-increase**
-**M-\<up\>** : **typst-ts-mode-heading-up**
-**M-\<down\>** : **typst-ts-mode-heading-down**
-**M-\<return\>**: **typst-ts-mode-meta-return**
-**\<return\>** : **typst-ts-mode-return**
-**TAB** : **typst-ts-mode-cycle**
-**C-c '** : **typst-ts-edit-indirect** (requires
<https://github.com/Fanael/edit-indirect/>)
-
-*NOTE*: `outline-minor-mode` is enabled by `typst-ts-mode`, so you can use
command
-defined by `outline-minor-mode` such as `outline-cycle`.
-
-## Customization Options
-
-You can view all the custom options in Emacs using `customize` command. Go to
`typst-ts` group.
-
-Here are some options you may find useful:
-1. **typst-ts-mode-indent-offset** (default 4)
- If you want to have `org-indent-mode` like behavior, you can use
[outline-indent-mode](https://sr.ht/~meow_king/outline-indent-mode/) plugin.
-2. **typst-ts-compile-executable-location**
- You can set a custom typst executable location.
-3. **typst-ts-watch-options**.
- Set this to `--open` so typst will automatically open the compiled file for
you when you enter `typst-ts-watch-mode`.
-4. **typst-ts-compile-options**.
- Note that setting `--open` has no use for this customization variable. You
can execute command `async-shell-command` and input `typst compile <file>
--open && sleep 1` to view what is happening. Use command
`typst-ts-compile-and-preview` if you want to view the output document after
compiling.
-5. **typst-ts-watch-auto-display-compilation-error**. (default `t`)
- This variable controls whether `typst watch` process buffer will appear
when an error occurs, and disappear when there is no error.
- You may find `auto-save-visited-mode`,
[auto-save](https://github.com/manateelazycat/auto-save) or
[super-save](https://github.com/bbatsov/super-save) useful (or annoying).
-6. **typst-ts-compile-before-compilation-hook** and
**typst-ts-compile-after-compilation-hook**
-7. **typst-ts-mode-grammar-location**: used for grammar version check at major
mode start. Note it only check and compare the grammar file modification date.
-
-### Fontification
-1. **typst-ts-mode-fontification-precise-level** (default `'middle`)
- Available values: `min`, `middle` and `max`. Different level affects the
precision
- of the fontification. For example, to fontify `- item`, we may fontify the
whole expression
- using one face, or two faces (one for `-`, and one for `item`). Note it is
related to the performance of fontification process, especially the first
fontification process (when you open the file).
-2. **typst-ts-markup-header-same-height** and **typst-ts-markup-header-scale**
- Control header height. Note that it only works when
**typst-ts-mode-fontification-precise-level**
- is set to `max`.
-3. Override default font lock rules
- Please see the documentation of **typst-ts-mode-font-lock-rules**, you can
find
- how to override the whole font lock rules or only small part of the font
lock
- rules.
-
-### Raw block highlighting
-_This is an experimental feature_
-Only support tree-sitter languages.
-**Note**: Currently only support Emacs 30 (master branch). But non-treesit
font lock for raw block feature will be added soon (both 29 and 30).
-For more detailed documentation about raw block highlighting see
-[this documentation](./doc/raw-block-highlighing.md)
-1. **typst-ts-mode-enable-raw-blocks-highlight** (default `nil`)
-2. **typst-ts-mode-highlight-raw-blocks-at-startup** (default `nil`)
-3. **typst-ts-highlight-raw-block-langs-not-in-predefined-settings** (default
`t`)
-
-### Consult Imenu Integration
-If you use `consult-iemnu`
-command [consult](https://github.com/minad/consult), you way want this setting.
-``` emacs-lisp
-(setq
- consult-imenu-config
- (append consult-imenu-config
- '((typst-ts-mode :topLevel "Headings" :types
- ((?h "Headings" typst-ts-markup-header-face)
- (?f "Functions" font-lock-function-name-face))))))
-```
+[Wiki](https://codeberg.org/meow_king/typst-ts-mode/wiki/)
## Related Packages
+ [outline-indent-mode](https://sr.ht/~meow_king/outline-indent-mode/) Dynamic
indentation based on outline
+ [tip](https://git.sr.ht/~mafty/tip) Typst Inline Preview
-## Contribute
-
-Please work on `develop` branch, which will be combined into `main` branch
every one week or so if there are new commits.
-This document [./side/sync_with_upstream.typ](./side/sync_with_upstream.typ)
shows information related to synchronous status with upstream grammar.
-
-### Tree Sitter Resources
-1. `(info "(elisp) Parser-based Font Lock")` and `(info "(elisp) Parsing
Program Source")` (Use `eval-expression` command to jump to the corresponding
Info Manual Node)
-2. [Let’s Write a Tree-Sitter Major Mode - Matering
Emacs](https://www.masteringemacs.org/article/lets-write-a-treesitter-major-mode)
-3. [ts-query-highlight](https://sr.ht/~meow_king/ts-query-highlight/). I wrote
this package to highlight tree sitter queries. This package is used in the
process of building `typst-ts-mode`.
-4. All common treesit operations can be viewd using command `shortdoc`
-
-### Package Development
-
-#### How to load all files used by this packages?
-This snippet is taken from [The Emacs Package Developer’s Handbook -
Byte-compile and load
directory](https://github.com/alphapapa/emacs-package-dev-handbook?tab=readme-ov-file#byte-compile-and-load-directory)
with some modification.
-
-```emacs-lisp
-(defun others/byte-compile-and-load-directory (directory)
- "Byte-compile and load all elisp files in DIRECTORY.
-Interactively, directory defaults to `default-directory' and asks
-for confirmation."
- (interactive (list default-directory))
- (let* ((load-path (cons directory load-path))
- (files (directory-files directory 't (rx ".el" eos))))
- (dolist (file files)
- (byte-compile-file file 'load))))
-```
-#### How to eval a buffer and override the origin definitions
-You can use `eval-defun` to eval and override a function definition. However,
to eval and override a buffer, `eval-buffer` doesn't work.
-This snippet is taken from [How do I force re-evaluation of a defvar? -
François Févotte -
emacs.stackexchange.com](https://emacs.stackexchange.com/a/2302) with some
modification.
-
-```emacs-lisp
-(defun others/eval-buffer ()
-"Execute the current buffer as Lisp code.
-Top-level forms are evaluated with `eval-defun' so that `defvar'
-and `defcustom' forms reset their default values."
- (interactive)
- (save-excursion
- (goto-char (point-min))
- (while (not (eobp))
- (forward-sexp)
- (eval-defun nil))))
-```
-
-### How to use different version of Emacs to test
-
-``` shell
-# change `emacs` to `emacs29`, `emacs30` or the path of your emacs executable
-emacs -Q -L . --eval "(require 'typst-ts-mode)"
-```
-
-#### How to do lint
-I recommend you to use [makem.sh](https://github.com/alphapapa/makem.sh).
However, you can choose anything you like.
-To use it, first `cd` into the project root directory, then:
-```emacs-lisp
-wget https://raw.githubusercontent.com/alphapapa/makem.sh/master/makem.sh
-chmod +x ./makem.sh
-```
-To do `lint`, you can execute shell command `./makem.sh lint`
## Co-Maintainer
diff --git a/highlight.compare.scm b/highlight.compare.scm
deleted file mode 100644
index 969f1bb231..0000000000
--- a/highlight.compare.scm
+++ /dev/null
@@ -1,79 +0,0 @@
-(call ;; DONE code
- item: (ident) @function)
-(call ;; DONE code
- item: (field field: (ident) @function.method))
-(tagged field: (ident) @tag) ;; DONE code
-(field field: (ident) @tag) ;; DONE code
-(comment) @comment ;; DONE code
-
-; CONTROL
-(let "let" @keyword.storage.type) ;; DONE code
-(branch ["if" "else"] @keyword.control.conditional) ;; DONE code
-(while "while" @keyword.control.repeat) ;; DONE code
-(for ["for" "in"] @keyword.control.repeat) ;; DONE code
-(import "import" @keyword.control.import) ;; DONE code
-(as "as" @keyword.operator) ;; DONE code
-(include "include" @keyword.control.import) ;; DONE code
-(show "show" @keyword.control) ;; DONE code
-(set "set" @keyword.control) ;; DONE code
-(return "return" @keyword.control) ;; DONE code
-(flow ["break" "continue"] @keyword.control) ;; DONE code
-
-; OPERATOR
-(in ["in" "not"] @keyword.operator) ;; DONE code
-(and "and" @keyword.operator) ;; DONE code
-(or "or" @keyword.operator) ;; DONE code
-(not "not" @keyword.operator) ;; DONE code
-(sign ["+" "-"] @operator) ;; DONE code
-(add "+" @operator) ;; DONE code
-(sub "-" @operator) ;; DONE code
-(mul "*" @operator) ;; DONE code
-(div "/" @operator) ;; DONE code
-(cmp ["==" "<=" ">=" "!=" "<" ">"] @operator) ;; DONE code
-(fraction "/" @operator) ;; DONE math
-(fac "!" @operator) ;; DONE math
-(attach ["^" "_"] @operator) ;; DONE math
-(wildcard) @operator ;; DONE code
-
-; VALUE
-(raw_blck "```" @operator) @markup.raw.block ;; DONE markup
-(raw_span "`" @operator) @markup.raw.block ;; DONE markup
-(raw_blck lang: (ident) @tag) ;; DONE markup
-(label) @tag ;; DONE markup
-(ref) @tag ;; DONE markup
-(number) @constant.numeric ;; DONE code
-(string) @string ;; DONE code
-(content ["[" "]"] @operator) ;; DONE code
-(bool) @constant.builtin.boolean ;; DONE code
-(builtin) @constant.builtin code ;; DONE code
-(none) @constant.builtin code ;; DONE code
-(auto) @constant.builtin ;; DONE code
-(ident) @variable ;; DONE code
-(call
- item: (builtin) @function.builtin)
-
-; MARKUP
-(item "item" @operator) ;; DONE markup
-(term ["item" ":"] @operator) ;; DONE markup
-(heading) @markup.heading ;; DONE markup
-(url) @tag ;; DONE markup
-(emph "_" @operator) @markup.italic ;; DONE markup
-(strong "*" @operator) @markup.bold ;; DONE markup
-(item) @markup.list ;; DONE markup
-(term) @markup.list ;; DONE markup
-(symbol) @constant.character ;; DONE math
-(shorthand) @constant.builtin ;; DONE common
-(quote) @markup.quote ;; DONE markup
-(align) @operator ;; DONE math
-(letter) @constant.character ;; DONE math
-(linebreak) @constant.builtin ;; DONE markup
-
-(math "$" @operator) ;; DONE math
-"#" @operator ;; DONE code
-"end" @operator ;; DONE code
-
-(escape) @constant.character.escape ;; DONE markup
-["(" ")" "{" "}"] @ponctuation.bracket ;; DONE
-["," ";" ".." ":" "sep"] @ponctuation.delimiter ;; DONE
-"assign" @ponctuation ;; DONE
-(field "." @ponctuation) ;; DONE
