@savaryna/git-add-account 2.0.0 → 2.0.2

package/README.md

@@ -1,81 +1,88 @@
 # @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) 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 _(directory/subdirectory)_ you are in.
 
 ## Usage
 
-Run the command direcly:
+Run the command direcly with
+
 ```shell
 npx @savaryna/git-add-account
 ```
 
-or if you want to install it globally:
+or if you want, first install it globally
 
 ```shell
 npm i -g @savaryna/git-add-account
+```
 
-# now you can run it by invoking
-git-add-account
+then you can run it using
 
-# or
-gaa
+```shell
+git-add-account
 ```
 
-After going through all the steps:
+or
 
 ```shell
-✔ Name to use for this account: … Example Name
-✔ Email to use for this account: … example@email.com
-✔ Workspace to use for this account: … /Users/savaryna/code/email
-✔ Name to use for SSH keys: … email_example_name
-Enter passphrase (empty for no passphrase):
-Enter same passphrase again:
-✔ Do you want to sign your work? … no / yes
-
-Your public SSH key is:  ssh-ed25519 AAAAC3NlZ...DITJheGo example@email.com
-You can also find it here:  /Users/savaryna/.ssh/git_email_example_name.pub
-Add it to your favorite GIT provider and enjoy!
-
-✨ Done. Thanks for using @savaryna/git-add-account!
+gaa
 ```
 
-You will be presented with your public SSH key so you can copy, and add it to your GIT provider. For example GitHub[^1]:
+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)
-2. Click on `New SSH key`
-3. Give it any title
-4. Choose `Authentication Key` for key type
-4. Paste in the public SSH key copied earlier in the key field
-5. Repeat steps 2 - 4 to add a `Signing Key` key type, if you chose to sign your work (Commits, Tags, Pushes)[^2]
-6. Done! Now you can go to the workspace you chose for the account `/Users/savaryna/code/email` in this example, and all the GIT
-commands issued from this and children directories will automatically use the correct account.
-
-## How it works
-
-A simple way to use multiple git accounts on one machine is to use multiple SSH keys configured with different hosts. 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:
-
-1. It creates a `.gitconfig` file in the workspace directory you specified.
-2. It creates a SSH keypair using `ssh-keygen -t ed25519 -C "email@you.specified" -f ~/.ssh/git_the_ssh_key_name_you_specified`.
-3. It appends to the `~/.ssh/config` file.
-    ```ini
-    # Config for GIT account email@you.specified
-    Host *
-      AddKeysToAgent yes
-      UseKeychain yes
-      IdentityFile path/to/the/SSH/key/created/in/step/2
-    ```
-4. It runs `git config --file path/to/.gitconfig/from/step/1 user.name "name_you_specified"` to set your git username.
-5. It runs `git config --file path/to/.gitconfig/from/step/1 user.email "email@you.specified"` to set your git email.
-6. It runs `git config --file path/to/.gitconfig/from/step/1 core.sshCommand "ssh -i path/to/the/SSH/key/created/in/step/2"` to make sure all the commands issued from this workspace use the correct SSH key.
-7. If you chose to sign your work:
-    1. It runs `git config --file path/to/.gitconfig/from/step/1 gpg.format ssh` to use SSH key for signing.
-    2. It runs `git config --file path/to/.gitconfig/from/step/1 commit.gpgsign true` to enable signing commits.
-    3. It runs `git config --file path/to/.gitconfig/from/step/1 push.gpgsign if-asked` to enable signing pushes if supported.
-    4. It runs `git config --file path/to/.gitconfig/from/step/1 tag.gpgsign true` to enable signing tags.
-    5. It runs `git config --file path/to/.gitconfig/from/step/1 user.signingkey path/to/the/SSH/key/created/in/step/2` to set the signing key to the one created in step 2.
-8. It runs `git config --global includeIf.gitdir:path/to/your/workspace/.path $path/to/.gitconfig/from/step/1`, this makes sure that if you are in the workspace for the created account, git will use the config from step 1 with all the options from the step 5, 6 and 7 automatically.
-9. 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. 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.
 
 ## License
 
@@ -83,3 +90,4 @@ A simple way to use multiple git accounts on one machine is to use multiple SSH
 
 [^1]: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?tool=webui
 [^2]: https://docs.github.com/en/authentication/managing-commit-signature-verification
+[^3]: https://git-scm.com/docs/git-config#_conditional_includes

package/bin/main.js

@@ -0,0 +1,40 @@
+#!/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(`
+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));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@savaryna/git-add-account",
-  "version": "2.0.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 (directory) you are in.",
+  "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.",
   "homepage": "https://github.com/savaryna/git-add-account#readme",
   "keywords": [
     "add",
@@ -34,19 +34,29 @@
   },
   "type": "commonjs",
   "files": [
-    "helpers"
+    "bin"
   ],
   "bin": {
-    "gaa": "index.js",
-    "git-add-account": "index.js"
+    "gaa": "bin/main.js",
+    "git-add-account": "bin/main.js"
   },
-  "main": "index.js",
+  "scripts": {
+    "link": "npm unlink -g && npm link",
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "pretest": "npm run build",
+    "test": "npm publish --dry-run"
+  },
+  "source": "src/index.ts",
+  "main": "bin/main.js",
   "dependencies": {
     "prompts": "^2.4.2",
     "zod": "^3.20.6"
   },
   "devDependencies": {
     "@types/node": "^18.14.0",
-    "@types/prompts": "^2.4.2"
+    "@types/prompts": "^2.4.2",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4"
   }
 }

package/helpers/exec.js

@@ -1,4 +0,0 @@
-const { exec } = require('child_process');
-const { promisify } = require('util');
-
-module.exports.default = promisify(exec);

package/helpers/file.js

@@ -1,24 +0,0 @@
-const { access, constants, mkdir, readFile, rm, writeFile } = require('fs');
-const { homedir, platform } = require('os');
-const { promisify } = require('util');
-const { resolve } = require('path');
-
-module.exports.createFile = (path, data) => promisify(writeFile)(path, data, 'utf8');
-
-module.exports.readFile = promisify(readFile);
-
-module.exports.home = homedir();
-
-module.exports.platform = platform();
-
-module.exports.mkdir = promisify(mkdir);
-
-module.exports.remove = (path) => promisify(rm)(path, { recursive: true, force: true });
-
-module.exports.resolve = resolve;
-
-module.exports.hasReadWriteAccess = (path) =>
-  promisify(access)(path, constants.R_OK | constants.W_OK).then(
-    () => true,
-    () => false
-  );

package/helpers/prompts.js

@@ -1,110 +0,0 @@
-const { default: exec } = require('./exec');
-const { home, resolve } = require('./file');
-const { default: validate, z } = require('./validate');
-const defaultPrompts = require('prompts');
-
-const MIN_GIT_VERSION = '2.34.0'; // Lower versions don't support SSH for GPG signing
-
-const getGitVersion = () => exec('git --version').then(({ stdout }) => stdout.split(' ')[2]);
-
-const exit = (code = 0, reason = null) => {
-  console.log(reason ? `\n${reason}\n` : '');
-  console.log(`${code ? '😵 Exited.' : '✨ Done.'} Thanks for using @savaryna/git-add-account!\n`);
-  process.exit(code);
-};
-
-// Add onCancel handler for all prompts
-const prompts = (questions, options) => defaultPrompts(questions, { onCancel: () => exit(1), ...options });
-
-const overwritePathPrompt = (path) =>
-  prompts({
-    type: 'toggle',
-    name: 'overwrite',
-    message: `Path ${path} already exists. Overwrite?`,
-    initial: false,
-    active: 'yes',
-    inactive: 'no',
-  });
-
-const cliPrompts = () =>
-  prompts([
-    {
-      type: 'text',
-      name: 'name',
-      message: 'Your name:',
-      validate: validate(z.string()),
-      format: (value) => ({
-        value,
-        camel: value.toLowerCase().replace(/[^\w]/g, '_'),
-      }),
-    },
-    {
-      type: 'text',
-      name: 'email',
-      message: 'Email to use for this account:',
-      validate: validate(z.string().email()),
-    },
-    {
-      type: 'text',
-      name: 'host',
-      message: 'Host to use for this account:',
-      initial: (email) => email.split('@')[1],
-      validate: validate(
-        z
-          .string()
-          .transform((h) => 'https://' + h)
-          .refine(URL.canParse, { message: 'Invalid host' })
-      ),
-      format: (value) => ({
-        value,
-        camel: value.replace(/[^\w]/g, '_'),
-      }),
-    },
-    {
-      type: 'text',
-      name: 'workspace',
-      message: 'Workspace to use for this account:',
-      initial: (host) => resolve(home, 'code', host.camel),
-      validate: validate(z.string().refine((value) => !value.startsWith('~'), { message: '"~" is not supported' })),
-      format: (value, { host }) => {
-        const root = resolve(home, value);
-        const config = resolve(root, '.config');
-        const sshKeyFileName = `id_ed25519_git_${host.camel}`;
-
-        return {
-          root,
-          config,
-          gitConfig: resolve(config, 'gitconfig'),
-          sshConfig: resolve(config, 'sshconfig'),
-          privateKey: resolve(config, sshKeyFileName),
-          publicKey: resolve(config, sshKeyFileName + '.pub'),
-        };
-      },
-    },
-    {
-      type: 'toggle',
-      name: 'signYourWork',
-      message: 'Do you want to sign your work with SSH?',
-      initial: true,
-      active: 'yes',
-      inactive: 'no',
-    },
-    {
-      type: async (prev) => {
-        this.gitVersion = await getGitVersion();
-        return prev && this.gitVersion < MIN_GIT_VERSION ? 'toggle' : null;
-      },
-      name: 'signYourWork',
-      message: () => `Your current git version (${this.gitVersion}) does not support SSH signing. Continue without?`,
-      initial: true,
-      active: 'yes',
-      inactive: 'no',
-      format: (value) => (value ? !value : exit(1)),
-    },
-  ]);
-
-module.exports.exit = exit;
-
-module.exports.overwritePathPrompt = overwritePathPrompt;
-
-module.exports.default = cliPrompts;

package/helpers/validate.js

@@ -1,9 +0,0 @@
-const { z } = require('zod');
-
-module.exports.z = z;
-
-module.exports.default = (schema) => (value) => {
-  const { success, error } = schema.safeParse(value);
-  if (!success) return error.format()._errors[0];
-  return true;
-};

package/index.js

@@ -1,88 +0,0 @@
-#!/usr/bin/env node
-
-const { default: exec } = require('./helpers/exec');
-const { createFile, hasReadWriteAccess, platform, mkdir, readFile, remove } = require('./helpers/file');
-const { default: prompts, overwritePathPrompt, exit } = require('./helpers/prompts');
-
-async function main() {
-  const { name, email, host, workspace, signYourWork } = await prompts();
-
-  // Check already existing workspace config
-  if (await hasReadWriteAccess(workspace.config)) {
-    const { overwrite } = await overwritePathPrompt(workspace.config);
-
-    if (overwrite) {
-      await remove(workspace.config);
-    } else {
-      exit(1);
-    }
-  }
-
-  // Create workspace/config dir
-  await mkdir(workspace.config, { recursive: true });
-
-  // Generate ssh key
-  await exec(`ssh-keygen -t ed25519 -C "${email}" -f ${workspace.privateKey}`);
-
-  // Use keychain if the system is MacOS and a passphrase was used
-  const useKeychain = await exec(`ssh-keygen -y -P "" -f ${workspace.privateKey}`)
-    .then(
-      () => false,
-      () => true
-    )
-    .then((hasPassphrase) => hasPassphrase && platform === 'darwin');
-
-  // Create sshconfig for the workspace
-  const sshConfig = `
-    # Config for GIT account ${email}
-    Host ${host.value}
-      HostName ${host.value}
-      User git
-      AddKeysToAgent yes
-      ${useKeychain ? 'UseKeychain yes' : ''}
-      IdentitiesOnly yes
-      IdentityFile ${workspace.privateKey}
-  `.replace(/\n\s{4}/g, '\n');
-
-  await createFile(workspace.sshConfig, sshConfig);
-
-  // Create gitconfig for the workspace
-  const gitConfig = `
-    [user]
-      name = ${name.value}
-      email = ${email}
-    [core]
-      sshCommand = ssh -F ${workspace.sshConfig}
-    ${
-      !signYourWork
-        ? ''
-        : `
-    [gpg]
-      format = ssh
-    [commit]
-      gpgsign = true
-    [push]
-      gpgsign = if-asked
-    [tag]
-      gpgsign = true
-    [user]
-      signingkey = ${workspace.privateKey}
-    `
-    }
-  `.replace(/\n\s{4}/g, '\n');
-
-  await createFile(workspace.gitConfig, gitConfig);
-
-  // Include workspace config in the global config
-  await exec(`git config --global includeIf.gitdir:${workspace.root}/.path ${workspace.gitConfig}`);
-
-  const publicKey = await readFile(workspace.publicKey).then((buffer) => buffer.toString().trim());
-
-  console.log('\nYour public SSH key is: ', publicKey);
-  console.log('You can also find it here: ', workspace.publicKey);
-  console.log('Add it to your favorite GIT provider and enjoy!');
-}
-
-main()
-  .then(() => exit())
-  .catch((error) => exit(1, error.message));