gitpick 6.0.0 → 6.0.2

package/README.md

@@ -9,11 +9,11 @@
 [![downloads](https://img.shields.io/npm/dt/gitpick?color=red&logo=npm)](https://www.npmjs.com/package/gitpick)
 [![stars](https://img.shields.io/github/stars/nrjdalal/gitpick?color=blue)](https://github.com/nrjdalal/gitpick)
 
-📦 `Zero dependencies` / `Un/packed (~67/25kb)` / `Faster and more features` yet drop-in replacement for `degit`
+📦 `Zero dependencies` / `Un/packed (~72/26kb)` / `Faster and more features` yet drop-in replacement for `degit`
 
 > #### Just `copy-and-paste` any GitHub, GitLab, Bitbucket or Codeberg URL - no editing required (shorthands work too) - to clone individual files, folders, branches, commits, raw content or even entire repositories without the `.git` directory.
 
-Unlike other tools that force you to tweak URLs or follow strict formats to clone files, folders, branches or commits GitPick works seamlessly with any URL.
+Unlike other tools that force you to tweak URLs or follow strict formats to clone files, folders, branches or commits, GitPick works seamlessly with any URL.
 
 **You can also try [Interactive Mode](#-interactive-mode)**. Browse any repo right in your terminal. See every file, pick what you want, skip what you don't. Just `gitpick owner/repo -i` and you're in. No more guessing paths.
 
@@ -30,6 +30,7 @@ Unlike other tools that force you to tweak URLs or follow strict formats to clon
 - [Interactive Mode](#-interactive-mode)
 - [Private Repos](#-private-repos)
 - [Config File](#-config-file)
+- [.gitpickignore](#-gitpickignore)
 - [Install Globally](#-install-globally-optional)
 - [Used By](#-used-by)
 - [Related Projects](#-related-projects)
@@ -39,7 +40,7 @@ Unlike other tools that force you to tweak URLs or follow strict formats to clon
 
 ## 📖 Some Examples
 
-### See [Quick Usage](#-quick-usage) for to learn more.
+See [Quick Usage](#-quick-usage) to learn more.
 
 ```sh
 # interactive mode - browse and pick files/folders
@@ -87,19 +88,19 @@ npx gitpick owner/repo -i --dry-run
 
 - 🔍 Clone individual files or folders from GitHub, GitLab, Bitbucket and Codeberg
 - 🧠 Use shorthands `TanStack/router` or full URL's `https://github.com/TanStack/router`
-- ⚙️ Auto-detects branches and target directory (if not specified) like `git clone`
 - **🔥 Interactive mode** - browse and cherry-pick files/folders with `-i` | `--interactive`
+- ⚙️ Auto-detects branches and target directory (if not specified) like `git clone`
 - 🔐 Seamlessly works with both public and private repositories using a PAT
 - 📦 Can easily clone all submodules with `-r` | `--recursive`
+- 🚫 `.gitpickignore` at the root of the picked path excludes matching paths from the copy (gitignore-style patterns)
 - 🧱 Initialize the cloned output as a fresh git repo with `--init`
-- 💾 Create an initial commit with `--commit "<msg>"` (or `--auto-commit`, which uses `chore: gitpick'ed`) — implies `--init`
+- 💾 Commit with `--commit "<msg>"` (or `--auto-commit`, which uses `chore: gitpick'ed`) - implies `--init`
+- 🔁 Sync changes remotely with `--watch` using intervals (e.g., `15s`, `1m`, `1h`)
 - 🔎 Preview what would be cloned with `--dry-run` before cloning
 - 🌳 View cloned file structure as a colored tree with `--tree`
 - 🗑️ Overwrite or replace existing files without a prompt using `-o` | `--overwrite`
-- 🔁 Sync changes remotely with `--watch` using intervals (e.g., `15s`, `1m`, `1h`)
-- 🔇 Silent mode with `--quiet` for CI pipelines, debug mode with `--verbose`
 - 📋 Config file support (`.gitpick.json` / `.gitpick.jsonc`) for multi-path picks
-- 🚫 `.gitpickignore` at the root of the picked path excludes matching paths from the copy (gitignore-style patterns)
+- 🔇 Silent mode with `--quiet` for CI pipelines, debug mode with `--verbose`
 
 ---
 
@@ -126,8 +127,8 @@ npx gitpick <url/shorthand> -r                      # clone submodules
 npx gitpick <url/shorthand> --dry-run               # preview without cloning
 npx gitpick <url/shorthand> -w 30s                  # sync every 30 seconds
 npx gitpick <url/shorthand> --init                  # initialize as a new git repository
-npx gitpick <url/shorthand> --auto-commit           # init + commit with message "chore: gitpick'ed"
-npx gitpick <url/shorthand> --commit "gitpick'ed"   # init + commit with a message
+npx gitpick <url/shorthand> --auto-commit           # Commit with message "chore: gitpick'ed"
+npx gitpick <url/shorthand> --commit "gitpick'ed"   # Commit with a message
 npx gitpick https://<token>@github.com/owner/repo   # private repository
 npx gitpick https://gitlab.com/owner/repo           # GitLab
 npx gitpick https://bitbucket.org/owner/repo        # Bitbucket
@@ -150,8 +151,8 @@ npx gitpick https://codeberg.org/owner/repo         # Codeberg
 -w, --watch [time]  Watch the repository and sync every [time]
                     (e.g. 1h, 30m, 15s)
     --init          Initialize the cloned output as a new git repository
-    --auto-commit   Create an initial commit with message "chore: gitpick'ed" (implies --init)
-    --commit <msg>  Create an initial commit with <msg> (implies --init)
+    --auto-commit   Commit with message "chore: gitpick'ed" (implies --init)
+    --commit <msg>  Commit with <msg> (implies --init)
     --tree          List copied files as a tree
     --verbose       Show detailed clone information
 -h, --help          display help for command
@@ -174,7 +175,19 @@ npx gitpick https://codeberg.org/owner/repo -i
 
 <img width="900" alt="gitpick interactive mode: browse and pick files/folders" src="https://raw.githubusercontent.com/nrjdalal/demo-kit/main/gitpick/demo-interactive.gif" />
 
-Navigate with arrow keys, select with space, expand/collapse with enter, `.` to select all, `c` to confirm. Works with GitHub, GitLab, Bitbucket, Codeberg, public and private repos.
+Navigate with arrow keys, `space` to select, `enter` to expand a folder or preview a file, `.` to select all, `c` to confirm, `q` to quit. File previews come with syntax highlighting for 38 languages. Works with GitHub, GitLab, Bitbucket, Codeberg, public and private repos.
+
+### Pick from a local folder
+
+Interactive mode also works on any folder already on your machine, so you can use GitPick as a local file cherry-picker:
+
+```sh
+npx gitpick -i                 # browse the current directory
+npx gitpick -i my-app          # browse cwd, copy the selection into ./my-app
+npx gitpick ./src -i my-app    # browse ./src, copy the selection into ./my-app
+```
+
+Inside a git repo it respects your `.gitignore` (via `git ls-files`) and preserves symlinks when copying.
 
 ---
 
@@ -255,6 +268,36 @@ Each entry follows the same `<url> [target]` syntax as the CLI. All entries are
 
 ---
 
+## 🚫 .gitpickignore
+
+Add a `.gitpickignore` file at the root of the path you are picking to keep matching files out of the copy. It uses gitignore-style patterns, so the syntax is already familiar:
+
+```gitignore
+# .gitpickignore lives at the root of the picked folder or repo
+
+# any .log file, at any depth
+*.log
+
+# a directory named node_modules, anywhere (trailing slash means directory only)
+node_modules/
+
+# only the dist at the picked root (a leading slash anchors the pattern)
+/dist
+
+# every png under docs, at any depth
+docs/**/*.png
+
+# re-include a file an earlier rule excluded (! negates, last match wins)
+!docs/logo.png
+```
+
+- The file must sit at the **root of what you pick** - the folder for a `tree` URL, or the repo root for a full clone.
+- `*` matches within a path segment, `**` spans directories, `?` matches a single character, and a trailing `/` limits a rule to directories.
+- A leading or embedded `/` anchors a pattern to the picked root; otherwise it matches by basename at any depth.
+- Full-line `#` comments and blank lines are ignored, and the `.gitpickignore` file itself is never copied.
+
+---
+
 ## 📦 Install Globally (Optional)
 
 ```sh
@@ -262,6 +305,8 @@ npm install -g gitpick
 gitpick <url/shorthand> [target] [options]
 ```
 
+This installs two commands, `gitpick` and `degit`, so existing `degit owner/repo` workflows keep working unchanged.
+
 ---
 
 ## 🌍 Used By
@@ -299,4 +344,4 @@ Thank you for helping improve GitPick!
 
 ## 📄 License
 
-MIT – [LICENSE](LICENSE)
+MIT - [LICENSE](LICENSE)

package/dist/index.mjs

@@ -19,7 +19,7 @@ Skipping commit: nothing was cloned to commit.`));return}let u=i.commit||`chore:
 `;let s=f.length>r?E(`${l+1}-${Math.min(l+r,f.length)}/${f.length}`)+E(` • `):``,d=E(`↑↓:navigate  esc/q:back`);i+=`  ${s}${d}\n`,u.write(i)}function S(e){let t=e.toString();if(t===``){g=!1,_=null,d.removeListener(`data`,S),p(),process.removeListener(`exit`,m),process.removeListener(`SIGINT`,h),a([]);return}if(t===`\x1B`||t===`q`||t===`Q`||t===`\r`){g=!1,_=null,d.removeListener(`data`,S),d.on(`data`,x),y();return}(t===`\x1B[A`||t===`k`)&&c>0&&c--,(t===`\x1B[B`||t===`j`)&&c<f.length-1&&c++,b()}g=!0,_=b,d.on(`data`,S),b()}function x(e){let t=qn(o),n=t.length+1,r=e.toString();if(r===``||r===`q`||r===`Q`){p(),process.removeListener(`exit`,m),process.removeListener(`SIGINT`,h),a([]);return}if(r===`c`||r===`C`){p(),process.removeListener(`exit`,m),process.removeListener(`SIGINT`,h),a(Xn(o));return}if((r===`\x1B[A`||r===`k`)&&c>0&&c--,(r===`\x1B[B`||r===`j`)&&c<n-1&&c++,c===0&&(r===` `||r===`\r`)||r===`.`){let e=o.every(e=>e.selected);for(let t of o)W(t,!e)}if(r===` `&&c>0){let e=t[c-1];if(e){let t=!e.node.selected;if(W(e.node,t),t&&e.node.type===`symlink`&&e.node.linkTarget){let t=G(o,Jn(e.node.path,e.node.linkTarget));t&&W(t,!0)}Yn(o)}}if(r===`\r`&&c>0){let e=t[c-1];if(e&&e.node.type===`tree`)e.node.expanded=!e.node.expanded;else if(e&&e.node.type===`symlink`&&e.node.linkTarget.endsWith(`/`)){let t=Jn(e.node.path,e.node.linkTarget),n=t.split(`/`);for(let e=1;e<=n.length;e++){let t=G(o,n.slice(0,e).join(`/`));t&&t.type===`tree`&&(t.expanded=!0)}let r=G(o,t);if(r){r.type===`tree`&&(r.expanded=!0);let e=qn(o).findIndex(e=>e.node===r);e>=0&&(c=e+1)}}else if(e&&i&&(e.node.type===`blob`||e.node.type===`symlink`)){b(e.node);return}}if((r===`\x1B[C`||r===`l`)&&c>0){let e=t[c-1];e&&e.node.type===`tree`&&(e.node.expanded=!0)}if((r===`\x1B[D`||r===`h`)&&c>0){let e=t[c-1];e&&e.node.type===`tree`&&(e.node.expanded=!1)}y()}d.on(`data`,x),y()})}function $n(e){if(typeof e==`number`||/^\d+$/.test(e))return typeof e==`number`?e:parseInt(e,10);let t=/(\d+)([hms])/g,n=0,r;for(;(r=t.exec(e))!==null;){let e=parseInt(r[1],10);switch(r[2]){case`h`:n+=e*36e5;break;case`m`:n+=e*6e4;break;case`s`:n+=e*1e3;break}}return n}const q=async e=>{let t=(await S(`git`,[`ls-remote`,e])).stdout,n=t.match(/(.+)\s+HEAD/)?.[1],r=t.match(RegExp(`${n}\\s+refs/heads/(.+)`))?.[1];if(!r)throw Error(`Could not determine default branch!`);return r},er=[{prefix:`git@github.com:`,host:`github.com`},{prefix:`https://github.com/`,host:`github.com`},{prefix:`https://raw.githubusercontent.com/`,host:`github.com`},{prefix:`git@gitlab.com:`,host:`gitlab.com`},{prefix:`https://gitlab.com/`,host:`gitlab.com`},{prefix:`git@bitbucket.org:`,host:`bitbucket.org`},{prefix:`https://bitbucket.org/`,host:`bitbucket.org`},{prefix:`git@codeberg.org:`,host:`codeberg.org`},{prefix:`https://codeberg.org/`,host:`codeberg.org`}];async function tr(e,{branch:t,target:n}){let r=e.match(/^https:\/\/([^@]+)@(github\.com|gitlab\.com|bitbucket\.org|codeberg\.org)/),i=``;if(r)i=r[1],e=e.replace(`${r[1]}@`,``);else{let t={"github.com":process.env.GITHUB_TOKEN||process.env.GH_TOKEN||``,"gitlab.com":process.env.GITLAB_TOKEN||``,"bitbucket.org":process.env.BITBUCKET_TOKEN||``,"codeberg.org":process.env.CODEBERG_TOKEN||``};for(let{prefix:n,host:r}of er)if(e.startsWith(n)){i=t[r];break}!i&&!e.startsWith(`https://`)&&!e.startsWith(`git@`)&&(i=t[`github.com`])}let a=`github.com`;for(let{prefix:t,host:n}of er)if(e.startsWith(t)){a=n,e=e.replace(t,``);break}let o=e.split(`/`),s=o[0],c=o[1]?.endsWith(`.git`)?o[1].slice(0,-4):o[1],l=`https://${i&&i+`@`}${a}/${s}/${c}`,u,d,f;if(a===`github.com`)o[2]===`refs`&&[`heads`,`tags`].includes(o[3])?(u=`raw`,d=t||o[4],f=o.slice(5).join(`/`)):o[2]===`refs`&&o[3]===`remotes`?(u=`raw`,d=t||`${o[4]}/${o[5]}`,f=o.slice(6).join(`/`)):o[2]===`blob`?(u=`blob`,d=t||o[3],f=o.slice(4).join(`/`)):o[2]===`tree`?(u=`tree`,d=t||o[3],f=o.slice(4).join(`/`)):o[2]===`commit`?(u=`repository`,d=t||o[3],f=``):(u=`repository`,d=t||await q(l),f=``);else if(a===`gitlab.com`)o[2]===`-`&&o[3]===`blob`?(u=`blob`,d=t||o[4],f=o.slice(5).join(`/`)):o[2]===`-`&&o[3]===`tree`?(u=`tree`,d=t||o[4],f=o.slice(5).join(`/`)):(u=`repository`,d=t||await q(l),f=``);else if(a===`bitbucket.org`)o[2]===`src`?(u=`tree`,d=t||o[3],f=o.slice(4).join(`/`)):(u=`repository`,d=t||await q(l),f=``);else if(a===`codeberg.org`)[`src`,`raw`,`media`].includes(o[2])&&[`branch`,`tag`,`commit`].includes(o[3])?(u=o[2]===`src`?`tree`:`blob`,d=t||o[4],f=o.slice(5).join(`/`)):(u=`repository`,d=t||await q(l),f=``);else{let e=a;throw Error(`Unsupported host: ${e}`)}let p=n||(u===`blob`?`.`:f.split(`/`).pop()||c),m=!t&&(u===`tree`||u===`blob`)?[d,...f?f.split(`/`):[]]:void 0;return{token:i,host:a,owner:s,repository:c,type:u,branch:d,path:f,target:p,refSegments:m}}const nr=n.join(t.homedir(),`.cache`,`gitpick`),rr=n.join(nr,`update-check.json`);function ir(){try{return JSON.parse(e.readFileSync(rr,`utf-8`))}catch{return null}}function ar(t){try{e.mkdirSync(nr,{recursive:!0}),e.writeFileSync(rr,JSON.stringify(t))}catch{}}function or(){return new Promise(e=>{let t=d.get(`https://registry.npmjs.org/gitpick/latest`,{headers:{Accept:`application/json`},timeout:3e3},t=>{if(t.statusCode!==200)return t.resume(),e(null);let n=``;t.on(`data`,e=>n+=e),t.on(`end`,()=>{try{e(JSON.parse(n).version||null)}catch{e(null)}})});t.on(`error`,()=>e(null)),t.on(`timeout`,()=>{t.destroy(),e(null)})})}function sr(e,t){let n=e.split(`.`).map(Number),r=t.split(`.`).map(Number);for(let e=0;e<3;e++){if((n[e]||0)>(r[e]||0))return!0;if((n[e]||0)<(r[e]||0))return!1}return!1}function J(e,t){if(t)return;let n=ir();n&&sr(n.latestVersion,e)&&console.log(E(`\n  Update available: ${k(e)} → ${A(T(n.latestVersion))}\n  Run ${A(`npm i -g gitpick`)} to update\n`))}function cr(){let e=ir();e&&Date.now()-e.lastCheck<864e5||setTimeout(async()=>{let e=await or();e&&ar({lastCheck:Date.now(),latestVersion:e})},0)}const Y=Symbol(`singleComment`),lr=Symbol(`multiComment`),X=(e,t,n)=>e.slice(t,n).replace(/[^ \t\r\n]/g,` `),ur=(e,t)=>{let n=t-1,r=0;for(;e[n]===`\\`;)--n,r+=1;return!!(r%2)};function dr(e){if(typeof e!=`string`)throw TypeError(`Expected argument \`jsonString\` to be a \`string\`, got \`${typeof e}\``);let t=!1,n=!1,r=0,i=``,a=``,o=-1;for(let s=0;s<e.length;s++){let c=e[s],l=e[s+1];if(!n&&c===`"`&&(ur(e,s)||(t=!t)),!t)if(!n&&c+l===`//`)i+=e.slice(r,s),r=s,n=Y,s++;else if(n===Y&&c+l===`\r
 `){s++,n=!1,i+=X(e,r,s),r=s;continue}else if(n===Y&&c===`
 `)n=!1,i+=X(e,r,s),r=s;else if(!n&&c+l===`/*`){i+=e.slice(r,s),r=s,n=lr,s++;continue}else if(n===lr&&c+l===`*/`){s++,n=!1,i+=X(e,r,s+1),r=s+1;continue}else n||(o===-1?c===`,`&&(a+=i+e.slice(r,s),i=``,r=s,o=s):c===`}`||c===`]`?(i+=e.slice(r,s),a+=X(i,0,1)+i.slice(1),i=``,r=s,o=-1):c!==` `&&c!==`	`&&c!==`\r`&&c!==`
-`&&(i+=e.slice(r,s),r=s,o=-1))}let s=n===Y?X(e,r):e.slice(r);return a+i+s}const fr=[`.gitpick.json`,`.gitpick.jsonc`],pr=async()=>{let t;for(let r of fr){let i=n.resolve(r);if(e.existsSync(i)){t=i;break}}if(!t)return!1;let r=await e.promises.readFile(t,`utf-8`),i=JSON.parse(dr(r));if(!Array.isArray(i)||!i.every(e=>typeof e==`string`))throw Error(`${n.basename(t)} must be an array of strings`);for(let e of i)await S(process.argv[0],[...process.argv.slice(1),...e.split(/\s+/),`-o`],{stdio:`inherit`});return!0};var mr=`gitpick`,Z=`6.0.0`;const hr=(e,t)=>`\x1b]8;;${t}\x07${e}\x1b]8;;\x07`,gr=`
+`&&(i+=e.slice(r,s),r=s,o=-1))}let s=n===Y?X(e,r):e.slice(r);return a+i+s}const fr=[`.gitpick.json`,`.gitpick.jsonc`],pr=async()=>{let t;for(let r of fr){let i=n.resolve(r);if(e.existsSync(i)){t=i;break}}if(!t)return!1;let r=await e.promises.readFile(t,`utf-8`),i=JSON.parse(dr(r));if(!Array.isArray(i)||!i.every(e=>typeof e==`string`))throw Error(`${n.basename(t)} must be an array of strings`);for(let e of i)await S(process.argv[0],[...process.argv.slice(1),...e.split(/\s+/),`-o`],{stdio:`inherit`});return!0};var mr=`gitpick`,Z=`6.0.2`;const hr=(e,t)=>`\x1b]8;;${t}\x07${e}\x1b]8;;\x07`,gr=`
 With ${T(`${hr(`GitPick`,`https://github.com/nrjdalal/gitpick`)}`)} clone specific directories or files from GitHub, GitLab, Bitbucket and Codeberg!
 
   $ gitpick ${k(`<url>`)} ${O(`[target]`)} ${A(`[options]`)}
@@ -43,8 +43,8 @@ ${T(`Options:`)}
   ${A(`-w, --watch [time]`)}  Watch the repository and sync every [time]
                       (e.g. 1h, 30m, 15s)
   ${A(`    --init`)}          Initialize the cloned output as a new git repository
-  ${A(`    --auto-commit`)}   Create an initial commit with message "chore: gitpick'ed" (implies --init)
-  ${A(`    --commit <msg>`)}  Create an initial commit with <msg> (implies --init)
+  ${A(`    --auto-commit`)}   Commit with message "chore: gitpick'ed" (implies --init)
+  ${A(`    --commit <msg>`)}  Commit with <msg> (implies --init)
   ${A(`    --tree`)}          List copied files as a tree
   ${A(`    --verbose`)}       Show detailed clone information
   ${A(`-h, --help`)}          display help for command

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitpick",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "description": "Clone exactly what you need aka straightforward project scaffolding!",
   "keywords": [
     "clone",