Skip to content

Commit 21f2080

Browse files
xplusplusaiclaude
andcommitted
Clean: Add .npmignore and move dev docs to dev folder
This cleanup ensures only production-ready files are published to npm: Changes: - Added .npmignore to exclude dev docs, security tokens, and executables - Moved CICD_PIPELINE_EXPLAINED.md to dev folder - Moved MCP_REGISTRY_PUBLISHING.md to dev folder - Moved WORKFLOW_SETUP_NEEDED.md to dev folder - Updated .gitignore to exclude dev documentation from release Result: - Package size reduced from 27.6 kB to 19.3 kB (30% smaller) - Files reduced from 27 to 21 - No security tokens published - No unnecessary executables published 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 491d305 commit 21f2080

File tree

4 files changed

+86
-636
lines changed

4 files changed

+86
-636
lines changed

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
npm-debug.log*
44
*.tsbuildinfo
55

6-
# Private development files
6+
# Private development files and documentation
7+
# (These should be in the dev folder, not release)
78
CHANGELOG.md
9+
CICD_PIPELINE_EXPLAINED.md
10+
MCP_REGISTRY_PUBLISHING.md
11+
WORKFLOW_SETUP_NEEDED.md
812

913
# Environment files
1014
.env*

.npmignore

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# .npmignore - Controls what gets published to npm
2+
# Only production-ready files should be published to users
3+
4+
# SECURITY: Never publish tokens or credentials
5+
.mcpregistry_*
6+
*.token
7+
*.key
8+
*.pem
9+
.env*
10+
11+
# Development documentation (keep on GitHub, exclude from npm)
12+
CICD_PIPELINE_EXPLAINED.md
13+
MCP_REGISTRY_PUBLISHING.md
14+
WORKFLOW_SETUP_NEEDED.md
15+
16+
# MCP Publisher executables (not needed by users)
17+
mcp-publisher*
18+
*.exe
19+
*.tar.gz
20+
21+
# GitHub-specific files (not needed by end users)
22+
.github/
23+
.git/
24+
.gitignore
25+
26+
# Source maps (optional - uncomment if you want to exclude them)
27+
# *.map
28+
29+
# Development and build files
30+
node_modules/
31+
src/
32+
tsconfig.json
33+
tsconfig.*.json
34+
scripts/
35+
36+
# Test files
37+
test/
38+
tests/
39+
*.test.js
40+
*.test.ts
41+
*.spec.js
42+
*.spec.ts
43+
44+
# Editor and IDE files
45+
.vscode/
46+
.idea/
47+
*.swp
48+
*.swo
49+
*~
50+
51+
# OS files
52+
.DS_Store
53+
Thumbs.db
54+
55+
# Temporary files
56+
*.log
57+
npm-debug.log*
58+
yarn-debug.log*
59+
yarn-error.log*
60+
.npm/
61+
62+
# Build artifacts that shouldn't be published
63+
dist-obfuscated/
64+
build/
65+
coverage/
66+
67+
# Environment files
68+
.env
69+
.env.local
70+
.env.*.local
71+
72+
# Documentation that's development-only
73+
CHANGELOG.md
74+
75+
# Files to INCLUDE (explicitly - everything else excluded by default):
76+
# ✅ README.md - User documentation
77+
# ✅ LICENSE - Required
78+
# ✅ package.json - Required
79+
# ✅ server.json - MCP registry metadata
80+
# ✅ dist/ - Production build
81+
# ✅ docs/GETTING_STARTED.md - User guide

0 commit comments

Comments
 (0)