Skip to content

Commit f1e7aa0

Browse files
Merge branch 'master' into dev
2 parents dd4e7ee + 4ae6f1a commit f1e7aa0

53 files changed

Lines changed: 1291 additions & 1719 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.env.fastkit

Lines changed: 0 additions & 70 deletions
This file was deleted.

.npmignore

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,30 @@ src/
33
*.ts
44
!*.d.ts
55

6-
# Development files
6+
# Development config files
77
.eslintrc.*
88
.prettierrc*
99
tsconfig*.json
1010
jest.config.*
1111
*.test.*
1212
*.spec.*
1313

14-
1514
# Documentation (except README)
1615
docs/
1716
CONTRIBUTING.md
1817
CHANGELOG.md
1918

20-
# Git files
19+
# Git files and folders
2120
.git/
2221
.gitignore
2322
Environment/
2423

25-
# CI/CD
24+
# CI/CD config
2625
.github/
2726
.travis.yml
2827
.circleci/
2928

30-
# Editor files
29+
# Editor and IDE files
3130
.vscode/
3231
.idea/
3332
*.sublime-*
@@ -36,7 +35,7 @@ Environment/
3635
.DS_Store
3736
Thumbs.db
3837

39-
# Package manager
38+
# Package manager lock files and folders
4039
pnpm-lock.yaml
4140
yarn.lock
4241
.pnp.*
@@ -46,23 +45,23 @@ yarn.lock
4645
logs/
4746
*.log
4847

49-
# Runtime data
48+
# Runtime data files
5049
pids/
5150
*.pid
5251
*.seed
5352
*.pid.lock
5453

55-
# Coverage
54+
# Coverage reports
5655
coverage/
5756
.nyc_output/
5857

5958
# Dependencies
6059
node_modules/
6160

62-
# Build tools
61+
# Build tools and cache
6362
.tsbuildinfo
6463

65-
# Temporary files
64+
# Temporary files and folders
6665
tmp/
6766
temp/
6867

.pnpmfile.mjs

Lines changed: 0 additions & 18 deletions
This file was deleted.

.prettierignore

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
# Ignore artifacts:
2-
build
3-
coverage
4-
node_modules
5-
dist
6-
.env
1+
# Ignore build output
2+
build/
3+
dist/
4+
5+
# Ignore coverage reports
6+
coverage/
7+
8+
# Ignore dependencies
9+
node_modules/
10+
11+
# Ignore environment files
12+
.env
13+
.env.local
14+
.env.development.local

PACKAGE_MANAGERS.md

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -29,39 +29,37 @@ yarn add @nexgenstudiodev/fastkit
2929

3030
The 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

Comments
 (0)