Skip to content

Commit c3e559f

Browse files
committed
First commit 🚀
0 parents  commit c3e559f

13 files changed

Lines changed: 8125 additions & 0 deletions

.gitignore

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Dependencies
2+
node_modules/
3+
4+
# Build outputs
5+
dist/
6+
7+
# Test coverage
8+
coverage/
9+
10+
# TypeScript
11+
*.tsbuildinfo
12+
13+
# Environment
14+
.env
15+
.env.local
16+
.env.development.local
17+
.env.test.local
18+
.env.production.local
19+
20+
# Logs
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
lerna-debug.log*
25+
26+
# Runtime data
27+
pids
28+
*.pid
29+
*.seed
30+
*.pid.lock
31+
32+
# Coverage directory used by tools like istanbul
33+
coverage/
34+
*.lcov
35+
36+
# nyc test coverage
37+
.nyc_output
38+
39+
# Dependency directories
40+
node_modules/
41+
jspm_packages/
42+
43+
# Optional npm cache directory
44+
.npm
45+
46+
# Optional eslint cache
47+
.eslintcache
48+
49+
# Microbundle cache
50+
.rpt2_cache/
51+
.rts2_cache_cjs/
52+
.rts2_cache_es/
53+
.rts2_cache_umd/
54+
55+
# Optional REPL history
56+
.node_repl_history
57+
58+
# Output of 'npm pack'
59+
*.tgz
60+
61+
# Yarn Integrity file
62+
.yarn-integrity
63+
64+
# parcel-bundler cache (https://parceljs.org/)
65+
.cache
66+
.parcel-cache
67+
68+
# Next.js build output
69+
.next
70+
71+
# Nuxt.js build / generate output
72+
.nuxt
73+
dist
74+
75+
# Gatsby files
76+
.cache/
77+
public
78+
79+
# Storybook build outputs
80+
.out
81+
.storybook-out
82+
83+
# Temporary folders
84+
tmp/
85+
temp/
86+
87+
# Editor directories and files
88+
.vscode/
89+
.idea/
90+
*.swp
91+
*.swo
92+
*~
93+
94+
# OS generated files
95+
.DS_Store
96+
.DS_Store?
97+
._*
98+
.Spotlight-V100
99+
.Trashes
100+
ehthumbs.db
101+
Thumbs.db

.npmignore

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Source files (only dist/ should be published)
2+
src/
3+
tsconfig.json
4+
tsup.config.ts
5+
6+
# Tests and coverage
7+
__tests__/
8+
*.test.ts
9+
*.test.js
10+
*.spec.ts
11+
*.spec.js
12+
coverage/
13+
jest.config.js
14+
15+
# Examples and documentation
16+
examples/
17+
PUBLISH.md
18+
19+
# Development dependencies and configuration
20+
node_modules/
21+
.git/
22+
.gitignore
23+
24+
# IDE and editor files
25+
.vscode/
26+
.idea/
27+
*.swp
28+
*.swo
29+
*~
30+
31+
# OS generated files
32+
.DS_Store
33+
.DS_Store?
34+
._*
35+
.Spotlight-V100
36+
.Trashes
37+
ehthumbs.db
38+
Thumbs.db
39+
40+
# Logs
41+
npm-debug.log*
42+
yarn-debug.log*
43+
yarn-error.log*
44+
lerna-debug.log*
45+
46+
# Runtime data
47+
pids
48+
*.pid
49+
*.seed
50+
*.pid.lock
51+
52+
# Environment files
53+
.env
54+
.env.local
55+
.env.development.local
56+
.env.test.local
57+
.env.production.local
58+
59+
# Cache directories
60+
.npm
61+
.eslintcache
62+
.rpt2_cache/
63+
.rts2_cache_cjs/
64+
.rts2_cache_es/
65+
.rts2_cache_umd/
66+
67+
# Build artifacts (keep only dist/)
68+
build/
69+
lib/
70+
out/
71+
72+
# Temporary folders
73+
tmp/
74+
temp/
75+
76+
# Package files
77+
*.tgz
78+
79+
# Yarn
80+
.yarn-integrity
81+
yarn.lock
82+
83+
# Optional npm cache directory
84+
.npm
85+
86+
# TypeScript cache
87+
*.tsbuildinfo

PUBLISH.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Publishing Guide
2+
3+
### Step 1: Version the Package
4+
5+
```bash
6+
# For patch releases (bug fixes)
7+
npm version patch
8+
9+
# For minor releases (new features)
10+
npm version minor
11+
12+
# For major releases (breaking changes)
13+
npm version major
14+
15+
# Or set version manually
16+
npm version 1.0.0
17+
```
18+
19+
### Step 2: Review Package Contents
20+
21+
```bash
22+
# See what files will be published
23+
npm pack --dry-run
24+
25+
# Create a test package (optional)
26+
npm pack
27+
```
28+
29+
The package should include:
30+
31+
-`dist/` directory with built files
32+
-`package.json`
33+
-`README.md`
34+
-`src/` directory (excluded)
35+
-`examples/` directory (excluded)
36+
- ❌ Test files (excluded)
37+
38+
### Step 3: Publish to npm
39+
40+
```bash
41+
# Login to npm (if not already logged in)
42+
npm login
43+
44+
# Publish the package
45+
npm publish
46+
47+
# For scoped packages or first-time publishing
48+
npm publish --access public
49+
```

0 commit comments

Comments
 (0)