-
Notifications
You must be signed in to change notification settings - Fork 17
RFC for support of .node-version file #54
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
Open
andreassjoberg
wants to merge
5
commits into
volta-cli:main
Choose a base branch
from
andreassjoberg:dot-node-version-file-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| - Feature Name: dot_node_version_file_support | ||
| - Start Date: 2025-03-04 | ||
| - RFC PR: (leave this empty) | ||
| - Volta Issue: (leave this empty) | ||
|
|
||
| # Summary | ||
| [summary]: #summary | ||
|
|
||
| Introduce support for a `.node-version` file, enabling it as a fallback source for determining project-specific Node versions. If node version is not specified in `package.json`, fallback to `.node-version` before using global defaults. | ||
|
|
||
| # Motivation | ||
| [motivation]: #motivation | ||
|
|
||
| The aim is to align Volta with other popular Node version managers like fnm, which support `.node-version`. This enhances flexibility and user experience by allowing developers to specify their preferred Node versions in a widely recognized format. | ||
|
|
||
| # Pedagogy | ||
| [pedagogy]: #pedagogy | ||
|
|
||
| Existing node developers are likely already familiar with other versioning methods like `.nvmrc`. Introducing support for `.node-version` aligns Volta with other node version managers. | ||
|
andreassjoberg marked this conversation as resolved.
Outdated
|
||
|
|
||
| # Details | ||
| [details]: #details | ||
|
andreassjoberg marked this conversation as resolved.
andreassjoberg marked this conversation as resolved.
|
||
|
|
||
| ## Inheritance from current solution | ||
|
|
||
| The new feature will follow the same logic currently applied when reading a node version from `package.json`. This ensures consistency across different configuration files. | ||
|
andreassjoberg marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Standardized Approach | ||
|
|
||
| This implementation should mirror the behavior of other Node version managers, ensuring Volta remains competitive and user-friendly. | ||
|
|
||
| ## Fallback Hierarchy | ||
|
|
||
| Prioritize `.node-version` as fallback for determining Node versions. | ||
| If volta is not defined in `package.json`, check `.node-version` before proceeding with global defaults. | ||
| Continue with existing behavior if neither file specifies a version. | ||
|
andreassjoberg marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Backward Compatibility | ||
|
|
||
| This feature does not disrupt current functionality and can be released immediately without breaking changes. | ||
|
|
||
| ## Implementation Considerations | ||
|
|
||
| Ensure the implementation respects the same environment inheritance as today’s solution when reading versions from `package.json`. | ||
| Maintain consistent behavior across different scenarios, ensuring that if no specific version is found in either `package.json` or `.node-version`, Volta defaults to its standard global setting. | ||
|
|
||
| No new commands are required; this feature should integrate seamlessly with existing Volta commands. | ||
|
|
||
| ## Testing Strategy | ||
|
|
||
| Develop comprehensive tests that cover various scenarios, including: | ||
|
|
||
| - Presence and absence of `.node-version`. | ||
| - Conflicting versions between `.node-version` and `package.json`. | ||
| - Interaction with global Node version settings. | ||
|
|
||
| # Critique | ||
| [critique]: #critique | ||
|
|
||
| By supporting .node-version, Volta will provide users with more flexibility in how they manage their Node environments, while maintaining its commitment to backward compatibility. This RFC invites feedback on the proposed implementation and any potential edge cases that might arise. | ||
|
|
||
| # Unresolved questions | ||
| [unresolved]: #unresolved-questions | ||
|
andreassjoberg marked this conversation as resolved.
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.