-
Notifications
You must be signed in to change notification settings - Fork 240
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Expand list of ignored files | ||
|
||
## Summary | ||
|
||
Let's expand the default list of ignored files in [packlist](https://github.com/npm/npm-packlist). | ||
|
||
## Motivation | ||
|
||
A large population of npm users are concerned about package sizes and with the advent of the file explorer now available on [npmjs.com](https://www.npmjs.com/) we can now see a number of common files that are very intrinsic to the JS community that we could start ignoring from package bundles without too much friction to the larger ecosystem. | ||
|
||
## Detailed Explanation | ||
|
||
Expand the current list of ignored files to also ignore by default: | ||
|
||
- `.editorconfig` common plugins | ||
- `.gitattributes` and/or more git things | ||
- `.idea/` (or other editors similar configs/store/etc) | ||
- `.travis.yml`, `.github/` (and/or more ci services) | ||
- `.yo-rc.json` template/boilerplate related files | ||
|
||
...and whatever more we think makes sense | ||
|
||
## Rationale and Alternatives | ||
|
||
Avoiding bundling undesirable files is something we already do today, the idea is only to make it more useful by including some other common files in the JavaScript ecosystem. That said, possible alternatives are: | ||
|
||
- Status quo, do not alter the current existing [list of ignored files](https://github.com/npm/npm-packlist/blob/master/index.js#L38). | ||
- More alternatives? | ||
|
||
## Implementation | ||
|
||
Add some more entries to the already existing [list of ignored files in packlist](https://github.com/npm/npm-packlist/blob/master/index.js#L38) and make sure we have tests asserting it behaves the way we intend. | ||
|
||
## Unresolved Questions and Bikeshedding | ||
|
||
:warning: *Make sure we don't break the ecosystem* - We should definetily err on the side of caution here. | ||
|