Skip to content

Commit 5ee1fe0

Browse files
committed
RFC: Expand list of ignored files
1 parent a2c0fc5 commit 5ee1fe0

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Expand list of ignored files
2+
3+
## Summary
4+
5+
Let's expand the default list of ignored files in [packlist](https://github.com/npm/npm-packlist).
6+
7+
## Motivation
8+
9+
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.
10+
11+
## Detailed Explanation
12+
13+
Expand the current list of ignored files to also ignore by default:
14+
15+
- `.editorconfig` common plugins
16+
- `.gitattributes` and/or more git things
17+
- `.idea/` (or other editors similar configs/store/etc)
18+
- `.travis.yml`, `.github/` (and/or more ci services)
19+
- `.yo-rc.json` template/boilerplate related files
20+
21+
...and whatever more we think makes sense
22+
23+
## Rationale and Alternatives
24+
25+
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:
26+
27+
- Status quo, do not alter the current existing [list of ignored files](https://github.com/npm/npm-packlist/blob/master/index.js#L38).
28+
- More alternatives?
29+
30+
## Implementation
31+
32+
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.
33+
34+
## Unresolved Questions and Bikeshedding
35+
36+
:warning: *Make sure we don't break the ecosystem* - We should definetily err on the side of caution here.
37+

0 commit comments

Comments
 (0)