Commit graph

59 commits

Author SHA1 Message Date
Ganesan Arjuna Maharaja
f9f51480eb correcting the spelling of valid_symbols in indent dedent example 2023-07-29 20:55:33 +05:30
Andrew Hlynskyi
3c806913d8 docs: improve external scanner details and fix conflicting tokens details
* Removed convention notes introduced in #1947 due to:
  * It doesn't so strict for bindings and they may need to obey to some
    target language conventions.
  * For language grammars there is a note that states the same in the
    `Creating Parsers` section.
* Removed `External Scanning` item introduced in 87a0517 commit
  originated from #1612 due to unclear consistency with other
  5 original statements. There is a similar explanation in the
  `Other External Scanner Details` section.
2023-04-16 23:46:21 +03:00
Andrew Hlynskyi
613382c70a docs: update badges; fix markdown lint complains
Linter config `.vscode/settings.json`:
```json
{
    "[markdown]": {
        "files.trimTrailingWhitespace": false,
    },
    "markdownlint.config": {
        "default": true,
        // "ul-style": {
        //     "style": "asterisk"
        // },
        "MD001": false,
        "MD024": false,
        "MD025": false,
        "MD033": false,
        "MD041": false,
        "MD053": false,
    },
}
```
2023-04-16 23:39:08 +03:00
Andrew Hlynskyi
b5e6d18086 docs: add a grammar syntax sample for lexical precedence 2023-04-15 05:10:02 +03:00
Andrew Hlynskyi
bfd56a1e59 docs: remove controversial Earliest Starting Position item added previously by 87a0517 2023-04-15 05:10:02 +03:00
Andrew Hlynskyi
1f051d339c chore(docs): fix misprint repetitions and remove dangling spaces 2023-04-09 20:40:18 +03:00
Andreas Deininger
0751736d17 docs: convert various links to https protocol 2023-04-04 18:05:46 +03:00
Andrew Helwer
278ff01e71 Added additional documentation details
* External scanners and infinite loops
* Terminal keywords in externals array
* Using error sentinel external token
* Good practice to erase state variables in deserialize func
* Emphasize external scanner is called first
2023-01-03 02:48:55 +02:00
Andrew Helwer
87a0517f3c Various updates to Creating Parsers docs
* Documented test separator suffixes
* Documented partial precedences field
* Added external scanning to conflicting tokens rules
* Added earliest starting position to conflicting tokens rules
* Added note about lexical precedence vs. parse precedence
* Added note about tree-sitter calling external scanner with all
  tokens marked valid during error recovery
2023-01-03 02:48:48 +02:00
Andrew Helwer
dddbc2d4f7 Added working commands for Windows users
Windows users are likely to be using either Windows Terminal (which uses PowerShell) or PowerShell directly.
2023-01-02 02:31:06 +02:00
mliszcz
7bf2484d81 Fix test output formatting for rules starting with M/U
Previously the rule names could not begin with an uppercase M or U
because the test output formatter assumed that they represent special
tokens: MISSING or UEXPECTED.

Fixes #1940.
2022-11-15 20:20:44 +01:00
Jonathan Arnett
245e3b0092 Add note about including an external scanner in Rust crate 2022-10-30 23:24:50 -04:00
Max Brunsfeld
3563fe009a Explain in the docs that npm install supports limited platforms 2022-09-02 15:31:21 -07:00
Andrew Helwer
80c34d62ab Fixed rust build, updated docs 2022-01-07 10:36:25 -05:00
Max Brunsfeld
2bee7c9b75 Update get_column docs
Fixes #1405
2021-09-22 13:53:42 -07:00
Andrew Hlynskyi
c1849098f5 chore(docs): Fix getting started example, closes #891 2021-08-27 11:07:49 +03:00
Niklas Mohrin
66cfc05d76
Fix highlighting typo on "creating parsers" site 2021-07-25 14:08:46 +02:00
Jean-Hadrien Chabran
2aa1578f6b Update generated files 2021-06-07 14:33:32 +02:00
Sjoerd Langkemper
103d37adc4 Fix typo: lanugage -> language 2021-03-23 16:42:07 +01:00
François Wouts
b7f99d45f0
Revert back to 2.5.0 to minimise changes 2021-02-24 07:56:26 +11:00
François Wouts
86d4be4ea7
Link to Ruby 3 docs instead 2021-02-24 07:55:48 +11:00
François Wouts
9437973b3e
Fix broken link to Ruby's Percent Strings
The current link fails with a 404.
2021-02-24 07:52:24 +11:00
Max Brunsfeld
d12b874a48
Merge pull request #735 from Vehmloewff/patch-1
Add documentation for `token.immediate`
2020-11-03 11:55:12 -08:00
Patrick Thomson
9f9f2a52b7 Docs. 2020-09-29 12:59:05 -04:00
Elijah Mooring
43a3f1bbe0
Update section-3-creating-parsers.md 2020-09-19 11:19:26 -05:00
Max Brunsfeld
4ec7d80968 Mention rule order as the fallback criteria in docs
Fixes #702
2020-07-29 10:04:21 -07:00
Max Brunsfeld
e9ea8192a3 Mention node version >= 6 in docs
Fixes #677
2020-07-09 09:11:38 -07:00
Santos Gallegos
9b9329cb6c
Fix some typos (#639) 2020-06-06 15:17:38 -07:00
Mohamed Al-Fahim
67cd6b3d97
Grammar fix (#631) 2020-05-30 10:57:44 -07:00
Max Brunsfeld
f1e4104d47 Document supertypes and the node-types file
References #542
References #524
Closes #393
2020-02-24 11:12:42 -08:00
Max Brunsfeld
8d26da7b03 Add highlight subcommand to docs section w/ all subcommands 2020-02-21 13:11:40 -08:00
Max Brunsfeld
a76a232485 Add unit testing docs 2020-02-21 12:58:41 -08:00
akiyosi
1742f32fcc Fix link to contributing docs 2019-11-28 22:07:32 +09:00
Max Brunsfeld
a506ceec3f Link to contributing docs from installation section of docs
Refs #478
2019-11-04 12:50:43 -08:00
Matthew Krupcale
5ae89f5133 docs: fix lookahead type (#462)
The `TSLexer` struct uses signed integer `int32_t` for the `lookahead` Unicode code point.

 * docs/section-3-creating-parsers.md: fix `lookahead` type
2019-10-14 12:08:24 -07:00
Max Brunsfeld
f9a3998029 docs: Start adding info about field names 2019-09-05 15:43:10 -07:00
Simon Repp
ee253e340b Mention differing alias behavior based on argument types in the docs (#405)
* Fix broken link to named-vs-anonymous section in unit tests section

* Mention differing alias behavior based on argument types in the docs
2019-08-01 15:30:50 -07:00
Max Brunsfeld
5035e194ff Merge branch 'master' into node-fields 2019-03-26 11:58:21 -07:00
Justin Woo
6f804fd2e2 fix example snippet in creating parsers docs 2019-03-24 14:37:43 +02:00
Jacob Mitchell
c8d040ca26 Use 1-indexed rows in CLI and log output (resolves #287) 2019-03-14 22:21:19 -07:00
Max Brunsfeld
f52271352b Merge branch 'master' into node-fields 2019-03-05 08:08:05 -08:00
Max Brunsfeld
92e9f984ed Fix small docs errors 2019-02-22 09:44:25 -08:00
Max Brunsfeld
190b219be5 Document external scanners
Fixes #281
2019-02-22 09:35:29 -08:00
Max Brunsfeld
2249ddb687 docs: Adjust intro, remove mentions of node-gyp, npm install 2019-02-21 16:41:52 -08:00
Tobias Bieniek
1602e9f06a
docs: Add missing ) to test code 2018-11-02 14:33:12 +01:00
Max Brunsfeld
7661d08127 Flesh out keyword extraction discussion 2018-09-09 18:47:31 -07:00
Max Brunsfeld
07065e3580 Mention lexical conflict resolution w/ strings vs regexes 2018-09-09 18:47:31 -07:00
Max Brunsfeld
a4383d17d1 Reference named/anonymous node section when explaining test s-exps 2018-09-09 18:47:31 -07:00
Max Brunsfeld
d6cc98c644 Remove leading $ from shell code blocks 2018-09-09 18:47:31 -07:00
Max Brunsfeld
b0fb31dc5f Recommend using npm init/npm install to generate the package.json 2018-09-09 18:47:30 -07:00