Remove the version field from the package.json file
#13664
Merged
Conversation
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
According to https://docs.npmjs.com/cli/v7/configuring-npm/package-json#version, the "version" field is not required[1]: > If you don't plan to publish your package, the name and version fields are optional. Hence it shouldn't be necessary to have a "dummy" `version` field in the `package.json` file, and it seems quite unfortunate to have an essentially meaningless entry in that file.[2] Furthermore, I'd even go as far as suggesting that it's actually doing more harm than good in practice, since it's not uncommon for people to open issues where they simply quote the `package.json`-entry when filling out the ISSUE_TEMPLATE thus causing confusion as to which *exact* version is actually used. Unless I'm misremembering, I believe that the only reason for adding the `version` field was that is was necessary in order for things to work back when testing was run on Travis. Now we're using GitHub Actions instead, where things seem to work just find even without a `version` field; hence why I think it makes sense to remove this. --- [1] Please note that this patch doesn't affect the `pdfjs-dist` package, since the `package.json` file used there is created in `gulpfile.js` during building. [2] Trying to, automatically, update the `version` field on *every* commit really doesn't seem worth it to me.
|
/botio unittest |
From: Bot.io (Linux m4)ReceivedCommand cmd_unittest from @Snuffleupagus received. Current queue size: 0 Live output at: http://54.67.70.0:8877/7d1f97ef9cd2718/output.txt |
From: Bot.io (Windows)ReceivedCommand cmd_unittest from @Snuffleupagus received. Current queue size: 0 Live output at: http://3.101.106.178:8877/f9b6ba5ced07eb5/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.67.70.0:8877/7d1f97ef9cd2718/output.txt Total script time: 3.83 mins
|
From: Bot.io (Windows)SuccessFull output at http://3.101.106.178:8877/f9b6ba5ced07eb5/output.txt Total script time: 6.69 mins
|
timvandermeij
approved these changes
Jul 3, 2021
|
Seems like a good idea to me! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
According to https://docs.npmjs.com/cli/v7/configuring-npm/package-json#version, the "version" field is not required[1]:
Hence it shouldn't be necessary to have a "dummy"
versionfield in thepackage.jsonfile, and it seems quite unfortunate to have an essentially meaningless entry in that file.[2]Furthermore, I'd even go as far as suggesting that it's actually doing more harm than good in practice, since it's not uncommon for people to open issues where they simply quote the
package.json-entry when filling out the ISSUE_TEMPLATE thus causing confusion as to which exact version is actually used.Unless I'm misremembering, I believe that the only reason for adding the
versionfield was that is was necessary in order for things to work back when testing was run on Travis.Now we're using GitHub Actions instead, where things seem to work just find even without a
versionfield; hence why I think it makes sense to remove this.[1] Please note that this patch doesn't affect the
pdfjs-distpackage, since thepackage.jsonfile used there is created ingulpfile.jsduring building.[2] Trying to, automatically, update the
versionfield on every commit really doesn't seem worth it to me.