gitsu-cli 1.0.4 → 1.0.5

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.0.5](https://github.com/jamieweavis/gitsu/compare/v1.0.4...v1.0.5) (2025-03-19)
+
+
+### Bug Fixes
+
+* improve app description ([5016374](https://github.com/jamieweavis/gitsu/commit/5016374e422875fde42859da6386bec62bd57673))
+
 ## [1.0.4](https://github.com/jamieweavis/gitsu/compare/v1.0.3...v1.0.4) (2025-03-16)
 
 

package/README.md

@@ -1,6 +1,6 @@
 # gitsu
 
-> 🥷 Command line util for quickly & easily switching git users
+> 🥷 Command line util for quickly & easily switching git identities
 
 [![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)
@@ -24,12 +24,14 @@ gitsu
 
 List users stored in your `~/.gitsurc` config
 ```sh
-gitsu --list (or -l)
+gitsu --list
+gitsu -l
 ```
 
 Open your `~/.gitsurc` config for editing in your default editor
 ```sh
-gitsu --edit (or -e)
+gitsu --edit
+gitsu -e
 ```
 
 ## Building
@@ -61,8 +63,25 @@ Unlink the local package from your global npm modules
 npm unlink gitsu-cli -g
 ```
 
+## Config
+
+When you run `gitsu` for the first time, a `.gitsurc` file is created in your home directory. This file is used to store your git identities.
+
+```json
+[
+  { "name": "John", "email": "john.doe@gmail.com" },
+  { "name": "John Doe", "email": "john.doe@corporate.com" },
+  { "name": "Johnny", "email": "johnny@startup.io" }
+]
+
+```
+
 ## Built With
 
 - [Node.js](https://github.com/nodejs/node)
 - [TypeScript](https://github.com/microsoft/TypeScript)
 - [Commander.js](https://github.com/tj/commander.js)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/lib/package.json

@@ -1,7 +1,7 @@
 {
     "name": "gitsu-cli",
-    "version": "1.0.3",
-    "description": "Command line util for quickly & easily switching git users",
+    "version": "1.0.4",
+    "description": "Command line util for quickly & easily switching git identities",
     "author": "Jamie Weavis",
     "homepage": "https://github.com/jamieweavis/gitsu#readme",
     "license": "MIT",
@@ -65,9 +65,7 @@
         "ts-node-dev": "^2.0.0"
     },
     "release": {
-        "branches": [
-            "main"
-        ],
+        "branches": ["main"],
         "plugins": [
             "@semantic-release/changelog",
             "@semantic-release/commit-analyzer",
@@ -78,14 +76,9 @@
         ]
     },
     "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/lib/src/app.js

@@ -10,7 +10,7 @@ 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('Command line util for quickly & easily switching git users');
+    commander_1.program.description('Command line util for quickly & easily switching git identities');
     commander_1.program.version(package_json_1.version);
     commander_1.program.option('-e, --edit', 'edit ~/.gitsurc with your EDITOR');
     commander_1.program.option('-l, --list', 'list users stored in ~/.gitsurc');

package/lib/src/functions/get-current-choice.js

@@ -25,7 +25,7 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
         return (0, choice_1.formatChoice)({ name, email });
     }
     catch (error) {
-        console.error(`${log_symbols_1.default.error} ${chalk_1.default.red('Failed to fetch current git user')}`, error);
+        console.error(`${log_symbols_1.default.error} ${chalk_1.default.red('Failed to fetch current git identity')}`, error);
         return '';
     }
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gitsu-cli",
-  "version": "1.0.4",
-  "description": "Command line util for quickly & easily switching git users",
+  "version": "1.0.5",
+  "description": "Command line util for quickly & easily switching git identities",
   "author": "Jamie Weavis",
   "homepage": "https://github.com/jamieweavis/gitsu#readme",
   "license": "MIT",

package/src/app.ts

@@ -9,7 +9,7 @@ import list from './commands/list';
 
 const bootstrap = () => {
   program.description(
-    'Command line util for quickly & easily switching git users',
+    'Command line util for quickly & easily switching git identities',
   );
   program.version(version);
   program.option('-e, --edit', 'edit ~/.gitsurc with your EDITOR');

package/src/functions/get-current-choice.ts

@@ -15,7 +15,7 @@ export default async (): Promise<string> => {
     return formatChoice({ name, email });
   } catch (error) {
     console.error(
-      `${logSymbols.error} ${chalk.red('Failed to fetch current git user')}`,
+      `${logSymbols.error} ${chalk.red('Failed to fetch current git identity')}`,
       error,
     );
     return '';