Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update remaining public API and user docs terminology #975

Merged
merged 4 commits into from
May 27, 2024
Merged

update remaining public API and user docs terminology #975

merged 4 commits into from
May 27, 2024

Conversation

OmarTawfik
Copy link
Collaborator

@OmarTawfik OmarTawfik commented May 22, 2024 •
edited
Loading

Following up on changes in #971 and #918.

@OmarTawfik OmarTawfik requested a review from a team as a code owner May 22, 2024 15:51
@OmarTawfik OmarTawfik enabled auto-merge May 22, 2024 15:51
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented May 22, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: 8642e72

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@nomicfoundation/slang Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Xanewok
Xanewok reviewed May 22, 2024
View reviewed changes
Copy link
Contributor

@Xanewok Xanewok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking another look at that! I've missed few cases, sorry about that.

I'm happy to fix obvious mistakes like go_to for the cursor, edge labels etc. but I deliberately didn't go with lexer-related changes before, because the lexer technically shouldn't be concerned with the tree but rather with lexemes/tokens/symbols/what have you rather than terminals (which imply there are non-terminals). Suddenly all of our code is about terminality, which I think makes it harder to reason about and to navigate the codebase 😞

crates/codegen/runtime/cargo/src/runtime/language.rs.jinja2 Show resolved Hide resolved
crates/codegen/runtime/cargo/src/runtime/napi_interface/cst.rs Outdated
/// Serialize the token node to JSON.
/// Serialize the node to JSON.
///
/// This method is intended for debugging purposes and may not be stable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We agreed to remove this IIUC, so I think we should rather drop this from the other function (my mistake) rather than add it here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good.

documentation/public/user-guide/introduction.md Outdated
@@ -18,7 +18,7 @@ The Solidity programming language has evolved quite a bit since its inception. S

While it's good for a programming language to evolve and better serve the needs of its users, not being able to easily upgrade or re-deploy existing contracts poses a unique challenge. Developer tooling must be able to understand and consume older contracts that are still being used on the blockchain, written in older versions of Solidity.

Because of that, Slang must be able to reason about different versions of Solidity; how the language grammar, name binding rules, and semantics have changed [across different versions](../solidity-specification/supported-versions.md). One of our goals is to document differences as part of our [Solidity Specification](../solidity-specification/index.md).
Because of that, Slang must be able to reason about different versions of Solidity; how the language grammar, name binding non-terminals, and semantics have changed [across different versions](../solidity-specification/supported-versions.md). One of our goals is to document differences as part of our [Solidity Specification](../solidity-specification/index.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is about rules in general rather than syntax non-terminals

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. I missed this.

documentation/public/user-guide/npm-package/using-the-parser.md Outdated
@@ -1,6 +1,6 @@
# Using the Parser

Using the API directly provides us with a more fine-grained control over the parsing process. It allows us to parse not just the input as a top-level source unit, but also individual rules like contracts, various definitions, and even expressions.
Using the API directly provides us with a more fine-grained control over the parsing process. It allows us to parse not just the input as a top-level source unit, but also individual non-terminals like contracts, various definitions, and even expressions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably "constructs" would flow better here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. Will update.

@OmarTawfik OmarTawfik disabled auto-merge May 22, 2024 17:48
@OmarTawfik
update renaming mentions of tokens and rules
e6d12ba 
Following up on the changes started in NomicFoundation#971, updating the changeset, code references in the public API, comments, and some user docs.
@OmarTawfik
pr feedback
e71c2cd
@OmarTawfik
non-terminal to nonterminal
f934501
@OmarTawfik OmarTawfik linked an issue May 26, 2024 that may be closed by this pull request
Rename bindings to captures in queries and associated documentation. #978
Closed
@OmarTawfik OmarTawfik changed the title update renaming mentions of tokens and rules update public API and user docs terminology May 26, 2024
@OmarTawfik OmarTawfik changed the title update public API and user docs terminology update remaining public API and user docs terminology May 26, 2024
@OmarTawfik OmarTawfik force-pushed the remaining-token-rule-rename branch from 38b3c2f to 8642e72 Compare May 26, 2024 00:37
@OmarTawfik OmarTawfik added this pull request to the merge queue May 27, 2024
Merged via the queue into NomicFoundation:main with commit 46b1dde May 27, 2024
1 check passed
@OmarTawfik OmarTawfik deleted the remaining-token-rule-rename branch May 27, 2024 11:08
@github-actions github-actions bot mentioned this pull request May 30, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Jun 11, 2024
@github-actions
Bump Slang Version (#993)
edbad89 
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and publish to npm
yourself or [setup this action to publish
automatically](https://github.com/changesets/action#with-publishing). If
you're not ready to do a release yet, that's fine, whenever you add more
changesets to main, this PR will be updated.


# Releases
## @nomicfoundation/slang@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-darwin-arm64@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-darwin-x64@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-linux-arm64-gnu@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-linux-arm64-musl@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-linux-x64-gnu@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-linux-x64-musl@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-win32-arm64-msvc@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-win32-ia32-msvc@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

## @nomicfoundation/slang-win32-x64-msvc@0.15.0

### Minor Changes

- [#975](#975)
[`46b1dde`](46b1dde)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - rename
`QueryResult` to `QueryMatch`, and its `bindings` to `captures`.

- [#971](#971)
[`be943b7`](be943b7)
Thanks [@Xanewok](https://github.com/Xanewok)! - Rename `RuleKind` to
`NonterminalKind`, `TokenKind` to `TerminalKind`, and `NodeLabel` to
`EdgeLabel`.

- [#963](#963)
[`a5593f9`](a5593f9)
Thanks [@Xanewok](https://github.com/Xanewok)! - Introduce a
`Diagnostic` API for compiler errors, warnings etc.

### Patch Changes

- [#996](#996)
[`cdc153d`](cdc153d)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - add support for
version `0.8.26`.

- [#983](#983)
[`ea31417`](ea31417)
Thanks [@ggiraldez](https://github.com/ggiraldez)! - Expose the language
root non-terminal kind at `Language.rootKind()`.

- [#965](#965)
[`61b6b06`](61b6b06)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - refactor CST
building and querying utilities into a separate `metaslang_cst` crate.

- [#997](#997)
[`84ad856`](84ad856)
Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Support stack
assignments in Yul before `0.5.0`.

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Xanewok Xanewok Xanewok approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rename bindings to captures in queries and associated documentation.
2 participants
@OmarTawfik @Xanewok