chore: update .npmignore to only publish relevant files #1377
Conversation
This file contains 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
Florent-Bouisset
force-pushed
the
chore/remove-uneeded-files-in-package
branch
from
32a39a9
to
b852d77
Compare
peaBerberian
reviewed
Feb 6, 2024
.npmignore
Outdated
|
|
||
| /FILES.md | ||
| /CONTRIBUTING.md | ||
| /MAINTAINERS.md |
There was a problem hiding this comment.
This one makes sense I think when published
There was a problem hiding this comment.
you mean MAINTAINERS ? or the 3 files ?
peaBerberian
reviewed
Feb 6, 2024
| "require": "./experimental/inline-mpd-parser.commonjs.js", | ||
| "import": "./experimental/inline-mpd-parser.js", | ||
| "default": "./experimental/inline-mpd-parser.js" | ||
| }, |
|
I changed the destination branch to go to |
Ok will rebase, I thought I targeted stable as a mistake and therefore change it to dev again 😄 |
Florent-Bouisset
force-pushed
the
chore/remove-uneeded-files-in-package
branch
from
b852d77
to
7c783c0
Compare
Merged
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.
When publishing the rx-player package to npm, a lots of files are published, such as
srcfolder or even some configuration files like.eslintrc.js.Publishing such files seems to be irrelevant: this files are not used by an application because when an application is importing the library with
import RxPlayer from "rx-player", the files that are actually imported are listed in the propertyexportsproperty of thepackage.json.Publishing unneeded files increase the weight of the package installed on the machine of a developper through
npm install. It's also impact the "Unpacked Size" on the npm page of the repo: https://www.npmjs.com/package/rx-player/v/4.0.0-rc.1?activeTab=codeIt's currently 22MB large. Even if this metric doesn't express the real size of the bundle that an end user will have to download, application developers can have a wrong interpretation of this metric and may think that the RxPlayer library is
heavier than it really is, therefore it can eventually discourage them to use it because of it's weight.
The files that are required by an application using RxPlayer are built artefacts that reside in folder
/dist.Having a
package.jsonis also required.Other files are not necessary but provide useful informations and should be included in the package, this files are:
LICENSEVERSIONCHANGELOG.mdREADME.mdThis change means it's no longer possible to inspected source code with the code published to npm, it will not be possible either to run script such as test or lint on the installed package.
However, the source code can still be freely consulted on this repository, and we considered that it's our responsibility as maintainer to publish versions that are passing tests. Therefore applications should not have to test on their side that the library is passing tests.