gitsu-cli 1.0.0 → 1.0.1

package/.github/workflows/build.yml

@@ -38,9 +38,16 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
       - name: Semantic Release
         id: release
         uses: cycjimmy/semantic-release-action@v4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          HUSKY: 0

package/.husky/pre-push

@@ -1 +1 @@
-npm run lint && npm run build && npm run test
+npm run lint && npm run build

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [1.0.1](https://github.com/jamieweavis/gitsu/compare/v1.0.0...v1.0.1) (2025-03-15)
+
+
+### Bug Fixes
+
+* description and docs ([4edfd7f](https://github.com/jamieweavis/gitsu/commit/4edfd7fc3b81dc6965a996226171224849efc4a8))
+
+# 1.0.0 (2025-03-15)
+
+
+### Bug Fixes
+
+* description, output & badges ([294bd7b](https://github.com/jamieweavis/gitsu/commit/294bd7bcd2fb7355539d76aae09f546ae63927ef))

package/README.md

@@ -1,11 +1,11 @@
-# gitsu <img alt="Ninja Emoji" align="right" width=40 height=40 alt="Screenshot" src="./.github/ninja.svg">
+# gitsu
 
-> 🥷 Util for quickly & easily switching git users from a config stored at ~/.gitsurc
+> 🥷 Command line util for quickly & easily switching git users
 
-[![build](https://github.com/jamieweavis/streaker/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/jamieweavis/streaker/actions)
-[![downloads](https://img.shields.io/github/downloads/jamieweavis/streaker/total.svg)](https://github.com/jamieweavis/streaker/releases)
-[![version](https://img.shields.io/github/release/jamieweavis/streaker.svg)](https://github.com/jamieweavis/streaker/releases)
-[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jamieweavis/streaker/blob/main/LICENSE)
+[![build](https://github.com/jamieweavis/gitsu/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/jamieweavis/gitsu/actions)
+[![downloads](https://img.shields.io/npm/dt/gitsu-cli.svg)](https://npmjs.com/package/gitsu-cli)
+[![version](https://img.shields.io/github/release/jamieweavis/gitsu.svg)](https://github.com/jamieweavis/gitsu/releases)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jamieweavis/gitsu/blob/main/LICENSE)
 
 ## Install
 
@@ -15,7 +15,7 @@ npm install gitsu-cli -g
 
 ## Usage
 
-Open switcher to select a user from your `~/.gitsurc` config
+Open the `gitsu` switcher to select a user from your `~/.gitsurc` config
 ```sh
 gitsu
 ```
@@ -37,27 +37,30 @@ Compiling a production build
 npm run build
 ```
 
-Running a production build
+Running in development mode
 ```sh
-npm start
+npm run dev
 ```
 
-Running in development mode
+Running a production build
 ```sh
-npm run dev
+npm start
 ```
 
-Linking the package to your global npm modules
+## Linking
+
+Link the local package to your global npm modules
 ```sh
 npm link
 ```
 
-Unlinking the package from your global npm modules
+Unlink the local package from your global npm modules
 ```sh
 npm unlink gitsu-cli -g
 ```
 
 ## Built With
 
-- [Node.js](https://nodejs.org/)
-- [TypeScript](https://www.typescriptlang.org/)
+- [Node.js](https://github.com/nodejs/node)
+- [TypeScript](https://github.com/microsoft/TypeScript)
+- [Commander.js](https://github.com/tj/commander.js)

package/lib/package.json

@@ -1,7 +1,7 @@
 {
     "name": "gitsu-cli",
-    "version": "0.0.1",
-    "description": "Util for quickly & easily switching git users from a config stored at ~/.gitsu",
+    "version": "1.0.0",
+    "description": "Command line util for quickly & easily switching git users",
     "author": "Jamie Weavis",
     "homepage": "https://github.com/jamieweavis/gitsu#readme",
     "license": "MIT",
@@ -16,7 +16,15 @@
     "bin": {
         "gitsu": "./lib/src/app.js"
     },
-    "keywords": ["git", "user", "switch", "gitsu", "su", "switch-user"],
+    "keywords": [
+        "git",
+        "gitconfig",
+        "user",
+        "switch",
+        "gitsu",
+        "su",
+        "switch-user"
+    ],
     "scripts": {
         "start": "node ./lib/src/app.js",
         "dev": "ts-node-dev --respawn ./src/app.ts",
@@ -24,7 +32,8 @@
         "lint": "biome check src",
         "lint:write": "npm run lint -- --write",
         "format": "biome format src",
-        "format:write": "npm run format --  --write"
+        "format:write": "npm run format --  --write",
+        "prepare": "husky"
     },
     "dependencies": {
         "@types/configstore": "^6.0.2",
@@ -39,7 +48,37 @@
     },
     "devDependencies": {
         "@biomejs/biome": "^1.9.4",
+        "@commitlint/cli": "^19.8.0",
+        "@commitlint/config-conventional": "^19.8.0",
+        "@semantic-release/changelog": "^6.0.3",
+        "@semantic-release/commit-analyzer": "^13.0.1",
+        "@semantic-release/git": "^10.0.1",
+        "@semantic-release/github": "^11.0.1",
+        "@semantic-release/npm": "^12.0.1",
+        "@semantic-release/release-notes-generator": "^14.0.3",
+        "commitizen": "^4.3.1",
+        "cz-conventional-changelog": "^3.3.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^15.5.0",
+        "semantic-release": "^24.2.3",
         "ts-node": "^10.9.2",
         "ts-node-dev": "^2.0.0"
+    },
+    "release": {
+        "branches": ["main"],
+        "plugins": [
+            "@semantic-release/changelog",
+            "@semantic-release/commit-analyzer",
+            "@semantic-release/npm",
+            "@semantic-release/git",
+            "@semantic-release/github",
+            "@semantic-release/release-notes-generator"
+        ]
+    },
+    "lint-staged": {
+        "*.ts": ["biome format --write", "biome lint --write"]
+    },
+    "commitlint": {
+        "extends": ["@commitlint/config-conventional"]
     }
 }

package/lib/src/app.js

@@ -4,17 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = __importDefault(require("chalk"));
 const commander_1 = require("commander");
 const package_json_1 = require("../package.json");
 const edit_1 = __importDefault(require("./commands/edit"));
 const init_1 = __importDefault(require("./commands/init"));
 const list_1 = __importDefault(require("./commands/list"));
 const bootstrap = () => {
-    commander_1.program.description(`Util for quickly & easily switching git users from a config stored at ${chalk_1.default.cyan('~/.gitsu')}`);
+    commander_1.program.description('Command line util for quickly & easily switching git users');
     commander_1.program.version(package_json_1.version);
-    commander_1.program.option('-e, --edit', 'edit the configured list of git users with your preferred EDITOR');
-    commander_1.program.option('-l, --list', 'list the current user and configured gitsu users');
+    commander_1.program.option('-e, --edit', 'edit ~/.gitsurc with your EDITOR');
+    commander_1.program.option('-l, --list', 'list users stored in ~/.gitsurc');
     commander_1.program.parse();
     const options = commander_1.program.opts();
     if (options.list)

package/lib/src/functions/bootstrap-config.js

@@ -12,11 +12,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk_1 = __importDefault(require("chalk"));
-const log_symbols_1 = __importDefault(require("log-symbols"));
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_os_1 = __importDefault(require("node:os"));
 const node_path_1 = __importDefault(require("node:path"));
+const chalk_1 = __importDefault(require("chalk"));
+const log_symbols_1 = __importDefault(require("log-symbols"));
 const choice_1 = require("../utils/choice");
 const get_config_1 = __importDefault(require("../utils/get-config"));
 const get_current_choice_1 = __importDefault(require("./get-current-choice"));
@@ -36,11 +36,11 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
                     email: user.email,
                 },
             ]));
-            console.info(`${log_symbols_1.default.info} Created initial ${chalk_1.default.cyan('~/.gitsu')} with user ${chalk_1.default.cyan(currentChoice)}`);
+            console.info(`${log_symbols_1.default.info} Created initial ${chalk_1.default.cyan('~/.gitsurc')} with user ${chalk_1.default.cyan(currentChoice)}`);
             return true;
         }
         catch (error) {
-            console.error(`${log_symbols_1.default.error} ${chalk_1.default.red('Failed to create ~/.gitsu config file')}`, error);
+            console.error(`${log_symbols_1.default.error} ${chalk_1.default.red('Failed to create ~/.gitsurc config file')}`, error);
             return false;
         }
     }

package/lib/src/utils/get-config.js

@@ -14,6 +14,6 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
     const explorer = (0, cosmiconfig_1.cosmiconfig)('gitsu');
     const result = yield explorer.search();
     if (!result)
-        throw new Error('Failed to find ~/.gitsu configuration file');
+        throw new Error('Failed to find ~/.gitsurc configuration file');
     return result;
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gitsu-cli",
-  "version": "1.0.0",
-  "description": "Util for quickly & easily switching git users from a config stored at ~/.gitsurc",
+  "version": "1.0.1",
+  "description": "Command line util for quickly & easily switching git users",
   "author": "Jamie Weavis",
   "homepage": "https://github.com/jamieweavis/gitsu#readme",
   "license": "MIT",
@@ -16,7 +16,15 @@
   "bin": {
     "gitsu": "./lib/src/app.js"
   },
-  "keywords": ["git", "user", "switch", "gitsu", "su", "switch-user"],
+  "keywords": [
+    "git",
+    "gitconfig",
+    "user",
+    "switch",
+    "gitsu",
+    "su",
+    "switch-user"
+  ],
   "scripts": {
     "start": "node ./lib/src/app.js",
     "dev": "ts-node-dev --respawn ./src/app.ts",
@@ -57,7 +65,9 @@
     "ts-node-dev": "^2.0.0"
   },
   "release": {
-    "branches": ["main"],
+    "branches": [
+      "main"
+    ],
     "plugins": [
       "@semantic-release/changelog",
       "@semantic-release/commit-analyzer",
@@ -68,9 +78,14 @@
     ]
   },
   "lint-staged": {
-    "*.ts": ["biome format --write", "biome lint --write"]
+    "*.ts": [
+      "biome format --write",
+      "biome lint --write"
+    ]
   },
   "commitlint": {
-    "extends": ["@commitlint/config-conventional"]
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
   }
 }

package/src/app.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 
-import chalk from 'chalk';
 import { program } from 'commander';
 
 import { version } from '../package.json';
@@ -10,19 +9,11 @@ import list from './commands/list';
 
 const bootstrap = () => {
   program.description(
-    `Util for quickly & easily switching git users from a config stored at ${chalk.cyan(
-      '~/.gitsurc',
-    )}`,
+    'Command line util for quickly & easily switching git users',
   );
   program.version(version);
-  program.option(
-    '-e, --edit',
-    'edit the configured list of git users with your preferred EDITOR',
-  );
-  program.option(
-    '-l, --list',
-    'list the current user and configured gitsu users',
-  );
+  program.option('-e, --edit', 'edit ~/.gitsurc with your EDITOR');
+  program.option('-l, --list', 'list users stored in ~/.gitsurc');
   program.parse();
 
   const options = program.opts();