Instructions are not clear enough that _version.py should be ignored or deleted when this package is used...

[gutow]

Can we change the instructions to make it clear that this overrides the use of _version.py. I was working on a project that had both a _version.py and a a package.json file with version numbers in them. They were out of sync. It appears the _version.py was created when I had to reinstall Hatch because of a python update and hatch-nodejs-version did not also get installed properly.

Using the documentation of this package and Hatch, I was not clear that this completely overrides the standard Hatch use of _version.py, AND (this is what is not clear) uses the nodejs versioning information to maintain the python package version as well.

Any thoughts on how and where this could be clarified?

[agoose77]

I'm not entirely sure what to suggest. Am I correct in understanding that this happened whilst you were working on an unfamiliar project? If so, I think it might be something that this project should document as part of CONTRIBUTING (or other documentation) to point out that they are using this plugin.

Does that sound sensible to you?

[gutow]

The problem occurred while trying to update my own code. I wrote the original version about 6 months ago and had no reason to update it until a small bug was found. Because of the time gap, my development system had updated Python versions, requiring a reinstall of Hatch. For reasons, I have not figured out, hatch-nodejs-version did not reinstall initially despite being in the pyproject.toml. This lead to me manually reinstalling things. This meant I needed to understand what had been automatically taken care of by the original template I used to create the project. I think the explanation belongs in the documentation for hatch-nodejs-version.

I am in panic mode getting my class material prepped with one week left before my semester starts. I will try to look at the instructions here and make a pull request with specific ideas as soon as I can.