Skip to content

Commit e5b2dc2

Browse files
committed
chore: prepare package for NPM publishing
- Add NPM publishConfig (public access, registry URL) - Add modern exports field for Node.js/TypeScript compatibility - Enhance package description with detailed feature list - Expand keywords for better discoverability - Add engines field (Node.js >=18.0.0) - Update author information with complete contact details - Add .npmignore for clean package distribution - Add prepublishOnly script Package ready for NPM publication.
1 parent 69d19b4 commit e5b2dc2

File tree

2 files changed

+88
-14
lines changed

2 files changed

+88
-14
lines changed

.npmignore

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Source files
2+
src/
3+
*.ts
4+
!*.d.ts
5+
6+
# Tests
7+
tests/
8+
__tests__/
9+
*.test.ts
10+
*.spec.ts
11+
12+
# Build configs
13+
tsconfig.json
14+
vitest.config.ts
15+
eslint.config.js
16+
17+
# Development files
18+
.vscode/
19+
.idea/
20+
*.log
21+
.DS_Store
22+
23+
# Git
24+
.git/
25+
.gitignore
26+
27+
# Documentation (keep README.md)
28+
docs/
29+
*.md
30+
!README.md
31+
32+
# CI/CD
33+
.github/

package.json

Lines changed: 55 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,43 @@
11
{
22
"name": "omniscript-converters",
33
"version": "0.5.6",
4-
"description": "Format converters for OmniScript Format (OSF) - Convert to/from DOCX, PPTX, XLSX, PDF",
4+
"description": "Format converters for OmniScript Format (OSF) - Convert OSF documents to DOCX, PPTX, XLSX, and PDF with enterprise-grade quality",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",
7+
"exports": {
8+
".": {
9+
"types": "./dist/index.d.ts",
10+
"import": "./dist/index.js",
11+
"require": "./dist/index.js"
12+
}
13+
},
14+
"files": [
15+
"dist/**/*",
16+
"README.md",
17+
"LICENSE"
18+
],
19+
"publishConfig": {
20+
"access": "public",
21+
"registry": "https://registry.npmjs.org/"
22+
},
23+
"repository": {
24+
"type": "git",
25+
"url": "https://github.com/OmniScriptOSF/omniscript-core.git",
26+
"directory": "omniscript-converters"
27+
},
28+
"bugs": {
29+
"url": "https://github.com/OmniScriptOSF/omniscript-core/issues"
30+
},
31+
"homepage": "https://github.com/OmniScriptOSF/omniscript-core/tree/main/omniscript-converters#readme",
732
"scripts": {
833
"build": "pnpm exec tsc",
934
"dev": "pnpm exec tsc --watch",
1035
"test": "pnpm exec vitest",
1136
"lint": "pnpm exec eslint src --ext .ts",
1237
"clean": "pnpm exec rimraf dist",
13-
"typecheck": "pnpm exec tsc --noEmit"
38+
"typecheck": "pnpm exec tsc --noEmit",
39+
"prepublishOnly": "pnpm run build"
1440
},
15-
"keywords": ["osf", "omniscript", "converter", "docx", "pptx", "xlsx", "pdf"],
16-
"author": "Alphin Tom",
17-
"license": "MIT",
1841
"dependencies": {
1942
"omniscript-parser": "^0.5.6",
2043
"docx": "^8.5.0",
@@ -33,14 +56,32 @@
3356
"peerDependencies": {
3457
"omniscript-parser": "^0.5.0"
3558
},
36-
"files": [
37-
"dist/**/*",
38-
"README.md",
39-
"LICENSE"
59+
"engines": {
60+
"node": ">=18.0.0"
61+
},
62+
"keywords": [
63+
"osf",
64+
"omniscript",
65+
"converter",
66+
"docx",
67+
"pptx",
68+
"xlsx",
69+
"pdf",
70+
"word",
71+
"powerpoint",
72+
"excel",
73+
"document",
74+
"presentation",
75+
"spreadsheet",
76+
"export",
77+
"format",
78+
"conversion",
79+
"typescript"
4080
],
41-
"repository": {
42-
"type": "git",
43-
"url": "https://github.com/OmniScriptOSF/omniscript-core.git",
44-
"directory": "omniscript-converters"
45-
}
81+
"author": {
82+
"name": "Alphin Tom",
83+
"email": "alpha912@github.com",
84+
"url": "https://github.com/alpha912"
85+
},
86+
"license": "MIT"
4687
}

0 commit comments

Comments
 (0)