[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/csharp-mode cb1b16f 417/459: Add some more documentatio
From: |
ELPA Syncer |
Subject: |
[elpa] externals/csharp-mode cb1b16f 417/459: Add some more documentation on tree-sitter support |
Date: |
Sun, 22 Aug 2021 14:00:13 -0400 (EDT) |
branch: externals/csharp-mode
commit cb1b16f6922709d919e4097453af64d221ffcae9
Author: Theodor Thornhill <theo@thornhill.no>
Commit: Theodor Thornhill <theo@thornhill.no>
Add some more documentation on tree-sitter support
---
README.org | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/README.org b/README.org
index dc3bb23..d3fdd23 100644
--- a/README.org
+++ b/README.org
@@ -31,6 +31,28 @@ You can enable experimental tree sitter support for
indentation and highlighting
#+end_src
If you are using this, clearly state so if you find any issues.
+Note that we don't depend on tree-sitter yet, so you have to manually install
+the packages involved. The simplest way is to use the provided snippet above.
+
+*** Using and evolving the tree-sitter functionality.
+=tree-sitter= introduces a minor mode called =tree-sitter-debug-mode= where
you can
+look at the actual syntax tree it produces. If and when you spot missing or
+wrong syntax highlighting, look at how the patterns are written in
+=csharp-tree-sitter-mode.el=, then submit a pr with a couple new ones added.
When
+testing and debugging this, it is actually as simple as =M-x eval-buffer= on
+=csharp-tree-sitter-mode.el=, then =M-x revert-buffer= in the file you are
testing.
+It should update and show the correct syntax highlighting.
+
+
+So the development cycle is:
+- Spot missing syntax highlighting
+- View AST with =tree-sitter-debug-mode=
+- Locate offending part
+- Add new pattern
+- =M-x eval-buffer= in =csharp-tree-sitter-mode.el=
+- =M-x revert-buffer= inside your =some-test-file.cs=
+
+
** Usage
This package is currently available on MELPA. Install using ~M-x
- [elpa] externals/csharp-mode 4eeccbd 402/459: Remove newly added tests, (continued)
- [elpa] externals/csharp-mode 4eeccbd 402/459: Remove newly added tests, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 1e37eaf 407/459: Add dependency to tree-sitter-indent, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 00a3cd4 410/459: Add new url to csharp-tree-sitter.el, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 91d5161 414/459: Minor fix after version 0.11.0 (#209), ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 8466428 413/459: Version bump to 0.11.0, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 84ff0d0 415/459: Typo from PR-209., ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 74644d4 416/459: Merge pull request #210 from emacs-csharp/minor, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode d3b5b18 419/459: Ensure langs package for tree-sitter support (#214), ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode da26eb6 420/459: Add mode map and syntax table to tree-sitter, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode a402402 421/459: Add lock_statement, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode cb1b16f 417/459: Add some more documentation on tree-sitter support,
ELPA Syncer <=
- [elpa] externals/csharp-mode cd39e53 423/459: Extract compilation support to its own module (#223), ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 57055a7 426/459: Add qualified name to method_declaration, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 03b8284 428/459: Add type constraints and lambda support, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 6f0bf6b 430/459: Add escape_sequence to strings, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 3f963c2 432/459: Make type_of_expression available in strings, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 61e1305 431/459: Indent constructor initializer, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 0e26b88 433/459: Update readme with :ensure t, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode cb2404f 434/459: Correctly handle implicit types in for_each_statement, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 09b4d57 437/459: Add comment-start-skip, ELPA Syncer, 2021/08/22
- [elpa] externals/csharp-mode 254b91b 439/459: Fix parse and sigabort errors on latest tree-sitter, ELPA Syncer, 2021/08/22