Remove need of pest3_core as a dependency for pest3 users

Tartasprint commented 1 month ago

Now a user has to put just one line in the dependencies:

[package]
name = "test3"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
pest3 = { version = "0.0.0-prealpha0", path = "../pest3/pest", features = [ 'derive' ] }

In order to do that I have:

made the full_rule_structmacro public (even to the user)
added a meta feature to the generator crate, so that I can activate it in the generator's tests.

Summary by CodeRabbit

New Features
- Introduced the full_rule_struct macro for enhanced parsing capabilities.
- Added new traits: PairContainer, EmptyPairContainer, PairTree, TypedParser, and NeverFailedTypedNode for improved functionality in handling typed nodes and pairs.
- Enabled a new meta feature in the pest3_generator package.
Bug Fixes
- Updated macro invocation to ensure correct namespace resolution across multiple rule definitions.
Documentation
- Enhanced documentation for new traits and macros to aid user understanding, including detailed descriptions for various rules.

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces changes to the core/src/typed module by adding the full_rule_struct macro and several new traits to enhance the parsing framework's functionality. It also updates the Cargo.toml files for both pest3_derive and pest3_generator to include new feature specifications. Furthermore, the invocation of the full_rule_struct macro is modified in the generator/src/typed/generator.rs file to reflect its new namespace, ensuring correct resolution in the updated context.

Changes

File Path	Change Summary
core/src/typed/mod.rs	Added public export of `full_rule_struct`.
core/src/typed/traits.rs	- Added `full_rule_struct` macro. - Introduced `PairContainer`, `EmptyPairContainer`, `PairTree`, `TypedParser`, and `NeverFailedTypedNode` traits. - Implemented `PairContainer` for `Option<T>` and `TypedNode` for `Option<T>`.
derive/Cargo.toml	Updated `pest3_generator` dependency to include `meta` feature in `[dev-dependencies]`.
generator/Cargo.toml	Added `[features]` section with `meta` feature for `pest3_generator`.
generator/src/typed/generator.rs	Updated macro invocation from `full_rule_struct!` to `typed::full_rule_struct!`.
generator/src/types.rs	Added conditional compilation to `pest` function to support behavior based on the `meta` feature.
generator/tests/expected.rs	Updated macro calls from `::pest3_core::full_rule_struct!` to `::pest3_core::typed::full_rule_struct!` for various rules.
generator/tests/expected_import_inline.rs	Updated macro calls from `::pest3_core::full_rule_struct!` to `::pest3_core::typed::full_rule_struct!` for multiple rules.
generator/tests/expected_json.rs	Updated macro calls from `::pest3_core::full_rule_struct!` to `::pest3_core::typed::full_rule_struct!` for various rules.
generator/tests/expected_sample.rs	Updated macro calls from `::pest3_core::full_rule_struct!` to `::pest3_core::typed::full_rule_struct!` for multiple rules.

Possibly related PRs

#16: The changes in this PR involve moving basic types to pest3_core, which directly relates to the modifications in the core/src/typed/traits.rs file where the full_rule_struct macro is defined and exported. This indicates a structural change in how types and macros are organized within the project, aligning with the updates made in the main PR.

Poem

🐇 In the meadow where macros play,
A new friend joins us today.
full_rule_struct leaps with glee,
Traits and features, oh so free!
With every hop, our code will grow,
In the garden of logic, watch it flow! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

Tartasprint commented 1 month ago

fixes #7

pest-parser / pest3