jasongin / jasongin/nvs

Add support for comments in version files like .nvmrc

Open
#175 18 comments 11 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
3k
Forks
231
PR merge metrics
No merged PRs in 30d

Description

I recently came across a project with a `.nvmrc` file with a comment in it which is useful to tell maintainers that unfortunately it's not the single source of truth (due to it being duplicated in a `pom.xml` that uses frontend-maven-plugin). Could support be added to ignore anything after a version number that comes at the start of the file?

`cat .nvmrc`
`12.18.0`
`# note to update the pom.xml node version too`

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the code that reads version files such as .nvmrc, then check how a leading version followed by a comment is currently handled. Add coverage for the shown .nvmrc content and confirm that the version is read while the comment is ignored.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.