From d59f950005e33e5c5b0f39e0983938531da1d67d Mon Sep 17 00:00:00 2001 From: Amaan Qureshi Date: Wed, 21 Feb 2024 19:45:18 -0500 Subject: [PATCH] docs: add GitHub user and PR info to the changelog --- CHANGELOG.md | 135 +++++++++++++++++++++++----------------------- script/cliff.toml | 12 ++++- 2 files changed, 76 insertions(+), 71 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c7ebcb3..6a7b77a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,94 +4,91 @@ ### Breaking -- Remove the apply-all-captures flag, make last-wins precedence the default for queries +- Remove the apply-all-captures flag, make last-wins precedence the default _by_ @amaanq - **NOTE**: This change might cause breakage in your grammar's highlight tests. Just - flip the order around of the relevant queries, and keep in mind that the last - query that matches will win. + **NOTE**: This change might cause breakage in your grammar's highlight tests. + Just flip the order around of the relevant queries, and keep in mind that the + last query that matches will win. ### Bug Fixes -- Prettify xml output and add node position info -- Inherited grammar generation -- Properly error out when the word property is an invalid rule -- Update schema for regex flags -- Properly handle `Query.matches` when filtering out results -- Sexp format edge case with quoted closed parenthesis -- Always push the default files if there's no `externals` -- Don't log NUL characters -- Don't throw an error if the user uses `map` in the grammar -- Remove redundant imports -- **cli**: Installation via a HTTP tunnel proxy -- **cli**: Don't update tests automatically if parse errors are detected -- **cli**: Don't use `long` for `grammar_path` -- **test**: Allow writing updates to tests without erroneous nodes instead of denying - all of them if a single error is found -- **test**: Edge case when parsing `UNEXPECTED`/`MISSING` nodes with an indentation - level greater than 0 -- **wasm**: Remove C++ mangled symbols +- Prettify xml output and add node position info _by_ @amaanq _in_ #2970 +- Inherited grammar generation _by_ @amaanq +- Properly error out when the word property is an invalid rule _by_ @amaanq +- Update schema for regex flags _by_ @amaanq _in_ #3006 +- Properly handle `Query.matches` when filtering out results _by_ @amaanq _in_ #3013 +- Sexp format edge case with quoted closed parenthesis _by_ @amaanq _in_ #3016 +- Always push the default files if there's no `externals` _by_ @amaanq +- Don't log NUL characters _by_ @amaanq _in_ #3037 +- Don't throw an error if the user uses `map` in the grammar _by_ @amaanq _in_ #3041 +- Remove redundant imports _by_ @amaanq _in_ #3047 +- **cli**: Installation via a HTTP tunnel proxy _by_ @stormyyd _in_ #2824 +- **cli**: Don't update tests automatically if parse errors are detected _by_ @amaanq _in_ #3033 +- **cli**: Don't use `long` for `grammar_path` _by_ @amaanq +- **test**: Allow writing updates to tests without erroneous nodes instead of denying all of them if a single error is found _by_ @amaanq +- **test**: Edge case when parsing `UNEXPECTED`/`MISSING` nodes with an indentation level greater than 0 _by_ @amaanq +- **wasm**: Remove C++ mangled symbols _by_ @amaanq _in_ #2971 ### Build System -- Add useful development targets to makefile -- Add editorconfig -- Remove symbolic links from repository -- Move common Cargo.toml keys into the workspace and inherit them -- Enable creating changelogs with git-cliff -- **deps**: Bump clap from 4.4.18 to 4.5.0 -- **deps**: Bump wasmtime from v16.0.0 to v17.0.1 -- **deps**: Bump wasmtime to v18.0.1 +- Add useful development targets to makefile _by_ @dundargoc _in_ #2979 +- Add editorconfig _by_ @dundargoc _in_ #2998 +- Remove symbolic links from repository _by_ @dundargoc _in_ #2997 +- Move common Cargo.toml keys into the workspace and inherit them _by_ @amaanq _in_ #3019 +- Enable creating changelogs with git-cliff _by_ @dundargoc _in_ #3040 +- **deps**: Bump clap from 4.4.18 to 4.5.0 _by_ @dependabot[bot] _in_ #3007 +- **deps**: Bump wasmtime from v16.0.0 to v17.0.1 _by_ @dependabot[bot] _in_ #3008 +- **deps**: Bump wasmtime to v18.0.1 _by_ @amaanq _in_ #3057 ### Documentation -- Create issue template -- Document regex limitations -- Mention that `token($.foo)` is illegal -- Explicitly mention behavior of walking outside the given "root" node for a `TSTreeCursor` -- Small fixes -- Add `Tact` language parser -- **web**: Provide deno usage information +- Create issue template _by_ @dundargoc _in_ #2978 +- Document regex limitations _by_ @amaanq +- Mention that `token($.foo)` is illegal _by_ @amaanq +- Explicitly mention behavior of walking outside the given "root" node for a `TSTreeCursor` _by_ @amaanq _in_ #3021 +- Small fixes _by_ @dundargoc _in_ #2987 +- Add `Tact` language parser _by_ @novusnota _in_ #3030 +- **web**: Provide deno usage information _by_ @sigmaSd _in_ #2498 ### Features -- Use lockfiles to dedup recompilation -- Improve error message for files with an unknown grammar path -- Implement first-line-regex -- Error out if an empty string is in the `extras` array -- Allow specifying an external scanner's files -- Better error info when a scanner is missing required symbols -- **cli**: Add an optional `grammar-path` argument for the playground -- **cli**: Add optional `config-path` argument -- **loader**: Add more commonly used default parser directories +- Use lockfiles to dedup recompilation _by_ @amaanq +- Improve error message for files with an unknown grammar path _by_ @amaanq _in_ #2475 +- Implement first-line-regex _by_ @sigmaSd _in_ #2479 +- Error out if an empty string is in the `extras` array _by_ @aminya +- Allow specifying an external scanner's files _by_ @amaanq _in_ #3031 +- Better error info when a scanner is missing required symbols _by_ @amaanq +- **cli**: Add an optional `grammar-path` argument for the playground _by_ @amaanq _in_ #3014 +- **cli**: Add optional `config-path` argument _by_ @WillLillis _in_ #3050 +- **loader**: Add more commonly used default parser directories _by_ @amaanq ### Miscellaneous Tasks -- Document preferred language for scanner -- Add java and tsx to corpus tests -- Provide a CLI flag to open `log.html` -- Some more clippy lints -- Remove deprecated query parsing mechanism -- Print out full compiler arguments ran when it fails -- Deprecate C++ scanners -- Update relevant rust tests -- Clippy lints -- Error out when multiple arguments are passed to `token`/`token.immediate` -- Update `Cargo.lock` -- Get rid of `github_issue_test` file -- **cli**: Use spawn to display `emcc`'s stdout and stderr -- **cli**: Warn users when a query path needed for a subcommand isn't specified - in a grammar's package.json -- **generate**: Dedup and warn about duplicate or invalid rules -- **test**: Use different languages for async tests -- **wasm**: Use `SIDE_MODULE=2` to silence warning +- Document preferred language for scanner _by_ @calebdw _in_ #2972 +- Add java and tsx to corpus tests _by_ @amaanq _in_ #2992 +- Provide a CLI flag to open `log.html` _by_ @amaanq _in_ #2996 +- Some more clippy lints _by_ @amaanq _in_ #3010 +- Remove deprecated query parsing mechanism _by_ @amaanq _in_ #3011 +- Print out full compiler arguments ran when it fails _by_ @amaanq _in_ #3018 +- Deprecate C++ scanners _by_ @amaanq _in_ #3020 +- Update relevant rust tests _by_ @amaanq _in_ #2947 +- Clippy lints _by_ @amaanq _in_ #3032 +- Error out when multiple arguments are passed to `token`/`token.immediate` _by_ @amaanq _in_ #3036 +- Update `Cargo.lock` _by_ @amaanq +- Get rid of `github_issue_test` file _by_ @amaanq _in_ #3055 +- **cli**: Use spawn to display `emcc`'s stdout and stderr _by_ @amaanq _in_ #2494 +- **cli**: Warn users when a query path needed for a subcommand isn't specified in a grammar's package.json _by_ @amaanq +- **generate**: Dedup and warn about duplicate or invalid rules _by_ @amaanq _in_ #2994 +- **test**: Use different languages for async tests _by_ @amaanq _in_ #2953 +- **wasm**: Use `SIDE_MODULE=2` to silence warning _by_ @amaanq _in_ #3003 ### Refactor -- Extract regex check into a function and lower its precedence -- `&PathBuf` -> `&Path` -- Name anonymous types in api.h +- Extract regex check into a function and lower its precedence _by_ @amaanq +- `&PathBuf` -> `&Path` _by_ @amaanq _in_ #3035 +- Name anonymous types in api.h _by_ @MatthewGentoo _in_ #1659 ### Testing -- Add quotes around bash variables -- Update html tests +- Add quotes around bash variables _by_ @dundargoc _in_ #3023 +- Update html tests _by_ @amaanq diff --git a/script/cliff.toml b/script/cliff.toml index 46fb86c8..9e64d748 100644 --- a/script/cliff.toml +++ b/script/cliff.toml @@ -17,12 +17,16 @@ body = """ ### {{ group | upper_first }} {% for commit in commits%}\ {% if not commit.scope %}\ - - {{ commit.message | upper_first }} + - {{ commit.message | upper_first }}\ + {% if commit.github.username %} *by* @{{ commit.github.username }}{%- endif %}\ + {% if commit.github.pr_number %} *in* #{{ commit.github.pr_number }}{%- endif %} {% endif %}\ {% endfor %}\ {% for group, commits in commits | group_by(attribute="scope") %}\ {% for commit in commits %}\ - - **{{commit.scope}}**: {{ commit.message | upper_first }} + - **{{commit.scope}}**: {{ commit.message | upper_first }}\ + {% if commit.github.username %} *by* @{{ commit.github.username }}{%- endif %}\ + {% if commit.github.pr_number %} *in* #{{ commit.github.pr_number }}{%- endif %} {% endfor %}\ {% endfor %} {% endfor %}\n @@ -66,3 +70,7 @@ ignore_tags = "" date_order = false # sort the commits inside sections by oldest/newest order sort_commits = "oldest" + +[remote.github] +owner = "tree-sitter" +repo = "tree-sitter"