Introduce `Diagnostic` type and remove ariadne from public API #963

Xanewok · 2024-05-15T09:57:50Z

Part of or might close #804

Rather than coming up with perfect API that ties everything together, let's start with the Diagnostic and iterate from there.

changeset-bot · 2024-05-15T09:57:53Z

🦋 Changeset detected

Latest commit: 4e85c4d

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 · 2024-05-15T10:08:24Z

I have to rebase this as #962 landed in the meantime.

crates/codegen/runtime/cargo/src/runtime/diagnostic.rs

crates/codegen/runtime/cargo/src/runtime/napi_interface/parse_error.rs

crates/codegen/runtime/cargo/src/runtime/parse_error.rs

crates/testlang/outputs/cargo/slang_testlang/src/generated/diagnostic.rs

crates/codegen/runtime/cargo/src/runtime/napi_interface/diagnostic.rs

OmarTawfik · 2024-05-19T04:51:00Z

crates/solidity/outputs/cargo/slang_solidity/Cargo.toml

@@ -33,7 +33,9 @@ required-features = ["cli"]

 [features]
 default = ["cli"]
-cli = ["dep:anyhow", "dep:clap", "dep:serde_json"]
+cli = ["dep:anyhow", "dep:clap", "dep:serde_json", "__private_ariadne"]
+# This is meant to be used by the CLI or internally only.


question: I wonder why are we adding an extra feature here, instead of just adding dep:ariadne to the existing default cli feature (enabled by default). This will also mean that we won't need to explicitly enable it in other crates.

Per the comment, because it's also used internally (by our other crates crates in the workspace) and not only via the CLI, see https://github.com/NomicFoundation/slang/pull/963/files#diff-059ed3ad7d6d34ada23bb6a205ff05636f0f434ff9fa8ebf7c1a0c596b81b893R22 for instance.

OmarTawfik

Really exciting! Thank you!
I left a few questions/suggestions.

#964) Extracted from #963 in case we want to land this separately.

…t range

Xanewok · 2024-05-27T13:00:58Z

I've resolved your final concerns @OmarTawfik:

The Diagnostic::range was renamed to Diagnostic::text_range. Until we emit LSP-compliant structure there, we might as well use our local TextRange for now, which should keep using text_range
The explicit toDiagnostic conversion method was removed in favor of our custom, hand-rolled interface DiagnosticsInterface (not to mix with the existing Diagnostic trait), which the exported ParseError directly implements via a new delegating macro for this trait.

We might decide to get rid of the napi-exported class Diagnostic in favour of this interface or we might keep it if we will somehow get to use the planned class inheritance feature for napi (see #987, which tracks this workaround/approach of ours), but I prefer that we treat this as further refinement of this API done only on top of this PR.

@OmarTawfik

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>

Xanewok requested a review from a team as a code owner May 15, 2024 09:57

refactor: Prefer explicit Clone over From<&Borrowed> for Owned impls

69fdb85

Xanewok force-pushed the diagnostic-api branch from 5eab1c2 to 9c80db6 Compare May 15, 2024 11:14

Xanewok mentioned this pull request May 15, 2024

refactor: Prefer explicit Clone over From<&Borrowed> for Owned impls #964

Merged

Introduce Diagnostic trait and remove error rendering in public API

27dc353

Xanewok force-pushed the diagnostic-api branch from 9c80db6 to 27dc353 Compare May 15, 2024 11:16

Xanewok commented May 15, 2024

View reviewed changes

Xanewok added 3 commits May 15, 2024 12:41

fixup: Don't depend on ariadne in the node addon runtime

f2df66d

refactor: Drop the Error bound from the Diagnostic trait

89bc471

Document the new Diagnostic trait

7a618da

Xanewok commented May 15, 2024

View reviewed changes

crates/codegen/runtime/cargo/src/runtime/parse_error.rs Outdated Show resolved Hide resolved

fix: Properly re-export diagnostic namespace in TS

3c96df1