@airscript/ghitgud 1.0.2 → 2.0.0

package/CODE_OF_CONDUCT.md

@@ -1,121 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-<francesco@airscript.it>.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
-
-Community Impact Guidelines were inspired by 
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
-at [https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -1,2 +0,0 @@
-# Contributing
-When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository, ensuring you follow the [Code of Conduct](https://github.com/airscripts/ghitgud/blob/main/CODE_OF_CONDUCT.md).  

package/SECURITY.md

@@ -1,9 +0,0 @@
-# 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/app/api.ts

@@ -1,136 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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

@@ -1,117 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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

@@ -1,18 +0,0 @@
-import process from "process";
-import { program } from "commander";
-
-import ascii from "./ascii";
-import commands from "./commands";
-
-const NAME = "ghitgud";
-const VERSION = "1.0.2";
-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

@@ -1,157 +0,0 @@
-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_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(GHITGUD_FOLDER, { recursive: true });
-    } catch (error) {
-      throw new Error(error instanceof Error ? error.message : String(error));
-    }
-
-    try {
-      fs.writeFileSync(
-        `${GHITGUD_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(`${GHITGUD_FOLDER}/${METADATA_FILE}`))
-      throw new Error(ERROR_NO_METADATA);
-
-    const data = fs.readFileSync(
-      `${GHITGUD_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(`${GHITGUD_FOLDER}/${METADATA_FILE}`))
-      throw new Error(ERROR_NO_METADATA);
-
-    const data = fs.readFileSync(
-      `${GHITGUD_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

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