Add project-specific lints with ast-grep #5637
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ast-grep[0] is a tool that uses tree-sitter[1] and a pattern language to match against code using its ast. It implements code transformation, querying, and linting.
Since clippy isn't extensible for project-specific lints, this adds a first ast-grep lint disallowing `context` as a variable name. Currently it's set to warning as usage is addressed.
To run, install ast-grep, then run `ast-grep scan`. Example output:
```
warning[no-context]: Don't name variables `context`.
┌─ ./crates/turbopack-ecmascript-hmr-protocol/src/lib.rs:132:9
│
132 │ pub context: &'a str,
│ ----^^^^^^^---------
│
= Use a more specific name, such as chunking_context, asset_context, etc.
```
[0] https://ast-grep.github.io
[1] https://tree-sitter.github.io/tree-sitter/
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
9 Ignored Deployments
|
|
|
I've been following ast-grep so it's neat that we're using it here. Are we hooking this up to CI? |
Yeah, I'll add that here. |
|
✅ This change can build |
Linux Benchmark for 746c94fClick to view benchmark
|
MacOS Benchmark for 746c94f
Click to view full benchmark
|
NicholasLYang
approved these changes
Aug 1, 2023
|
It moves to error + ignore allowlist in #5640 |
kodiakhq bot
pushed a commit
to vercel/next.js
that referenced
this pull request
Aug 4, 2023
* vercel/turborepo#5582 * vercel/turborepo#5633 * vercel/turborepo#5637 * vercel/turborepo#5648 <!-- OJ Kwon - test(turbopack): run daily with --experimental --> * vercel/turborepo#5618 * vercel/turborepo#5624 * vercel/turborepo#5597 * vercel/turborepo#5632 * vercel/turborepo#5636 * vercel/turborepo#5666
|
Hi Vercel team. It is my honor that turbo is using ast-grep for project-specific linting. I really appreciate your trust! By the way, ast-grep supported a new argument This page has a screenshot of the option. |
wbinnssmith
added a commit
that referenced
this pull request
Jun 3, 2024
This uses the official ast-grep GitHub Action [0] instead of installing it from npm in the clippy job. Thanks for the suggestion from @HerringtonDarkholme! [0] https://github.com/ast-grep/action [1] #5637 (comment)
wbinnssmith
added a commit
that referenced
this pull request
Jun 11, 2024
This uses the official ast-grep GitHub Action [0] instead of installing it from npm in the clippy job. Thanks for the suggestion from @HerringtonDarkholme! [0] https://github.com/ast-grep/action [1] #5637 (comment)
wbinnssmith
added a commit
that referenced
this pull request
Jun 11, 2024
This uses the official ast-grep GitHub Action [0] instead of installing it from npm in the clippy job. Thanks for the suggestion from @HerringtonDarkholme! [0] https://github.com/ast-grep/action [1] #5637 (comment)
wbinnssmith
added a commit
that referenced
this pull request
Jun 11, 2024
This uses the official ast-grep GitHub Action [0] instead of installing it from npm in the clippy job. Thanks for the suggestion from @HerringtonDarkholme! [0] https://github.com/ast-grep/action [1] #5637 (comment)
ForsakenHarmony
pushed a commit
to vercel/next.js
that referenced
this pull request
Aug 1, 2024
ast-grep[0] is a tool that uses tree-sitter[1] and a pattern language to
match against code using its ast. It implements code transformation,
querying, and linting.
Since clippy isn't extensible for project-specific lints, this adds a
first ast-grep lint disallowing `context` as a variable name. Currently
it's set to warning as usage is addressed.
To run, install ast-grep, then run `ast-grep scan`. Example output:
```
warning[no-context]: Don't name variables `context`.
┌─ ./crates/turbopack-ecmascript-hmr-protocol/src/lib.rs:132:9
│
132 │ pub context: &'a str,
│ ----^^^^^^^---------
│
= Use a more specific name, such as chunking_context, asset_context, etc.
```
[0] https://ast-grep.github.io
[1] https://tree-sitter.github.io/tree-sitter/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ast-grep[0] is a tool that uses tree-sitter[1] and a pattern language to match against code using its ast. It implements code transformation, querying, and linting.
Since clippy isn't extensible for project-specific lints, this adds a first ast-grep lint disallowing
contextas a variable name. Currently it's set to warning as usage is addressed.To run, install ast-grep, then run
ast-grep scan. Example output:[0] https://ast-grep.github.io
[1] https://tree-sitter.github.io/tree-sitter/