Skip to content

Commit

Permalink
update README links (NomicFoundation#1069)
Browse files Browse the repository at this point in the history
  • Loading branch information
OmarTawfik authored Aug 12, 2024
1 parent cabf334 commit e8dc494
Show file tree
Hide file tree
Showing 8 changed files with 37 additions and 28 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,17 @@ A modular set of compiler APIs empowering the next generation of Solidity code a
Written in Rust and distributed in multiple languages.

- [Announcement Post](https://medium.com/nomic-foundation-blog/slang-rethnet-2ad465fd7880)
- [Slang Internals](https://nomicfoundation.github.io/slang/internals/)
- [How to write your own Solidity linter using Slang, in 25 lines of code!](https://blog.nomic.foundation/how-to-write-your-own-solidity-linter-using-slang-356e7565ad1b/)
- [Slang Internals](https://nomicfoundation.github.io/slang/latest/internals/)

This repository maintains the source code and release process for these projects:

- [Slang Rust Crate + CLI](https://nomicfoundation.github.io/slang/user-guide/rust-crate/)
- [Slang TypeScript Package](https://nomicfoundation.github.io/slang/user-guide/npm-package/)
- [Solidity Language Specification](https://nomicfoundation.github.io/slang/solidity-specification/)

<br/>
- [Slang Rust Crate + CLI](https://nomicfoundation.github.io/slang/latest/user-guide/rust-crate/)
- [Slang TypeScript Package](https://nomicfoundation.github.io/slang/latest/user-guide/npm-package/)
- [Solidity Language Specification](https://nomicfoundation.github.io/slang/latest/solidity-specification/)

> ❗ This project is still in alpha, and is under active development.
> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
- [We are hiring!](https://nomic.foundation/jobs)
7 changes: 4 additions & 3 deletions crates/metaslang/bindings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ generated by `metaslang`.

## Solidity compiler tooling by [@NomicFoundation](https://github.com/NomicFoundation)

<br/>

> ❗ This project is still in alpha, and is under active development.
> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
- [We are hiring!](https://nomic.foundation/jobs)
7 changes: 4 additions & 3 deletions crates/metaslang/cst/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@

This crate provides support for parse trees used in the Solidity compiler tooling.

<br/>

> ❗ This project is still in alpha, and is under active development.
> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
- [We are hiring!](https://nomic.foundation/jobs)
4 changes: 2 additions & 2 deletions crates/metaslang/cst/src/query/parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,10 @@ impl fmt::Display for QuerySyntaxError {
write!(f, "Invalid escaped Unicode character")
}
QuerySyntaxError::DeprecatedEllipsis => {
write!(f, "The ellipsis `...` operator is deprecated, and replaced with a new adjacency `.` operator. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/user-guide/tree-query-language/")
write!(f, "The ellipsis `...` operator is deprecated, and replaced with a new adjacency `.` operator. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/latest/user-guide/tree-query-language/")
}
QuerySyntaxError::ForbiddenTriviaKind => {
write!(f, "Matching trivia nodes directly is forbidden. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/user-guide/tree-query-language/")
write!(f, "Matching trivia nodes directly is forbidden. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/latest/user-guide/tree-query-language/")
}
}
}
Expand Down
7 changes: 4 additions & 3 deletions crates/metaslang/graph_builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ This library is currently not intended to be
This crate defines a DSL for constructing arbitrary graph
structures from source code that has been parsed using parsers generated using `metaslang`.

<br/>

> ❗ This project is still in alpha, and is under active development.
> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
- [We are hiring!](https://nomic.foundation/jobs)
10 changes: 6 additions & 4 deletions crates/solidity/outputs/cargo/slang_solidity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ A modular set of compiler APIs empowering the next generation of Solidity code a
Written in Rust and distributed in multiple languages.

- [Announcement Post](https://medium.com/nomic-foundation-blog/slang-rethnet-2ad465fd7880)
- [User Guide](https://nomicfoundation.github.io/slang/user-guide/rust-crate/)

<br/>
- [How to write your own Solidity linter using Slang, in 25 lines of code!](https://blog.nomic.foundation/how-to-write-your-own-solidity-linter-using-slang-356e7565ad1b/)
- [User Guide](https://nomicfoundation.github.io/slang/latest/user-guide/rust-crate/)

> ❗ This project is still in alpha, and is under active development.
> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
- [We are hiring!](https://nomic.foundation/jobs)
10 changes: 6 additions & 4 deletions crates/solidity/outputs/npm/package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ A modular set of compiler APIs empowering the next generation of Solidity code a
Written in Rust and distributed in multiple languages.

- [Announcement Post](https://medium.com/nomic-foundation-blog/slang-rethnet-2ad465fd7880)
- [User Guide](https://nomicfoundation.github.io/slang/user-guide/npm-package/)

<br/>
- [How to write your own Solidity linter using Slang, in 25 lines of code!](https://blog.nomic.foundation/how-to-write-your-own-solidity-linter-using-slang-356e7565ad1b/)
- [User Guide](https://nomicfoundation.github.io/slang/latest/user-guide/npm-package/)

> ❗ This project is still in alpha, and is under active development.
> If you are planning on using it, please reach out to us on [Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
> If you are planning on using it, please [reach out to us on Telegram](https://t.me/+pxApdT-Ssn5hMTFh) so we can help you get started.
- [Slang Telegram Group](https://t.me/+pxApdT-Ssn5hMTFh)
- [We are hiring!](https://nomic.foundation/jobs)
4 changes: 2 additions & 2 deletions crates/testlang/outputs/cargo/tests/src/query/parser_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ fn test_fails_parsing_ellipsis() {
Ok(_) => panic!("Expected parse failure"),
Err(e) => assert_eq!(
e.message,
"Parse error:\nThe ellipsis `...` operator is deprecated, and replaced with a new adjacency `.` operator. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/user-guide/tree-query-language/ at: ...]\n",
"Parse error:\nThe ellipsis `...` operator is deprecated, and replaced with a new adjacency `.` operator. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/latest/user-guide/tree-query-language/ at: ...]\n",
),
}
}
Expand Down Expand Up @@ -154,7 +154,7 @@ fn test_fails_parsing_trivia_node_selector() {
Ok(_) => panic!("Expected parse failure"),
Err(e) => assert_eq!(
e.message,
"Parse error:\nMatching trivia nodes directly is forbidden. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/user-guide/tree-query-language/ at: EndOfLine]\n"
"Parse error:\nMatching trivia nodes directly is forbidden. For more information, check the Tree Query Language guide: https://nomicfoundation.github.io/slang/latest/user-guide/tree-query-language/ at: EndOfLine]\n"
),
}
}

0 comments on commit e8dc494

Please sign in to comment.