@airscript/ghitgud 1.0.0

package/README.md

@@ -0,0 +1,54 @@
+# Ghitgud
+A simple CLI to give superpowers to GitHub.
+
+## Table of Contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
+
+## Installation
+Follow the steps below to make use of Ghitgud.
+
+Clone this repository:
+```bash
+git clone https://github.com/airscripts/ghitgud.git
+```
+
+## 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:
+```bash
+ghitgud help
+```
+
+Remember that to use the CLI you have to set a token and a repo with the format `username/repository` (e.g. airscripts/ghitgud):
+```bash
+ghitgud config set token `your-token-here`
+ghitgud config set repo `username/repository`
+```
+
+## Contributing
+Contributions and suggestions about how to improve this project are welcome!
+Please follow [our contribution guidelines](https://github.com/airscripts/ghitgud/blob/main/CONTRIBUTING.md).
+
+## Support
+If you want to support my work you can do it by following me, leaving a star, sharing my projects or also donating at the links below.  
+Choose what you find more suitable for you:  
+
+<a href="https://sponsor.airscript.it" target="blank">
+  <img src="https://raw.githubusercontent.com/airscripts/assets/main/images/github-sponsors.svg" alt="GitHub Sponsors" width="30px" />
+</a>&nbsp;
+<a href="https://kofi.airscript.it" target="blank">
+  <img src="https://raw.githubusercontent.com/airscripts/assets/main/images/kofi.svg" alt="Kofi" width="30px" />
+</a>
+
+## License  
+This repository is licensed under [GPL-3.0 License](https://github.com/airscripts/ghitgud/blob/main/LICENSE).

package/SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Supported Versions
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.x   | :white_check_mark: |
+
+## Reporting Vulnerability
+To report a vulnerability, open an [issue](https://github.com/airscripts/ghitgud/issues/new/choose).

package/VERSION

@@ -0,0 +1 @@
+1.0.0

package/app/api.ts

@@ -0,0 +1,136 @@
+import config from "./config";
+import { Label } from "./types";
+import functions from "./functions";
+import "dotenv/config";
+
+const VERSION = "2022-11-28";
+const BASE_URL = "https://api.github.com";
+const ACCEPT = "application/vnd.github+json";
+const REPO = `${config.repo}`;
+const AUTHORIZATION = `Bearer ${config.token}`;
+
+const ERROR_UNAUTHORIZED = "Unauthorized.";
+const ERROR_UNPROCESSABLE = "Content is unprocessable.";
+const ERROR_NO_REPO = "You must set the GHITGUD_GITHUB_REPO environment variable.";
+const ERROR_NO_TOKEN = "You must set the GHITGUD_GITHUB_TOKEN environment variable.";
+
+const labels = {
+  fetch: async () => {
+    if (!functions.environment.hasRepo()) throw new Error(ERROR_NO_REPO);
+    if (!functions.environment.hasToken()) throw new Error(ERROR_NO_TOKEN);
+
+    const response = await fetch(`${BASE_URL}/repos/${REPO}/labels`, {
+      headers: {
+        Accept: ACCEPT,
+        Authorization: AUTHORIZATION,
+        "X-GitHub-Api-Version": VERSION,
+      },
+    });
+
+    if (functions.http.isNotAuthorized(response.status))
+      throw new Error(ERROR_UNAUTHORIZED);
+
+    return response;
+  },
+
+  get: async (name: string) => {
+    if (!functions.environment.hasRepo()) throw new Error(ERROR_NO_REPO);
+    if (!functions.environment.hasToken()) throw new Error(ERROR_NO_TOKEN);
+
+    const response = await fetch(`${BASE_URL}/repos/${REPO}/labels/${name}`, {
+      method: "GET",
+      headers: {
+        Accept: ACCEPT,
+        Authorization: AUTHORIZATION,
+        "X-GitHub-Api-Version": VERSION,
+      },
+    });
+
+    if (functions.http.isNotAuthorized(response.status))
+      throw new Error(ERROR_UNAUTHORIZED);
+
+    return response;
+  },
+
+  create: async (label: Label) => {
+    if (!functions.environment.hasRepo()) throw new Error(ERROR_NO_REPO);
+    if (!functions.environment.hasToken()) throw new Error(ERROR_NO_TOKEN);
+
+    const response = await fetch(`${BASE_URL}/repos/${REPO}/labels`, {
+      method: "POST",
+
+      body: JSON.stringify({
+        name: label.name,
+        color: label.color,
+        description: label.description,
+      }),
+
+      headers: {
+        Accept: ACCEPT,
+        Authorization: AUTHORIZATION,
+        "X-GitHub-Api-Version": VERSION,
+      },
+    });
+
+    if (functions.http.isUnprocessable(response.status))
+      throw new Error(ERROR_UNPROCESSABLE);
+
+    if (functions.http.isNotAuthorized(response.status))
+      throw new Error(ERROR_UNAUTHORIZED);
+
+    return response;
+  },
+
+  patch: async (label: Label) => {
+    if (!functions.environment.hasRepo()) throw new Error(ERROR_NO_REPO);
+    if (!functions.environment.hasToken()) throw new Error(ERROR_NO_TOKEN);
+
+    const response = await fetch(
+      `${BASE_URL}/repos/${REPO}/labels/${label.name}`,
+      {
+        method: "PATCH",
+
+        body: JSON.stringify({
+          color: label.color,
+          description: label.description,
+          new_name: label.newName || label.name,
+        }),
+
+        headers: {
+          Accept: ACCEPT,
+          Authorization: AUTHORIZATION,
+          "X-GitHub-Api-Version": VERSION,
+        },
+      }
+    );
+
+    if (functions.http.isNotAuthorized(response.status))
+      throw new Error(ERROR_UNAUTHORIZED);
+
+    return response;
+  },
+
+  delete: async (name: string) => {
+    if (!functions.environment.hasRepo()) throw new Error(ERROR_NO_REPO);
+    if (!functions.environment.hasToken()) throw new Error(ERROR_NO_TOKEN);
+
+    const response = await fetch(`${BASE_URL}/repos/${REPO}/labels/${name}`, {
+      method: "DELETE",
+
+      headers: {
+        Accept: ACCEPT,
+        Authorization: AUTHORIZATION,
+        "X-GitHub-Api-Version": VERSION,
+      },
+    });
+
+    if (functions.http.isNotAuthorized(response.status))
+      throw new Error(ERROR_UNAUTHORIZED);
+
+    return response;
+  },
+};
+
+export default {
+  labels,
+};

package/app/ascii.ts

@@ -0,0 +1,18 @@
+import figlet from "figlet";
+
+const WIDTH = 80;
+const TITLE = "Ghitgud";
+const FONT = "Standard";
+const WHITESPACE_BREAK = true;
+const VERTICAL_LAYOUT = "default";
+const HORIZONTAL_LAYOUT = "default";
+
+const ascii = figlet.textSync(TITLE, {
+  font: FONT,
+  width: WIDTH,
+  verticalLayout: VERTICAL_LAYOUT,
+  whitespaceBreak: WHITESPACE_BREAK,
+  horizontalLayout: HORIZONTAL_LAYOUT,
+});
+
+export default ascii;

package/app/commands.ts

@@ -0,0 +1,117 @@
+import { program, Command } from "commander";
+import library from "./library";
+
+const COMMANDS = {
+  ping: {
+    name: "ping",
+    action: () => void library.ping(),
+    description: "Check if the CLI is working.",
+  },
+
+  labels: {
+    name: "labels",
+    description: "Manage labels for a repository.",
+
+    commands: {
+      list: {
+        name: "list",
+        description: "List all labels for a repository.",
+        action: () => void library.labels.list(),
+      },
+
+      pull: {
+        name: "pull",
+        description: "Pull all related labels for a repository.",
+        action: () => void library.labels.pull(),
+      },
+
+      push: {
+        name: "push",
+        description: "Push all related labels for a repository.",
+        action: () => void library.labels.push(),
+      },
+
+      prune: {
+        name: "prune",
+        description: "Prune all related labels for a repository.",
+        action: () => void library.labels.prune(),
+      },
+    },
+  },
+
+  config: {
+    name: "config",
+    description: "Set CLI configurations.",
+
+    commands: {
+      set: {
+        name: "set",
+        description: "Set configuration.",
+
+        action: (key: string, value: string) =>
+          void library.config.set(key, value),
+      },
+    },
+  },
+};
+
+const ping = () => {
+  program
+    .command(COMMANDS.ping.name)
+    .description(COMMANDS.ping.description)
+    .action(COMMANDS.ping.action);
+};
+
+const labels = () => {
+  const labels = program
+    .command(COMMANDS.labels.name)
+    .description(COMMANDS.labels.description);
+
+  labels.addCommand(
+    new Command(COMMANDS.labels.commands.list.name)
+      .description(COMMANDS.labels.commands.list.description)
+      .action(COMMANDS.labels.commands.list.action)
+  );
+
+  labels.addCommand(
+    new Command(COMMANDS.labels.commands.pull.name)
+      .description(COMMANDS.labels.commands.pull.description)
+      .action(COMMANDS.labels.commands.pull.action)
+  );
+
+  labels.addCommand(
+    new Command(COMMANDS.labels.commands.push.name)
+      .description(COMMANDS.labels.commands.push.description)
+      .action(COMMANDS.labels.commands.push.action)
+  );
+
+  labels.addCommand(
+    new Command(COMMANDS.labels.commands.prune.name)
+      .description(COMMANDS.labels.commands.prune.description)
+      .action(COMMANDS.labels.commands.prune.action)
+  );
+};
+
+const config = () => {
+  const config = program
+    .command(COMMANDS.config.name)
+    .description(COMMANDS.config.description);
+
+  config.addCommand(
+    new Command(COMMANDS.config.commands.set.name)
+      .description(COMMANDS.config.commands.set.description)
+      .arguments("<key> <value>")
+
+      .action((key: string, value: string) =>
+        COMMANDS.config.commands.set.action(key, value)
+      )
+  );
+};
+
+const init = () => {
+  ping();
+  labels();
+  config();
+};
+
+export default init;

package/app/config.ts

@@ -0,0 +1,9 @@
+import functions from "./functions";
+import "dotenv/config";
+
+const config = {
+  repo: process.env.GHITGUD_GITHUB_REPO || functions?.config.read("repo"),
+  token: process.env.GHITGUD_GITHUB_TOKEN || functions?.config.read("token"),
+};
+
+export default config;

package/app/functions.ts

@@ -0,0 +1,43 @@
+import fs from "fs";
+import os from "os";
+import path from "path";
+
+import conf from "./config";
+import "dotenv/config";
+
+const STATUS_OK = 200;
+const STATUS_UNAUTHORIZED = 401;
+const STATUS_NOT_FOUND = 404;
+const STATUS_UNPROCESSABLE = 422;
+
+const ENCODING = "utf8";
+const CREDENTIALS_FILE = "credentials.json";
+const GHITGUD_FOLDER = path.join(os.homedir(), ".config", "ghitgud");
+
+const http = {
+  isOk: (status: number) => status === STATUS_OK,
+  isNotFound: (status: number) => status === STATUS_NOT_FOUND,
+  isNotAuthorized: (status: number) => status === STATUS_UNAUTHORIZED,
+  isUnprocessable: (status: number) => status === STATUS_UNPROCESSABLE,
+};
+
+const environment = {
+  hasRepo: () => (conf.repo ? true : false),
+  hasToken: () => (conf.token ? true : false),
+};
+
+const config = {
+  read: (key: string) => {
+    if (!fs.existsSync(`${GHITGUD_FOLDER}/${CREDENTIALS_FILE}`)) return null;
+
+    const data = fs.readFileSync(
+      `${GHITGUD_FOLDER}/${CREDENTIALS_FILE}`,
+      ENCODING
+    );
+
+    const content = JSON.parse(data);
+    return content[key];
+  },
+};
+
+export default { http, environment, config };

package/app/ghitgud.ts

@@ -0,0 +1,18 @@
+import process from "process";
+import { program } from "commander";
+
+import ascii from "./ascii";
+import commands from "./commands";
+
+const NAME = "ghitgud";
+const VERSION = "1.0.0";
+const DESCRIPTION = "A simple CLI to give superpowers to GitHub.";
+
+program
+  .name(NAME)
+  .description(DESCRIPTION)
+  .version(VERSION);
+
+commands();
+program.addHelpText("before", ascii);
+program.parse(process.argv);

package/app/library.ts

@@ -0,0 +1,158 @@
+import fs from "fs";
+import os from "os";
+import path from "path";
+
+import api from "./api";
+import { Label } from "./types";
+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.";
+
+const CREDENTIALS_FILE = "credentials.json";
+const ERROR_UNSUPPORTED_KEY = "Trying to set unsupported key.";
+const GHITGUD_FOLDER = path.join(os.homedir(), ".config", "ghitgud");
+
+const ping = () => {
+  console.info(PING_RESPONSE);
+  return { success: true };
+};
+
+const labels = {
+  list: async () => {
+    const response = await api.labels.fetch();
+    const data = await response.json();
+
+    const labels = data.map((label: Label) => ({
+      name: label.name,
+      color: label.color,
+      description: label.description,
+    }));
+
+    const result = { success: true, metadata: labels };
+    console.info(result);
+    return result;
+  },
+
+  pull: async () => {
+    const response = await api.labels.fetch();
+    const data = await response.json();
+
+    const labels = data.map((label: Label) => ({
+      name: label.name,
+      color: label.color,
+      description: label.description,
+    }));
+
+    try {
+      fs.mkdirSync(METADATA_FOLDER, { recursive: true });
+    } catch (error) {
+      throw new Error(error instanceof Error ? error.message : String(error));
+    }
+
+    try {
+      fs.writeFileSync(
+        `${METADATA_FOLDER}/${METADATA_FILE}`,
+        JSON.stringify(labels, null, 2)
+      );
+    } catch (error) {
+      throw new Error(error instanceof Error ? error.message : String(error));
+    }
+
+    const result = { success: true };
+    console.info(result);
+    return result;
+  },
+
+  push: async () => {
+    if (!fs.existsSync(`${METADATA_FOLDER}/${METADATA_FILE}`))
+      throw new Error(ERROR_NO_METADATA);
+
+    const data = fs.readFileSync(
+      `${METADATA_FOLDER}/${METADATA_FILE}`,
+      ENCODING
+    );
+
+    const labels = JSON.parse(data);
+
+    await Promise.all(
+      labels.map(async (label: Label) => {
+        const response = await api.labels.get(label.name);
+        if (functions.http.isOk(response.status)) await api.labels.patch(label);
+
+        if (functions.http.isNotFound(response.status))
+          await api.labels.create(label);
+      })
+    );
+
+    const result = { success: true };
+    console.info(result);
+    return result;
+  },
+
+  prune: async () => {
+    if (!fs.existsSync(`${METADATA_FOLDER}/${METADATA_FILE}`))
+      throw new Error(ERROR_NO_METADATA);
+
+    const data = fs.readFileSync(
+      `${METADATA_FOLDER}/${METADATA_FILE}`,
+      ENCODING
+    );
+
+    const labels = JSON.parse(data);
+    labels.map(async (label: Label) => await api.labels.delete(label.name));
+
+    const result = { success: true };
+    console.info(result);
+    return result;
+  },
+};
+
+const config = {
+  set: (key: string, value: string) => {
+    const knowns = ["token", "repo"];
+
+    if (!knowns.includes(key)) throw new Error(ERROR_UNSUPPORTED_KEY);
+
+    if (!fs.existsSync(`${GHITGUD_FOLDER}/${CREDENTIALS_FILE}`)) {
+      const credentials = { [key]: value };
+
+      try {
+        fs.mkdirSync(GHITGUD_FOLDER, { recursive: true });
+      } catch (error) {
+        throw new Error(error instanceof Error ? error.message : String(error));
+      }
+
+      fs.writeFileSync(
+        `${GHITGUD_FOLDER}/${CREDENTIALS_FILE}`,
+        JSON.stringify(credentials, null, 2)
+      );
+
+      return { success: true };
+    }
+
+    const data = fs.readFileSync(
+      `${GHITGUD_FOLDER}/${CREDENTIALS_FILE}`,
+      ENCODING
+    );
+
+    const credentials = JSON.parse(data);
+    credentials[key] = value;
+
+    fs.writeFileSync(
+      `${GHITGUD_FOLDER}/${CREDENTIALS_FILE}`,
+      JSON.stringify(credentials, null, 2)
+    );
+
+    return { success: true };
+  },
+};
+
+export default {
+  ping,
+  labels,
+  config,
+};

package/app/types.ts

@@ -0,0 +1,8 @@
+interface Label {
+  name: string;
+  color: string;
+  newName?: string;
+  description: string;
+}
+
+export type { Label };