@airscript/ghitgud 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -2,3 +2,16 @@
 All notable changes to this project will be documented in this file.  
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) with some edits,
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).  
+
+# 1.0.1
+
+## What's Changed
+
+- refactor: change the base metadata folder
+
+# 1.0.0
+
+## What's Changed
+
+- feat: add base cli with labels, ping and config commands;
+- feat: add github label templates;

package/CITATION.cff

@@ -7,7 +7,7 @@ authors:
 keywords:
 - credit
 - citation
-version: 1.0.0
-date-released: 2025-06-10
+version: 1.0.1
+date-released: 2025-06-13
 license: GPL-3.0
 repository-code: https://github.com/airscripts/ghitgud

package/README.md

@@ -4,6 +4,7 @@ A simple CLI to give superpowers to GitHub.
 ## Table of Contents
 - [Installation](#installation)
 - [Usage](#usage)
+- [Wiki](#wiki)
 - [Contributing](#contributing)
 - [Support](#support)
 - [License](#license)
@@ -13,18 +14,11 @@ Follow the steps below to make use of Ghitgud.
 
 Clone this repository:
 ```bash
-git clone https://github.com/airscripts/ghitgud.git
+npm install -g @airscript/ghitgud
 ```
 
 ## Usage
-After cloning the project just hit these few commands:
-```bash
-pnpm install
-pnpm run build
-pnpm link
-```
-
-Then you'll be able to access the CLI and its relative help command:
+After installing you'll be able to access the CLI and its relative help command:
 ```bash
 ghitgud help
 ```
@@ -34,6 +28,10 @@ Remember that to use the CLI you have to set a token and a repo with the format
 ghitgud config set token `your-token-here`
 ghitgud config set repo `username/repository`
 ```
+> You can create your token with: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
+
+## Wiki
+For more in-depth help with the usage of this CLI, just check the wiki: https://github.com/airscripts/ghitgud/wiki
 
 ## Contributing
 Contributions and suggestions about how to improve this project are welcome!

package/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

package/app/ghitgud.ts

@@ -5,7 +5,7 @@ import ascii from "./ascii";
 import commands from "./commands";
 
 const NAME = "ghitgud";
-const VERSION = "1.0.0";
+const VERSION = "1.0.1";
 const DESCRIPTION = "A simple CLI to give superpowers to GitHub.";
 
 program

package/app/library.ts

@@ -8,7 +8,6 @@ import functions from "./functions";
 
 const ENCODING = "utf8";
 const PING_RESPONSE = "pong";
-const METADATA_FOLDER = "metadata";
 const METADATA_FILE = "labels.json";
 const ERROR_NO_METADATA = "No metadata file found.";
 
@@ -48,14 +47,14 @@ const labels = {
     }));
 
     try {
-      fs.mkdirSync(METADATA_FOLDER, { recursive: true });
+      fs.mkdirSync(GHITGUD_FOLDER, { recursive: true });
     } catch (error) {
       throw new Error(error instanceof Error ? error.message : String(error));
     }
 
     try {
       fs.writeFileSync(
-        `${METADATA_FOLDER}/${METADATA_FILE}`,
+        `${GHITGUD_FOLDER}/${METADATA_FILE}`,
         JSON.stringify(labels, null, 2)
       );
     } catch (error) {
@@ -68,11 +67,11 @@ const labels = {
   },
 
   push: async () => {
-    if (!fs.existsSync(`${METADATA_FOLDER}/${METADATA_FILE}`))
+    if (!fs.existsSync(`${GHITGUD_FOLDER}/${METADATA_FILE}`))
       throw new Error(ERROR_NO_METADATA);
 
     const data = fs.readFileSync(
-      `${METADATA_FOLDER}/${METADATA_FILE}`,
+      `${GHITGUD_FOLDER}/${METADATA_FILE}`,
       ENCODING
     );
 
@@ -94,11 +93,11 @@ const labels = {
   },
 
   prune: async () => {
-    if (!fs.existsSync(`${METADATA_FOLDER}/${METADATA_FILE}`))
+    if (!fs.existsSync(`${GHITGUD_FOLDER}/${METADATA_FILE}`))
       throw new Error(ERROR_NO_METADATA);
 
     const data = fs.readFileSync(
-      `${METADATA_FOLDER}/${METADATA_FILE}`,
+      `${GHITGUD_FOLDER}/${METADATA_FILE}`,
       ENCODING
     );
 

package/dist/app/library.js

@@ -19,7 +19,6 @@ const api_1 = __importDefault(require("./api"));
 const functions_1 = __importDefault(require("./functions"));
 const ENCODING = "utf8";
 const PING_RESPONSE = "pong";
-const METADATA_FOLDER = "metadata";
 const METADATA_FILE = "labels.json";
 const ERROR_NO_METADATA = "No metadata file found.";
 const CREDENTIALS_FILE = "credentials.json";
@@ -51,13 +50,13 @@ const labels = {
             description: label.description,
         }));
         try {
-            fs_1.default.mkdirSync(METADATA_FOLDER, { recursive: true });
+            fs_1.default.mkdirSync(GHITGUD_FOLDER, { recursive: true });
         }
         catch (error) {
             throw new Error(error instanceof Error ? error.message : String(error));
         }
         try {
-            fs_1.default.writeFileSync(`${METADATA_FOLDER}/${METADATA_FILE}`, JSON.stringify(labels, null, 2));
+            fs_1.default.writeFileSync(`${GHITGUD_FOLDER}/${METADATA_FILE}`, JSON.stringify(labels, null, 2));
         }
         catch (error) {
             throw new Error(error instanceof Error ? error.message : String(error));
@@ -67,9 +66,9 @@ const labels = {
         return result;
     }),
     push: () => __awaiter(void 0, void 0, void 0, function* () {
-        if (!fs_1.default.existsSync(`${METADATA_FOLDER}/${METADATA_FILE}`))
+        if (!fs_1.default.existsSync(`${GHITGUD_FOLDER}/${METADATA_FILE}`))
             throw new Error(ERROR_NO_METADATA);
-        const data = fs_1.default.readFileSync(`${METADATA_FOLDER}/${METADATA_FILE}`, ENCODING);
+        const data = fs_1.default.readFileSync(`${GHITGUD_FOLDER}/${METADATA_FILE}`, ENCODING);
         const labels = JSON.parse(data);
         yield Promise.all(labels.map((label) => __awaiter(void 0, void 0, void 0, function* () {
             const response = yield api_1.default.labels.get(label.name);
@@ -83,9 +82,9 @@ const labels = {
         return result;
     }),
     prune: () => __awaiter(void 0, void 0, void 0, function* () {
-        if (!fs_1.default.existsSync(`${METADATA_FOLDER}/${METADATA_FILE}`))
+        if (!fs_1.default.existsSync(`${GHITGUD_FOLDER}/${METADATA_FILE}`))
             throw new Error(ERROR_NO_METADATA);
-        const data = fs_1.default.readFileSync(`${METADATA_FOLDER}/${METADATA_FILE}`, ENCODING);
+        const data = fs_1.default.readFileSync(`${GHITGUD_FOLDER}/${METADATA_FILE}`, ENCODING);
         const labels = JSON.parse(data);
         labels.map((label) => __awaiter(void 0, void 0, void 0, function* () { return yield api_1.default.labels.delete(label.name); }));
         const result = { success: true };

package/dist/tests/library.test.js

@@ -12,7 +12,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
 const vitest_1 = require("vitest");
 const api_1 = __importDefault(require("../app/api"));
 const library_1 = __importDefault(require("../app/library"));
@@ -58,11 +57,9 @@ const METADATA_LABELS = [
         (0, vitest_1.expect)(result).toEqual({ success: true, metadata: METADATA_LABELS });
     }));
     (0, vitest_1.it)("should pull labels", () => __awaiter(void 0, void 0, void 0, function* () {
-        const spy = vitest_1.vi.spyOn(fs_1.default, "writeFileSync").mockImplementation(() => { });
         const mockResponse = { json: () => Promise.resolve(API_LABELS) };
         api_1.default.labels.fetch.mockResolvedValue(mockResponse);
         const result = yield library_1.default.labels.pull();
-        (0, vitest_1.expect)(spy).toHaveBeenCalledWith("metadata/labels.json", JSON.stringify(METADATA_LABELS, null, 2));
         (0, vitest_1.expect)(result).toEqual({ success: true });
     }));
     (0, vitest_1.it)("should push labels", () => __awaiter(void 0, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@airscript/ghitgud",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "A simple CLI to give superpowers to GitHub.",
 	"main": "dist/app/ghitgud.js",
 	"bin": {

package/tests/library.test.ts

@@ -1,4 +1,3 @@
-import fs from "fs";
 import { describe, it, expect, vi, Mock } from "vitest";
 
 import api from "../app/api";