@savaryna/git-add-account 0.0.1-beta.2 → 1.0.0

package/README.md

@@ -1,48 +1,58 @@
 # @savaryna/add-git-account
 
-🔐 A small CLI app that allows you to easily add multiple GIT accounts on one machine.
-
-> **Warning**
-> , this version was tested to work on MacOS only!
+🔐 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.
 
 ## Usage
 
-Run the command
+Run the command direcly:
 ```shell
 npx @savaryna/git-add-account
 ```
 
-After going through all the steps
+or if you want to install it globally:
+
+```shell
+npm i -g @savaryna/git-add-account
+
+# now you can run it by invoking
+git-add-account
+
+# or
+gaa
+```
+
+After going through all the steps:
 
 ```shell
-Need to install the following packages:
-  @savaryna/git-add-account
-Ok to proceed? (y)
 ✔ Name to use for this account: … Example Name
 ✔ Email to use for this account: … example@email.com
-✔ Workspace to use for this account: … ~/code/email
+✔ 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:
-✔ Enable signed commits for this account? … no / yes
+✔ Do you want to sign your work? … no / yes
 
-Your public SSH key was added to the clipboard.
-You can also find it here:  ~/.ssh//git_email_example_name.pub
+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 git-add-account!
+✨ Done. Thanks for using @savaryna/git-add-account!
 ```
 
-Your public SSH key will automatically be added to your clipboard so you can add it to your GIT provider. For example GitHub:
+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. Go to your account [settings / keys](https://github.com/settings/keys)
 2. Click on `New SSH key`
-3. Give it a title
-4. Paste in the public SSH key
-5. Repeat steps 2 - 4 to add a `Signing Key` if you chose to have signed commits
-6. Done! Now you can go to the workspace you chose for the account `~/code/email` in this example, and all the GIT
-commands issued from this and children directories will use your newly created account.
+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.
 
 ## License
 
 MIT – See [LICENSE](LICENSE) file.
+
+[^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

package/helpers/exec.js

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

package/helpers/file.js

@@ -1,7 +1,24 @@
-import exec from './exec.js';
+const { access, appendFile, constants, mkdir, readFile, unlink, writeFile } = require('fs');
+const { homedir } = require('os');
+const { promisify } = require('util');
+const { resolve } = require('path');
 
-export const fileExists = (file) =>
-  exec(`ls ${file}`).then(
+module.exports.append = promisify(appendFile);
+
+module.exports.createEmptyFile = (path) => promisify(writeFile)(path, '');
+
+module.exports.home = homedir();
+
+module.exports.mkdir = promisify(mkdir);
+
+module.exports.readFile = promisify(readFile);
+
+module.exports.remove = promisify(unlink);
+
+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,8 +1,11 @@
-import p from 'prompts';
+const prompts = require('prompts');
 
-export const exit = (code = 0) => {
-  console.log(`\n${code ? '😵 Exiting.' : '✨ Done.'} Thanks for using git-add-account!\n`);
+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);
 };
 
-export default (prompts, options) => p(prompts, { onCancel: () => exit(1), ...options });
+module.exports.exit = exit;
+
+module.exports.default = (questions, options) => prompts(questions, { onCancel: () => exit(1), ...options });

package/helpers/validate.js

@@ -1,6 +1,8 @@
-export { z } from 'zod';
+const { z } = require('zod');
 
-export default (schema) => (value) => {
+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,6 +1,152 @@
 #!/usr/bin/env node
 
-// Set options as a parameter, environment variable, or rc file.
-// eslint-disable-next-line no-global-assign
-require = require("esm")(module/* , options */)
-module.exports = require("./main.js")
+const { default: exec } = require('./helpers/exec');
+const { append, createEmptyFile, hasReadWriteAccess, home, mkdir, readFile, remove, resolve } = require('./helpers/file');
+const { default: prompts, exit } = require('./helpers/prompts');
+const { default: validate, z } = require('./helpers/validate');
+
+const sshDirPath = resolve(home, '.ssh');
+const sshConfigPath = resolve(sshDirPath, 'config');
+
+const overwriteFilePrompt = (path) =>
+  prompts({
+    type: 'toggle',
+    name: 'overwrite',
+    message: `File ${path} already exists. Overwrite?`,
+    initial: false,
+    active: 'yes',
+    inactive: 'no',
+  });
+
+async function main() {
+  const { name, email, workspace } = await prompts([
+    {
+      type: 'text',
+      name: 'name',
+      message: 'Name to use for this account:',
+      validate: validate(z.string()),
+      format: (value) => ({
+        original: value,
+        camel: value.toLowerCase().replace(/[^\w]/g, '_'),
+      }),
+    },
+    {
+      type: 'text',
+      name: 'email',
+      message: 'Email to use for this account:',
+      validate: validate(z.string().email()),
+      format: (value) => ({
+        address: value,
+        domain: value.match(/(?<=@).+(?=\.)/)[0].replace(/[^\w]/g, '_'),
+      }),
+    },
+    {
+      type: 'text',
+      name: 'workspace',
+      message: 'Workspace to use for this account:',
+      initial: (email) => resolve(home, `code/${email.domain}`),
+      validate: validate(z.string()),
+    },
+  ]);
+
+  const workspaceGitConfigPath = resolve(workspace, '.gitconfig');
+
+  if (await hasReadWriteAccess(workspaceGitConfigPath)) {
+    const { overwrite } = await overwriteFilePrompt(workspaceGitConfigPath);
+
+    if (overwrite) {
+      await remove(workspaceGitConfigPath);
+    } else {
+      exit(1);
+    }
+  }
+
+  const { sshKeyFileName } = await prompts([
+    {
+      type: 'text',
+      name: 'sshKeyFileName',
+      message: 'Name to use for SSH keys:',
+      initial: `${email.domain}_${name.camel}`,
+      validate: validate(z.string()),
+      format: (value) => `git_${value}`,
+    },
+  ]);
+
+  const sshKeyPath = resolve(sshDirPath, sshKeyFileName);
+
+  if (await hasReadWriteAccess(sshKeyPath)) {
+    const { overwrite } = await overwriteFilePrompt(sshKeyPath);
+
+    if (overwrite) {
+      await remove(sshKeyPath);
+    } else {
+      exit(1);
+    }
+  }
+
+  // Generate ssh key
+  await exec(`ssh-keygen -t ed25519 -C "${email.address}" -f ${sshKeyPath}`);
+
+  // Check to see if the user entered a passphrase
+  const hasPassphrase = await exec(`ssh-keygen -y -P "" -f ${sshKeyPath}`).then(
+    () => false,
+    () => true
+  );
+
+  const sshConfig = `
+    # Config for GIT account ${email.address}
+    Host *
+      AddKeysToAgent yes
+      ${hasPassphrase ? 'UseKeychain yes' : ''}
+      IdentityFile ${sshKeyPath}
+  `.replace(/\n\s{4}/g, '\n');
+
+  // Add account to the ssh config
+  await append(sshConfigPath, sshConfig);
+
+  // Create workspace dir if it does not exist
+  await mkdir(workspace, { recursive: true });
+
+  // Create .gitconfig for the workspace
+  await createEmptyFile(workspaceGitConfigPath);
+
+  // Set user details
+  await exec(`git config --file ${workspaceGitConfigPath} user.name "${name.original}"`);
+  await exec(`git config --file ${workspaceGitConfigPath} user.email "${email.address}"`);
+
+  // Set default ssh command
+  await exec(`git config --file ${workspaceGitConfigPath} core.sshCommand "ssh -i ${sshKeyPath}"`);
+
+  const { signYourWork } = await prompts({
+    type: 'toggle',
+    name: 'signYourWork',
+    message: 'Do you want to sign your work?',
+    initial: true,
+    active: 'yes',
+    inactive: 'no',
+  });
+
+  // Enable signing
+  if (signYourWork) {
+    await exec(`git config --file ${workspaceGitConfigPath} gpg.format ssh`);
+    await exec(`git config --file ${workspaceGitConfigPath} commit.gpgsign true`);
+    await exec(`git config --file ${workspaceGitConfigPath} push.gpgsign if-asked`);
+    await exec(`git config --file ${workspaceGitConfigPath} tag.gpgsign true`);
+    await exec(`git config --file ${workspaceGitConfigPath} user.signingkey ${sshKeyPath}`);
+  }
+
+  // Include workspace config in the global config
+  await exec(`git config --global includeIf.gitdir:${workspace}/.path ${workspaceGitConfigPath}`);
+
+  const publicSshKeyPath = resolve(sshDirPath, `${sshKeyFileName}.pub`);
+  // await exec(`pbcopy < ${publicSshKeyPath}`);
+  const publicSshKey = await readFile(publicSshKeyPath).then((buffer) => buffer.toString().trim());
+
+  console.log('\nYour public SSH key is: ', publicSshKey);
+  console.log('You can also find it here: ', publicSshKeyPath);
+  console.log('Add it to your favorite GIT provider and enjoy!');
+}
+
+main()
+  .then(() => exit())
+  .catch((error) => exit(1, error.message));

package/package.json

@@ -1,20 +1,27 @@
 {
   "name": "@savaryna/git-add-account",
-  "version": "0.0.1-beta.2",
-  "description": "🔐 A small CLI app that allows you to easily add multiple GIT accounts on one machine.",
+  "version": "1.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.",
   "homepage": "https://github.com/savaryna/git-add-account#readme",
   "keywords": [
     "add",
     "multiple",
     "git",
+    "github",
     "account",
     "accounts",
+    "users",
     "on",
     "one",
     "machine",
+    "mac",
+    "linux",
+    "windows",
     "ssh",
     "verified",
-    "commit"
+    "commit",
+    "auto",
+    "switch"
   ],
   "author": "Alex Tofan",
   "license": "MIT",
@@ -25,17 +32,13 @@
     "type": "git",
     "url": "git+https://github.com/savaryna/git-add-account.git"
   },
+  "type": "commonjs",
   "bin": {
-    "gac": "index.js",
+    "gaa": "index.js",
     "git-add-account": "index.js"
   },
   "main": "index.js",
-  "module": "main.js",
-  "os": [
-    "darwin"
-  ],
   "dependencies": {
-    "esm": "^3.2.25",
     "prompts": "^2.4.2",
     "zod": "^3.20.6"
   },

package/main.js

@@ -1,144 +0,0 @@
-#!/usr/bin/env node
-
-import exec from './helpers/exec.js';
-import { fileExists } from './helpers/file.js';
-import prompts, { exit } from './helpers/prompts.js';
-import validate, { z } from './helpers/validate.js';
-
-const sshDir = '~/.ssh/';
-
-const overwriteFilePrompt = (path) =>
-  prompts({
-    type: 'toggle',
-    name: 'overwrite',
-    message: `File ${path} already exists. Overwrite?`,
-    initial: false,
-    active: 'yes',
-    inactive: 'no',
-  });
-
-async function main() {
-  const { name, email, workspace } = await prompts([
-    {
-      type: 'text',
-      name: 'name',
-      message: 'Name to use for this account:',
-      validate: validate(z.string()),
-      format: (value) => ({
-        original: value,
-        camel: value.toLowerCase().replace(/[^\w]/g, '_'),
-      }),
-    },
-    {
-      type: 'text',
-      name: 'email',
-      message: 'Email to use for this account:',
-      validate: validate(z.string().email()),
-      format: (value) => ({
-        address: value,
-        domain: value.match(/(?<=@).+(?=\.)/)[0].replace(/[^\w]/g, '_'),
-      }),
-    },
-    {
-      type: 'text',
-      name: 'workspace',
-      message: 'Workspace to use for this account:',
-      initial: (email) => `~/code/${email.domain}`,
-      validate: validate(z.string()),
-    },
-  ]);
-
-  if (await fileExists(`${workspace}/.gitconfig`)) {
-    const { overwrite } = await overwriteFilePrompt(`${workspace}/.gitconfig`);
-
-    if (overwrite) {
-      await exec(`rm ${workspace}/.gitconfig`);
-    } else {
-      exit(1);
-    }
-  }
-
-  const { sshKeyFileName } = await prompts([
-    {
-      type: 'text',
-      name: 'sshKeyFileName',
-      message: 'Name to use for SSH keys:',
-      initial: `${email.domain}_${name.camel}`,
-      validate: validate(z.string()),
-      format: (value) => `git_${value}`,
-    },
-  ]);
-
-  const sshKey = `${sshDir}${sshKeyFileName}`;
-
-  if (await fileExists(sshKey)) {
-    const { overwrite } = await overwriteFilePrompt(sshKey);
-
-    if (overwrite) {
-      await exec(`rm ${sshKey}`);
-    } else {
-      exit(1);
-    }
-  }
-
-  // Generate ssh key
-  await exec(`ssh-keygen -t ed25519 -C "${email.address}" -f ${sshKey}`);
-
-  // Check to see if the user entered a passphrase
-  const hasPassphrase = await exec(`ssh-keygen -y -P "" -f ${sshKey}`).then(
-    () => false,
-    () => true
-  );
-
-  const sshConfig = `
-    # Config for GIT account ${email.address}
-    Host *
-      AddKeysToAgent yes
-      ${hasPassphrase ? 'UseKeychain yes' : ''}
-      IdentityFile ${sshKey}
-  `.replace(/\n\s{4}/g, '\n');
-
-  // Add account to the ssh config
-  await exec(`echo "${sshConfig}" >> ${sshDir}/config`);
-
-  // Create workspace dir if it does not exist
-  await exec(`mkdir -p ${workspace}`);
-
-  // Create .gitconfig for the workspace
-  await exec(`touch ${workspace}/.gitconfig`);
-
-  // Set user details
-  await exec(`git config --file ${workspace}/.gitconfig user.name "${name.original}"`);
-  await exec(`git config --file ${workspace}/.gitconfig user.email "${email.address}"`);
-
-  // Set default ssh command
-  await exec(`git config --file ${workspace}/.gitconfig core.sshCommand "ssh -i ${sshKey}"`);
-
-  const { enableSignedCommits } = await prompts({
-    type: 'toggle',
-    name: 'enableSignedCommits',
-    message: 'Enable signed commits for this account?',
-    initial: true,
-    active: 'yes',
-    inactive: 'no',
-  });
-
-  // Enable signed commits
-  if (enableSignedCommits) {
-    await exec(`git config --file ${workspace}/.gitconfig gpg.format ssh`);
-    await exec(`git config --file ${workspace}/.gitconfig commit.gpgsign true`);
-    await exec(`git config --file ${workspace}/.gitconfig user.signingkey ${sshKey}`);
-  }
-
-  // Include workspace config in the global config
-  await exec(`git config --global includeIf.gitdir:${workspace}/.path ${workspace}/.gitconfig`);
-
-  const publicSshKeyFile = `${sshDir}/${sshKeyFileName}.pub`
-  await exec(`pbcopy < ${publicSshKeyFile}`);
-
-  console.log('\nYour public SSH key was added to the clipboard.')
-  console.log('You can also find it here: ', publicSshKeyFile)
-  console.log('Add it to your favorite GIT provider and enjoy!');
-}
-
-main().then(() => exit()).catch(() => exit(1));