Skip to content

Commit 3a8c96e

Browse files
committed
chore: chore: update package manager version and enhance README with local testing instructions
- Bumped package manager version in package.json to [email protected]. - Added detailed local testing options in README for better developer experience.
1 parent 3932794 commit 3a8c96e

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ git clone https://github.com/arkahna/git-file-fetch.git
2626
cd git-file-fetch
2727
pnpm install
2828
pnpm build
29-
node dist/index.js "https://github.com/octokit/core.js.git@main:LICENSE" --dry-run
3029
```
3130

3231
**Available development commands:**
@@ -36,6 +35,45 @@ node dist/index.js "https://github.com/octokit/core.js.git@main:LICENSE" --dry-r
3635
- `pnpm lint` - Run ESLint with auto-fix
3736
- `pnpm test:smoke` - Run smoke test
3837

38+
## Local Testing (Before npm Publish)
39+
40+
### Option 1: Link Globally (Recommended)
41+
Test the tool as if it were installed from npm:
42+
```bash
43+
# In the git-file-fetch directory
44+
pnpm install
45+
pnpm build
46+
npm link
47+
48+
# Now use from anywhere on your system
49+
git-file-fetch "https://github.com/octokit/core.js.git@main:LICENSE"
50+
51+
# To unlink later
52+
npm unlink -g @arkahna-npm/git-file-fetch
53+
```
54+
55+
### Option 2: Direct Execution
56+
Quick testing during development:
57+
```bash
58+
# Using built version
59+
node dist/index.js "https://github.com/octokit/core.js.git@main:LICENSE" --dry-run
60+
61+
# Or run TypeScript directly (no build needed)
62+
pnpm start "https://github.com/octokit/core.js.git@main:LICENSE" --dry-run
63+
```
64+
65+
### Option 3: Test in Another Project
66+
Most realistic test of the published package:
67+
```bash
68+
# In git-file-fetch directory
69+
pnpm pack
70+
# Creates: arkahna-npm-git-file-fetch-0.1.0.tgz
71+
72+
# In your test project
73+
npm install /path/to/git-file-fetch/arkahna-npm-git-file-fetch-0.1.0.tgz
74+
npx git-file-fetch "https://github.com/user/repo.git@main:file.ts"
75+
```
76+
3977
## What it does
4078

4179
- **Shallow Fetch**: Performs a shallow fetch of the target ref without a full clone

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"dist",
5959
"plugin"
6060
],
61-
"packageManager": "pnpm@10.17.1+sha512.17c560fca4867ae9473a3899ad84a88334914f379be46d455cbf92e5cf4b39d34985d452d2583baf19967fa76cb5c17bc9e245529d0b98745721aa7200ecaf7a",
61+
"packageManager": "pnpm@10.18.1+sha512.77a884a165cbba2d8d1c19e3b4880eee6d2fcabd0d879121e282196b80042351d5eb3ca0935fa599da1dc51265cc68816ad2bddd2a2de5ea9fdf92adbec7cd34",
6262
"publishConfig": {
6363
"access": "public",
6464
"provenance": true

0 commit comments

Comments
 (0)