-
Notifications
You must be signed in to change notification settings - Fork 9
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.
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
RFC: Streamlined UX #36
Conversation
This RFC proposes making it possible to use Neon with only standard CLI tools: `npm` for JavaScript workflows, and `cargo` for Rust workflows. This should lighten the cognitive burden of learning Neon, make it easier to learn, and generally feel like an even simpler end-to-end user experience.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something we may want to consider adding to this scope is making the fn build
function for N-API part of the neon
module.
It has zero dependencies and would allow users to use neon with only neon
in their Cargo.toml
.
I'm not sure how to accomplish it, but it would also be neat if building neon
would fail with a helpful message if the user was missing a build.rs
. This could allow for a workflow where users can cargo add neon
and "follow the compiler."
- Remove `build.rs` from generated files list - Distinguish files generated by `npm init neon` from files generated by the build - Add `.gitignore`
@kjvalencik Thanks for the review, I addressed all your feedback. |
…ehavior we decided on when implementing.
This RFC proposes streamlining the directory layout and command-line UX of Neon projects, making the design simpler, more intuitive, and easier to learn and adopt.
In particular, starting a new Neon project looks like:
And the directory layout is flattened and simplified to:
Rendered RFC