-
-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy path.npmignore
More file actions
326 lines (269 loc) · 8.7 KB
/
.npmignore
File metadata and controls
326 lines (269 loc) · 8.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# =============================================================================
# NPM Ignore
# =============================================================================
#
# Files and directories excluded from the npm package.
# Documentation: https://docs.npmjs.com/cli/v10/using-npm/developers
#
# -----------------------------------------------------------------------------
# How It Works
# -----------------------------------------------------------------------------
#
# When running `npm publish` or `npm pack`, npm creates a tarball containing
# only files intended for distribution. This file specifies what to EXCLUDE.
#
# Priority (highest to lowest):
# 1. package.json "files" field (whitelist, overrides .npmignore)
# 2. .npmignore (this file)
# 3. .gitignore (used if no .npmignore exists)
#
# Always included (cannot be excluded):
# - package.json
# - README (any case/extension)
# - LICENSE / LICENCE
# - Main file specified in package.json
#
# Always excluded (cannot be included):
# - .git/
# - node_modules/
# - .npmrc
# - package-lock.json (unless explicitly in "files")
#
# -----------------------------------------------------------------------------
# Usage
# -----------------------------------------------------------------------------
#
# Preview package contents:
# npm pack --dry-run
#
# List files in tarball:
# tar -tzf package-name-1.0.0.tgz
#
# Check package size:
# npm publish --dry-run
#
# =============================================================================
# =============================================================================
# Source Directories
# =============================================================================
#
# Only ship compiled/bundled output (dist/).
# Source files are excluded to reduce package size.
#
# -----------------------------------------------------------------------------
src/
exe/
tst/
bin/
doc/
bup/
img/
log/
res/
# =============================================================================
# Python Files
# =============================================================================
#
# This is a hybrid Python/JS project. Python files are not needed in the
# npm package - they're distributed via PyPI instead.
#
# -----------------------------------------------------------------------------
*.py
*.pyc
*.pyo
__pycache__/
# Python environment & tooling
.venv/
poetry.lock
pyproject.toml
.python-version
# Python linting & testing config
.coveragerc
.flake8
.pylintrc
pytest.ini
tox.ini
mypy.ini
.isort.cfg
setup.py
setup.cfg
MANIFEST.in
# =============================================================================
# Package Manager Lockfiles
# =============================================================================
#
# Lockfiles are for development reproducibility, not for published packages.
# Consumers use their own lockfiles with the version ranges in package.json.
#
# -----------------------------------------------------------------------------
package-lock.json
yarn.lock
pnpm-lock.yaml
# =============================================================================
# Editor & IDE Configuration
# =============================================================================
#
# Editor-specific settings are developer preferences, not package dependencies.
#
# -----------------------------------------------------------------------------
.editorconfig
*.code-workspace
.vscode/
.idea/
*.swp
*.swo
# =============================================================================
# CI/CD Configuration
# =============================================================================
#
# Pipeline configs are repository-specific, not useful to package consumers.
#
# -----------------------------------------------------------------------------
.travis.yml
.circleci/
.gitlab-ci.yml
azure-pipelines.yml
.github/
# =============================================================================
# Docker Configuration
# =============================================================================
#
# Container configs are for deployment, not package distribution.
#
# -----------------------------------------------------------------------------
Dockerfile
docker-compose*.yml
.dockerignore
# =============================================================================
# Linting & Formatting Configuration
# =============================================================================
#
# These enforce project code style - not relevant to consumers.
#
# -----------------------------------------------------------------------------
.prettierrc
.prettierrc.*
.prettierignore
.eslintrc*
eslint.config.*
.stylelintrc*
stylelint.config.*
# =============================================================================
# Build Configuration
# =============================================================================
#
# Build tooling configs are used to CREATE the dist/ output.
# Consumers only need the built artifacts, not the build system.
#
# -----------------------------------------------------------------------------
vite.config.ts
tsconfig*.json
webpack*.cjs
# =============================================================================
# Tests & Coverage
# =============================================================================
#
# Test files and coverage reports are development artifacts.
#
# -----------------------------------------------------------------------------
tests/
*.spec.js
*.spec.ts
*.test.js
*.test.ts
coverage/
htmlcov/
.coverage
# =============================================================================
# Documentation
# =============================================================================
#
# Exclude documentation except README.md (auto-included by npm).
# Full docs are published separately (e.g., GitHub Pages, ReadTheDocs).
#
# -----------------------------------------------------------------------------
doc/
docs/
*.md
!README.md
mkdocs.yml
site/
# =============================================================================
# Metadata Files
# =============================================================================
#
# Citation and license files - LICENSE is auto-included by npm.
#
# -----------------------------------------------------------------------------
CITATION.cff
codemeta.json
# Note: LICENSE is automatically included by npm, no need to list here
# =============================================================================
# Operating System Files
# =============================================================================
#
# OS-generated files that should never be in packages.
#
# -----------------------------------------------------------------------------
.DS_Store
Thumbs.db
# =============================================================================
# Logs
# =============================================================================
#
# Log files from npm/yarn/development are not distributable.
#
# -----------------------------------------------------------------------------
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# =============================================================================
# Environment Variables
# =============================================================================
#
# NEVER publish environment files - may contain secrets!
#
# -----------------------------------------------------------------------------
.env
*.env
.env.*
# =============================================================================
# Temporary & Development Files
# =============================================================================
#
# Scratch files, backups, and local development artifacts.
#
# -----------------------------------------------------------------------------
*.tmp
*.bak
*.local
wip/
tmp/
# =============================================================================
# Build & Automation Files
# =============================================================================
#
# Project automation that isn't needed by package consumers.
#
# -----------------------------------------------------------------------------
Makefile
honcho*.yml
Procfile
# =============================================================================
# Database Files
# =============================================================================
#
# Local development databases should never be published.
#
# -----------------------------------------------------------------------------
*.sqlite3
*.db
# =============================================================================
# Version Control
# =============================================================================
#
# Note: .git/ is automatically excluded by npm, listed here for clarity.
#
# -----------------------------------------------------------------------------
.git/