@savaryna/git-add-account 2.0.2 → 2.2.0

package/README.md

@@ -1,8 +1,8 @@
 # @savaryna/add-git-account
 
-🔐 A small CLI app that allows you to easily add multiple GIT accounts on one machine. It switches between accounts automatically based on the workspace _(directory/subdirectory)_ you are in.
+🔐 A small CLI app that allows you to easily add multiple Git accounts on one machine. It switches between accounts automatically based on the workspace you are in.
 
-## Usage
+## CLI usage
 
 Run the command direcly with
 
@@ -10,7 +10,7 @@ Run the command direcly with
 npx @savaryna/git-add-account
 ```
 
-or if you want, first install it globally
+or if you installed it globally with
 
 ```shell
 npm i -g @savaryna/git-add-account
@@ -20,69 +20,32 @@ then you can run it using
 
 ```shell
 git-add-account
+# or the shorter version
+gaa
 ```
 
-or
+For usage and command details run it with the `--help` option.
 
-```shell
-gaa
-```
+After going through all the steps, you will be presented with your public SSH key so you can copy, and add it to your Git provider. For example GitHub[^1]:
+
+1. Copy the public SSH key.
+1. Go to the [SSH keys settings page](https://github.com/settings/keys).
+1. Click on `New SSH key`.
+1. Add the key as an `Authentication Key`.
+1. Click on `Add SSH key`.
+1. Add the same key again as a `Signing Key` if you chose to sign your work[^2].
+
+Done! Any `git` command you run from the workspace you chose **(and its subdirectories)**, will now use this new account automatically.
+
+## How it works
+
+A simple way to use multiple Git accounts on one machine is to use different SSH configs based on the directory you are in. The way [@savaryna/add-git-account](https://www.npmjs.com/package/@savaryna/git-add-account) works is, it asks you for some basic information and then it creates files under `.config/` in the workspace directory you specified.
 
-After going through all the steps, you will be presented with your public SSH key so you can copy, and add it to your GIT provider. For example GitHub[^1]:
-
-1. Go to your account [settings / keys](https://github.com/settings/keys)
-1. Click on `New SSH key`
-1. Give it a title
-1. Choose `Authentication Key` for key type
-1. Paste in the public SSH key copied earlier in the key field
-1. Click on `Add SSH key`
-1. Repeat steps **2 through 6** to add a `Signing Key` key type, if you chose to sign your work (Commits, Tags, Pushes)[^2]
-1. Done! Now, you can go to the workspace you chose for the account, ex: `cd /Users/john/code/work`, and all the `git`
-   commands issued from this, **or any other subdirectory**, will automatically use the correct account/ssh keys.
-
-## Example of how it works
-
-A simple way to use multiple git accounts on one machine is to use different SSH configs based on the directory you are in. The way [@savaryna/add-git-account](https://www.npmjs.com/package/@savaryna/git-add-account) works is, it asks you for some basic information and then it creates some files under `.config` in the workspace directory you specified. Ex:
-
-1. It creates a _(private/public)_ SSH keypair using `ssh-keygen -t ed25519 -C "john@github.com" -f /Users/john/code/work/.config/id_ed25519_git_github_com`. [See code](https://github.com/savaryna/git-add-account/blob/main/src/index.ts#L24-L25).
-1. It creates a `sshconfig` file. [See code](https://github.com/savaryna/git-add-account/blob/main/src/index.ts#L35-L49).
-
-   ```ini
-   # File at /Users/john/code/work/.config/sshconfig
-   # Config for GIT account john@github.com
-   Host github.com
-     HostName github.com
-     User git
-     AddKeysToAgent yes
-     UseKeychain yes
-     IdentitiesOnly yes
-     IdentityFile /Users/john/code/work/.config/id_ed25519_git_github_com
-   ```
-
-1. It creates a `gitconfig` file. [See code](https://github.com/savaryna/git-add-account/blob/main/src/index.ts#L51-L79).
-
-   ```ini
-   # File at /Users/john/code/work/.config/gitconfig
-   # Config for GIT account john@github.com
-   [user]
-     name = John Doe
-     email = john@github.com
-   [core]
-     sshCommand = ssh -F /Users/john/code/work/.config/sshconfig
-   [gpg]
-     format = ssh
-   [commit]
-     gpgsign = true
-   [push]
-     gpgsign = if-asked
-   [tag]
-     gpgsign = true
-   [user]
-     signingkey = /Users/john/code/work/.config/id_ed25519_git_github_com
-   ```
-
-1. It runs `git config --global includeIf.gitdir:/Users/john/code/work/.path /Users/john/code/work/.config/gitconfig`, this makes sure that as long as you are in the workspace created earlier, **or any other subdirectory**, git will use the config from step **3** automatically[^3]. [See code](https://github.com/savaryna/git-add-account/blob/main/src/index.ts#L81-L82).
-1. And finally, it presents you with your public SSH key so you can copy it and add it to your GIT provider of choice.
+1. It creates a private/public `ed25519` SSH keypair using `ssh-keygen` ([see code](https://github.com/savaryna/git-add-account/blob/main/src/helpers/config.ts#L28-L29)).
+1. It creates a `sshconfig` file based on this [template](https://github.com/savaryna/git-add-account/blob/main/src/templates/sshconfig.mustache).
+1. It creates a `gitconfig` file based on this [template](https://github.com/savaryna/git-add-account/blob/main/src/templates/gitconfig.mustache).
+1. It appends a conditional include to your global Git config based on this [template](https://github.com/savaryna/git-add-account/blob/main/src/templates/gitconfig.global.mustache). This makes sure that any `git` command you run from the workspace you chose **(and its subdirectories)**, will now use this new account automatically[^3].
+1. Finally, it presents you with your public SSH key so you can copy, and add it to your Git provider.
 
 ## License
 

package/bin/main.js

@@ -1,40 +1,42 @@
 #!/usr/bin/env node
-"use strict";var T=Object.create;var y=Object.defineProperty;var W=Object.getOwnPropertyDescriptor;var I=Object.getOwnPropertyNames;var _=Object.getPrototypeOf,H=Object.prototype.hasOwnProperty;var A=(t,e,s,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of I(e))!H.call(t,r)&&r!==s&&y(t,r,{get:()=>e[r],enumerable:!(o=W(e,r))||o.enumerable});return t};var F=(t,e,s)=>(s=t!=null?T(_(t)):{},A(e||!t||!t.__esModule?y(s,"default",{value:t,enumerable:!0}):s,t));var h=require("util"),d=require("child_process"),c=(0,h.promisify)(d.exec);var i=require("fs/promises"),n=require("os"),a=require("path"),u=(t,e)=>(0,i.writeFile)(t,e,"utf8"),v=t=>(0,i.rm)(t,{recursive:!0,force:!0}),w=t=>(0,i.access)(t,i.constants.R_OK|i.constants.W_OK).then(()=>!0,()=>!1);var g=require("zod"),L=t=>e=>{let{success:s,error:o}=t.safeParse(e);return s?!0:o.format()._errors[0]},l=L;var k=F(require("prompts")),O="2.34.0",S=()=>c("git --version").then(({stdout:t})=>t.split(" ")[2]),m=(t=0,e=null)=>{console.log(e?`
-${e}
-`:""),console.log(`${t?"\u{1F635} Exited.":"\u2728 Done."} Thanks for using @savaryna/git-add-account!
-`),process.exit(t)},x=(t,e)=>(0,k.default)(t,{onCancel:()=>m(1),...e}),P=t=>x({type:"toggle",name:"overwrite",message:`Path ${t} already exists. Overwrite?`,initial:!1,active:"yes",inactive:"no"}),$=async()=>{let t=await S();return x([{type:"text",name:"name",message:"Your name:",validate:l(g.z.string()),format:e=>({value:e,camel:e.toLowerCase().replace(/[^\w]/g,"_")})},{type:"text",name:"email",message:"Email to use for this account:",validate:l(g.z.string().email())},{type:"text",name:"host",message:"Host to use for this account:",initial:e=>e.split("@")[1],validate:l(g.z.string().transform(e=>"https://"+e).refine(URL.canParse,{message:"Invalid host"})),format:e=>({value:e,camel:e.replace(/[^\w]/g,"_")})},{type:"text",name:"workspace",message:"Workspace to use for this account:",initial:e=>(0,a.resolve)((0,n.homedir)(),"code",e.camel),validate:l(g.z.string().refine(e=>!e.startsWith("~"),{message:'"~" is not supported'})),format:(e,{host:s})=>{let o=(0,a.resolve)((0,n.homedir)(),e),r=(0,a.resolve)(o,".config"),f=`id_ed25519_git_${s.camel}`;return{root:o,config:r,gitConfig:(0,a.resolve)(r,"gitconfig"),sshConfig:(0,a.resolve)(r,"sshconfig"),privateKey:(0,a.resolve)(r,f),publicKey:(0,a.resolve)(r,f+".pub")}}},{type:"toggle",name:"signYourWork",message:"Do you want to sign your work with SSH?",initial:!0,active:"yes",inactive:"no"},{type:e=>e&&t<O?"toggle":null,name:"signYourWork",initial:!0,message:`Your current git version (${t}) does not support SSH signing. Continue without?`,active:"yes",inactive:"no",format:e=>e?!e:m(1)}])};async function Y(){let{name:t,email:e,host:s,workspace:o,signYourWork:r}=await $();if(await w(o.config)){let{overwrite:p}=await P(o.config);p?await v(o.config):m(1)}await(0,i.mkdir)(o.config,{recursive:!0}),await c(`ssh-keygen -t ed25519 -C "${e}" -f ${o.privateKey}`);let f=await c(`ssh-keygen -y -P "" -f ${o.privateKey}`).then(()=>!1,()=>!0).then(p=>p&&(0,n.platform)()==="darwin"),C=`
-    # Config for GIT account ${e}
-    Host ${s.value}
-      HostName ${s.value}
-      User git
-      AddKeysToAgent yes
-      ${f?"UseKeychain yes":""}
-      IdentitiesOnly yes
-      IdentityFile ${o.privateKey}
-  `.replace(/\n\s{4}/g,`
-`).concat(`
-`);await u(o.sshConfig,C);let K=`
-    # Config for GIT account ${e}
-    [user]
-      name = ${t.value}
-      email = ${e}
-    [core]
-      sshCommand = ssh -F ${o.sshConfig}
-    ${r?`
-    [gpg]
-      format = ssh
-    [commit]
-      gpgsign = true
-    [push]
-      gpgsign = if-asked
-    [tag]
-      gpgsign = true
-    [user]
-      signingkey = ${o.privateKey}
-    `:""}
-  `.replace(/\n\s{4}/g,`
-`).concat(`
-`);await u(o.gitConfig,K),await c(`git config --global includeIf.gitdir:${o.root}/.path ${o.gitConfig}`);let b=await(0,i.readFile)(o.publicKey).then(p=>p.toString().trim());console.log(`
+"use strict";var T=Object.create;var u=Object.defineProperty;var N=Object.getOwnPropertyDescriptor;var O=Object.getOwnPropertyNames;var I=Object.getPrototypeOf,Y=Object.prototype.hasOwnProperty;var j=(e,i,n,s)=>{if(i&&typeof i=="object"||typeof i=="function")for(let t of O(i))!Y.call(e,t)&&t!==n&&u(e,t,{get:()=>i[t],enumerable:!(s=N(i,t))||s.enumerable});return e};var d=(e,i,n)=>(n=e!=null?T(I(e)):{},j(i||!e||!e.__esModule?u(n,"default",{value:e,enumerable:!0}):n,e));var $=d(require("yargs")),S=require("yargs/helpers");var x=require("os"),A=require("path"),D=d(require("prompts"));var b=require("child_process"),w=require("fs"),a=require("fs/promises"),l=require("os"),r=require("path"),k=require("util"),m=d(require("mustache"));var h=`
+[includeIf "gitdir:{{{paths.workspace}}}/"]
+    path = {{{paths.gitConfig}}}
+`;var y=`# Config for GIT account {{{configDetails.email}}}
+[user]
+    name = {{{configDetails.name}}}
+    email = {{{configDetails.email}}}
+[core]
+    sshCommand = ssh -F {{{paths.sshConfig}}}
+{{#configDetails.signYourWork}}
+[gpg]
+    format = ssh
+[commit]
+    gpgsign = true
+[push]
+    gpgsign = if-asked
+[tag]
+    gpgsign = true
+[user]
+    signingkey = {{{paths.privateKey}}}
+{{/configDetails.signYourWork}}
+`;var C=`# Config for GIT account {{{configDetails.email}}}
+Host {{{configDetails.host}}}
+    IgnoreUnknown AddKeysToAgent
+    HostName {{{configDetails.host}}}
+    User git
+    AddKeysToAgent yes
+    IdentitiesOnly yes
+    IdentityFile {{{paths.privateKey}}}
+`;var c=require("zod"),E=(e,i)=>{let{success:n,error:s}=e.safeParse(i);return!n&&s.errors.map(({message:t})=>t).join(`
+`)},g=E;var L=(0,k.promisify)(b.exec);async function R(e){let i=`id_ed25519_git_${e.host}`,n=i,s=`${i}.pub`,t=(0,r.resolve)((0,l.tmpdir)(),n),o=(0,r.resolve)((0,l.tmpdir)(),s);await(0,a.rm)(t,{force:!0}),await(0,a.rm)(o,{force:!0}),await L(`ssh-keygen -t ed25519 -C "${e.email}" -f ${t} -N ""`);let f=await(0,a.readFile)(t,"utf8"),F=await(0,a.readFile)(o,"utf8");return await(0,a.rm)(t,{force:!0}),await(0,a.rm)(o,{force:!0}),{privateKeyName:n,publicKeyName:s,privateKey:f,publicKey:F}}var p=c.z.object({name:c.z.string().min(1),email:c.z.string().email(),host:c.z.string().refine(e=>e.includes(".")&&URL.canParse(`https://${e}`),{message:"Invalid host, must be a valid domain (e.g., github.com)"}),workspace:c.z.string().min(1).refine(e=>!(0,w.existsSync)(e),"Path already exists"),signYourWork:c.z.boolean()});async function v(e){let i=g(p,e);if(i)throw new Error(i);let n=await R(e),s=(0,r.resolve)(e.workspace),t=(0,r.resolve)(s,".config"),o={workspace:s,config:t,gitConfigGlobal:(0,r.resolve)((0,l.homedir)(),".gitconfig"),gitConfig:(0,r.resolve)(t,"gitconfig"),sshConfig:(0,r.resolve)(t,"sshconfig"),privateKey:(0,r.resolve)(t,n.privateKeyName),publicKey:(0,r.resolve)(t,n.publicKeyName)};return{gitConfigGlobal:{path:o.gitConfigGlobal,content:m.default.render(h,{configDetails:e,paths:o})},gitConfig:{path:o.gitConfig,content:m.default.render(y,{configDetails:e,paths:o})},sshConfig:{path:o.sshConfig,content:m.default.render(C,{configDetails:e,paths:o})},privateKey:{path:o.privateKey,content:n.privateKey,secret:!0},publicKey:{path:o.publicKey,content:n.publicKey}}}async function K(e,i){let n=(0,r.resolve)(e.workspace,".config");await(0,a.mkdir)(n,{recursive:!0});let s=Object.values(i).map(({path:t,content:o,secret:f})=>(0,a.appendFile)(t,o,{encoding:"utf8",mode:f?384:420}));await Promise.all(s)}var G={command:["$0","add"],describe:"Add a new Git account",builder:e=>e.option("dry-run",{type:"boolean",describe:"Preview the generated config files without writing them to disk"}),handler:async e=>{console.log("Let's add a new Git account.");let s=await(0,D.default)([{type:"text",name:"name",message:"Full name for Git commits (e.g., John Doe):",validate:o=>g(p.shape.name,o)||!0},{type:"text",name:"email",message:"Email for this Git account:",validate:o=>g(p.shape.email,o)||!0},{type:"text",name:"host",message:"Git provider host (e.g., github.com, gitlab.com):",initial:o=>o.split("@")[1],validate:o=>g(p.shape.host,o)||!0},{type:"text",name:"workspace",message:"Absolute path to the workspace for this account:",initial:o=>(0,A.resolve)((0,x.homedir)(),"code",o),validate:o=>g(p.shape.workspace,o)||!0},{type:"toggle",name:"signYourWork",message:"Sign commits and tags with your SSH key?",initial:!0,active:"yes",inactive:"no"}],{onCancel:()=>{throw new Error("Operation cancelled by the user.")}}),t=await v(s);if(e!=null&&e.dryRun){console.log(`
+Config files that would be generated/updated:`);for(let o of Object.values(t))console.log(`
+Path:`,o.path),console.log(o.secret?"[Content hidden for security]":o.content)}else await K(s,t),console.log(`
 Your public SSH key is:
-`,b),console.log(`You can also find it here:
-`,o.publicKey),console.log("Add it to your favorite GIT provider and enjoy!")}Y().then(()=>m()).catch(t=>m(1,t.message));
+${t.publicKey.content}`),console.log(`You can also find it here:
+${t.publicKey.path}`),console.log(`
+Next, add the key to ${s.host}:`),console.log("1. Copy the public SSH key above."),console.log(`2. Go to the SSH keys settings page on ${s.host}.`),console.log("3. Add the key as an 'Authentication Key'."),s.signYourWork&&console.log("4. Add the same key again as a 'Signing Key'."),console.log(`
+Done! Any git command you run from '${s.workspace}',`),console.log("(and its subdirectories), will now use this new account.")}};var P=[G];(0,$.default)((0,S.hideBin)(process.argv)).scriptName("git-add-account").usage("$0 [cmd] <options>").command(P).demandCommand(0,1).help("h").alias("h","help").strict().fail((e,i,n)=>{e&&console.log(n.help()),console.log(`
+${e||(i==null?void 0:i.message)}
+`),console.log(`\u{1F635} Exited! Thanks for using @savaryna/git-add-account!
+`),process.exit(1)}).parse();

package/package.json

@@ -1,27 +1,21 @@
 {
   "name": "@savaryna/git-add-account",
-  "version": "2.0.2",
-  "description": "🔐 A small CLI app that allows you to easily add multiple GIT accounts on one machine. It switches between accounts automatically based on the workspace (directory/subdirectory) you are in.",
+  "version": "2.2.0",
+  "description": "🔐 A small CLI app that allows you to easily add multiple Git accounts on one machine. It switches between accounts automatically based on the workspace you are in.",
   "homepage": "https://github.com/savaryna/git-add-account#readme",
   "keywords": [
-    "add",
-    "multiple",
     "git",
-    "github",
-    "account",
-    "accounts",
-    "users",
-    "on",
-    "one",
-    "machine",
-    "mac",
-    "linux",
-    "windows",
+    "multiple-accounts",
+    "account-switching",
+    "cli",
     "ssh",
-    "verified",
-    "commit",
-    "auto",
-    "switch"
+    "git-config",
+    "workspace",
+    "developer-tools",
+    "automation",
+    "productivity",
+    "github",
+    "gitlab"
   ],
   "author": "Alex Tofan",
   "license": "MIT",
@@ -43,19 +37,24 @@
   "scripts": {
     "link": "npm unlink -g && npm link",
     "dev": "tsup --watch",
+    "check": "biome check --write",
     "build": "tsup",
     "pretest": "npm run build",
     "test": "npm publish --dry-run"
   },
-  "source": "src/index.ts",
   "main": "bin/main.js",
   "dependencies": {
+    "mustache": "^4.2.0",
     "prompts": "^2.4.2",
-    "zod": "^3.20.6"
+    "yargs": "^18.0.0",
+    "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@types/node": "^18.14.0",
+    "@biomejs/biome": "2.1.2",
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^22.16.5",
     "@types/prompts": "^2.4.2",
+    "@types/yargs": "^17.0.33",
     "tsup": "^8.2.4",
     "typescript": "^5.5.4"
   }