@savaryna/git-add-account 0.0.1-beta

package/.github/workflows/publish-package.yml

@@ -0,0 +1,21 @@
+name: Publish package
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  publish-npm:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+          scope: '@savaryna'
+      - run: npm ci
+      - run: npm publish --access=public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.prettierrc.json

@@ -0,0 +1,20 @@
+{
+  "arrowParens": "always",
+  "bracketSameLine": false,
+  "bracketSpacing": true,
+  "embeddedLanguageFormatting": "auto",
+  "htmlWhitespaceSensitivity": "css",
+  "insertPragma": false,
+  "jsxSingleQuote": false,
+  "printWidth": 120,
+  "proseWrap": "preserve",
+  "quoteProps": "as-needed",
+  "requirePragma": false,
+  "semi": true,
+  "singleAttributePerLine": false,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "vueIndentScriptAndStyle": false
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alex Tofan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# @savaryna/add-git-account
+
+> 🔐 A small CLI app that allows you to easily add multiple GIT accounts on one machine.
+
+## Usage
+
+Run the command
+```shell
+npx @savaryna/git-add-account
+```
+
+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
+✔ 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
+
+Your public SSH key was added to the clipboard.
+You can also find it here:  ~/.ssh//git_email_example_name.pub
+Add it to your favorite GIT provider and enjoy!
+
+✨ Done. Thanks for using 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:
+
+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.
+
+## License
+
+MIT – See [LICENSE](LICENSE) file.

package/helpers/exec.js

@@ -0,0 +1,4 @@
+import { exec } from 'child_process';
+import { promisify } from 'util';
+
+export default promisify(exec);

package/helpers/file.js

@@ -0,0 +1,7 @@
+import exec from './exec.js';
+
+export const fileExists = (file) =>
+  exec(`ls ${file}`).then(
+    () => true,
+    () => false
+  );

package/helpers/prompts.js

@@ -0,0 +1,8 @@
+import p from 'prompts';
+
+export const exit = (code = 0) => {
+  console.log(`\n${code ? '😵 Exiting.' : '✨ Done.'} Thanks for using git-add-account!\n`);
+  process.exit(code);
+};
+
+export default (prompts, options) => p(prompts, { onCancel: () => exit(1), ...options });

package/helpers/validate.js

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

package/index.js

@@ -0,0 +1,6 @@
+#!/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")

package/main.js

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

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@savaryna/git-add-account",
+  "version": "0.0.1-beta",
+  "description": "Easily add multiple GIT accounts.",
+  "homepage": "https://github.com/savaryna/git-add-account#readme",
+  "keywords": [
+    "add",
+    "multiple",
+    "git",
+    "account",
+    "accounts",
+    "on",
+    "one",
+    "machine",
+    "ssh",
+    "verified",
+    "commit"
+  ],
+  "author": "Alex Tofan",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/savaryna/git-add-account/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/savaryna/git-add-account.git"
+  },
+  "bin": {
+    "gac": "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"
+  },
+  "devDependencies": {
+    "@types/node": "^18.14.0",
+    "@types/prompts": "^2.4.2"
+  }
+}