Skip to content

Commit c9feadc

Browse files
feat: add comprehensive documentation and setup for both npm and pnpm support
- Bump version to 1.0.1 - Add README.md with detailed usage examples and documentation - Add LICENSE.md with MIT license - Add CONTRIBUTING.md with contribution guidelines - Add CHANGELOG.md for version tracking - Update .gitignore with comprehensive exclusions - Add .npmignore for proper package publishing - Add .pnpmrc for pnpm configuration - Add scripts for both npm and pnpm workflows - Setup proper package publishing configuration
1 parent a776d18 commit c9feadc

2 files changed

Lines changed: 21 additions & 3 deletions

File tree

.pnpmrc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# pnpm configuration
2+
shamefully-hoist=false
3+
strict-peer-dependencies=false
4+
auto-install-peers=true
5+
save-exact=false
6+
save-prefix=^
7+
node-linker=isolated
8+
prefer-workspace-packages=true
9+
git-checks=true
10+
publish-branch=main

package.json

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@abhishek-nexgen-dev/fastkit",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "A modular, class-based toolkit for fast API development with TypeScript and Express.",
55
"main": "dist/FastKit.js",
66
"types": "dist/FastKit.d.ts",
@@ -9,12 +9,20 @@
99
],
1010
"scripts": {
1111
"build": "tsc",
12+
"clean": "rimraf dist",
13+
"rebuild": "npm run clean && npm run build",
14+
"rebuild:pnpm": "pnpm run clean && pnpm run build",
1215
"lint": "eslint src/**/*.{ts,tsx}",
1316
"lint:fix": "eslint src/**/*.{ts,tsx} --fix",
1417
"start:dev": "ts-node-dev --respawn --transpile-only src/FastKit.ts",
1518
"format": "prettier --write 'src/**/*.{ts,tsx,js,json,md}'",
16-
"publish": "npm publish --access public",
17-
"prepublishOnly": "pnpm run format && pnpm run lint && pnpm run build"
19+
"prepublishOnly": "npm run format && npm run lint && npm run build",
20+
"publish:npm": "npm publish --access public",
21+
"publish:pnpm": "pnpm publish --access public",
22+
"version:patch": "npm version patch",
23+
"version:minor": "npm version minor",
24+
"version:major": "npm version major",
25+
"test": "echo \"Error: no test specified\" && exit 1"
1826
},
1927
"keywords": [
2028
"api",

0 commit comments

Comments
 (0)