@savaryna/git-add-account 2.0.1 → 2.1.0

package/README.md

@@ -44,8 +44,8 @@ After going through all the steps, you will be presented with your public SSH ke
 
 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/index.js#L24-L25).
-1. It creates a `sshconfig` file. [See code](https://github.com/savaryna/git-add-account/blob/main/index.js#L35-L47).
+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#L29-L30).
+1. It creates a `sshconfig` file. [See code](https://github.com/savaryna/git-add-account/blob/main/src/index.ts#L40-L48).
 
    ```ini
    # File at /Users/john/code/work/.config/sshconfig
@@ -59,7 +59,7 @@ A simple way to use multiple git accounts on one machine is to use different SSH
      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/index.js#L49-L75).
+1. It creates a `gitconfig` file. [See code](https://github.com/savaryna/git-add-account/blob/main/src/index.ts#L50-L58).
 
    ```ini
    # File at /Users/john/code/work/.config/gitconfig
@@ -81,7 +81,7 @@ A simple way to use multiple git accounts on one machine is to use different SSH
      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/index.js#L77-L78).
+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#L60-L61).
 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

package/bin/main.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+"use strict";var $=Object.create;var y=Object.defineProperty;var H=Object.getOwnPropertyDescriptor;var A=Object.getOwnPropertyNames;var F=Object.getPrototypeOf,L=Object.prototype.hasOwnProperty;var O=(t,e,s,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of A(e))!L.call(t,r)&&r!==s&&y(t,r,{get:()=>e[r],enumerable:!(o=H(e,r))||o.enumerable});return t};var d=(t,e,s)=>(s=t!=null?$(F(t)):{},O(e||!t||!t.__esModule?y(s,"default",{value:t,enumerable:!0}):s,t));var h=d(require("mustache"));var v=`# Config for GIT account {{{email}}}
+Host {{{host.value}}}
+    HostName {{{host.value}}}
+    User git
+    AddKeysToAgent yes{{#useKeychain}}
+    UseKeychain yes{{/useKeychain}}
+    IdentitiesOnly yes
+    IdentityFile {{{workspace.privateKey}}}
+`;var w=`# Config for GIT account {{{email}}}
+[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}}}
+{{/signYourWork}}
+`;var k=require("util"),x=require("child_process"),m=(0,k.promisify)(x.exec);var i=require("fs/promises"),n=require("os"),a=require("path"),u=(t,e)=>(0,i.writeFile)(t,e,"utf8"),P=t=>(0,i.rm)(t,{recursive:!0,force:!0}),C=t=>(0,i.access)(t,i.constants.R_OK|i.constants.W_OK).then(()=>!0,()=>!1);var c=require("zod"),G=t=>e=>{let{success:s,error:o}=t.safeParse(e);return s?!0:o.format()._errors[0]},l=G;var K=d(require("prompts")),R="2.34.0",j=()=>m("git --version").then(({stdout:t})=>t.split(" ")[2]),g=(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)},T=(t,e)=>(0,K.default)(t,{onCancel:()=>g(1),...e}),W=t=>T({type:"toggle",name:"overwrite",message:`Path ${t} already exists. Overwrite?`,initial:!1,active:"yes",inactive:"no"}),b=async()=>{let t=await j();return T([{type:"text",name:"name",message:"Your name:",validate:l(c.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(c.z.string().email())},{type:"text",name:"host",message:"Host to use for this account:",initial:e=>e.split("@")[1],validate:l(c.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(c.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<R?"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:g(1)}])};async function E(){let{name:t,email:e,host:s,workspace:o,signYourWork:r}=await b();if(await C(o.config)){let{overwrite:p}=await W(o.config);p?await P(o.config):g(1)}await(0,i.mkdir)(o.config,{recursive:!0}),await m(`ssh-keygen -t ed25519 -C "${e}" -f ${o.privateKey}`);let f=await m(`ssh-keygen -y -P "" -f ${o.privateKey}`).then(()=>!1,()=>!0).then(p=>p&&(0,n.platform)()==="darwin"),I=h.default.render(v,{email:e,host:s,useKeychain:f,workspace:o});await u(o.sshConfig,I);let Y=h.default.render(w,{name:t,email:e,workspace:o,signYourWork:r});await u(o.gitConfig,Y),await m(`git config --global includeIf.gitdir:${o.root}/.path ${o.gitConfig}`);let _=await(0,i.readFile)(o.publicKey).then(p=>p.toString().trim());console.log(`
+Your public SSH key is:
+`,_),console.log(`You can also find it here:
+`,o.publicKey),console.log("Add it to your favorite GIT provider and enjoy!")}E().then(()=>g()).catch(t=>g(1,t.message));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@savaryna/git-add-account",
-  "version": "2.0.1",
-  "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.1.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/subdirectory) you are in.",
   "homepage": "https://github.com/savaryna/git-add-account#readme",
   "keywords": [
     "add",
@@ -34,19 +34,31 @@
   },
   "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": {
+    "mustache": "^4.2.0",
     "prompts": "^2.4.2",
     "zod": "^3.20.6"
   },
   "devDependencies": {
-    "@types/node": "^18.14.0",
-    "@types/prompts": "^2.4.2"
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^22.5.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,89 +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 = `
-    # Config for GIT account ${email}
-    [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));