@@ -29,39 +29,37 @@ yarn add @nexgenstudiodev/fastkit
2929
3030The following scripts are available via ` npm run <script> ` or ` pnpm run <script> ` :
3131
32- | Script | Description |
33- | ------------------| --------------------------------------------------|
34- | ` build ` | Compile TypeScript to JavaScript using ` tsc ` |
35- | ` clean ` | Delete the ` dist ` directory using ` rimraf ` |
36- | ` rebuild ` | Clean and then build (npm version) |
37- | ` rebuild:pnpm ` | Clean and then build (pnpm version) |
38- | ` lint ` | Run ESLint on all ` .ts ` and ` .tsx ` files in ` src/ ` |
39- | ` lint:fix ` | Automatically fix linting issues |
40- | ` test ` | Run tests with Jest |
41- | ` test:watch ` | Watch files and re-run tests on change |
42- | ` test:coverage ` | Run tests and generate coverage report |
43- | ` start:dev ` | Start development mode using ` ts-node-dev ` |
44- | ` format ` | Format all supported files in ` src/ ` using Prettier |
45- | ` prepublishOnly ` | Format, lint, and build before publishing (npm lifecycle hook) |
46- | ` publish:npm ` | Publish the package to npm (with public access) |
47- | ` publish:pnpm ` | Publish the package using pnpm (skip git checks) |
48- | ` version:patch ` | Bump patch version using npm |
49- | ` version:minor ` | Bump minor version using npm |
50- | ` version:major ` | Bump major version using npm |
32+ ## 🔧 Development Scripts
33+
34+ The following scripts are available via ` npm run <script> ` or ` pnpm run <script> ` :
35+
36+
5137
5238
5339### 📦 SETUP.md – NPM Token Authentication with .env and CLI
5440
5541
56- #### Load the Token in CLI
42+ | Script | Description |
43+ | --------------------| ------------------------------------------------------------------|
44+ | ** build** | Compile TypeScript using ` tsc ` and fix paths using ` tsc-alias ` |
45+ | ** clean** | Delete the ` dist ` directory using ` rimraf ` |
46+ | ** rebuild** | Clean and then build the project |
47+ | ** lint** | Run ESLint on all ` .ts ` and ` .tsx ` files in ` src/ ` |
48+ | ** lint: fix ** | Automatically fix lint issues |
49+ | ** format** | Format source files using Prettier |
50+ | ** test** | Run all tests using Jest |
51+ | ** test: watch ** | Watch and re-run tests on file changes |
52+ | ** test: coverage ** | Generate code coverage report |
53+ | ** start: dev ** | Start dev server using ` ts-node-dev ` |
54+ | ** prepublishOnly** | Hook to format, lint, and build before publishing |
55+ | ** publish: npm ** | Publish package to npm using npm CLI |
56+ | ** publish: pnpm ** | Publish package to npm using pnpm (skip git checks) |
57+ | ** version: patch ** | Bump patch version |
58+ | ** version: minor ** | Bump minor version |
59+ | ** version: major ** | Bump major version |
60+ | ** add** | * (Your custom script — specify its function if needed)* |
5761
58- | Platform | Set NPM_TOKEN Command | Check Authentication Command | Purpose |
59- | -------------------------| --------------------------------------| ---------------------------------| -----------------------------|
60- | ** Windows (PowerShell)** | ` $env:NPM_TOKEN="your-token" ` | ` npm whoami ` | Set token / Verify identity |
61- | ** macOS / Linux / WSL** | ` export NPM_TOKEN="your-token" ` | ` npm whoami ` | Set token / Verify identity |
62- | ** Cross-platform One-liner** | ` NPM_TOKEN="your-token" npm publish ` | ` NPM_TOKEN="your-token" npm whoami ` | Publish / Verify identity |
6362
64- > ** Note:** Replace ` "your-token" ` with your actual NPM token. These commands temporarily set the token only for the current shell session. Avoid exposing your token in shared or public environments.
6563
6664
6765### 🚀 Publishing Workflow
0 commit comments