hyouji 0.0.7 → 0.0.9

package/README.md

@@ -18,7 +18,6 @@ https://levelup.gitconnected.com/create-github-labels-from-terminal-158d4868fab
 
 https://github.com/user-attachments/assets/739f185a-1bd0-411b-8947-dd4600c452c8
 
-
 ### Labels API
 
 https://docs.github.com/en/rest/reference/issues#labels
@@ -60,7 +59,7 @@ This tool provides the following functionality:
 2. Create multiple labels on a specific repo
 3. Delete a single label from a specific repo
 4. Delete all labels from a specific repo
-5. Import labels from JSON file
+5. Import labels from JSON or YAML file
 6. **Display your saved settings** - View your stored GitHub configuration
 7. **Persistent configuration** - Save your GitHub token and username for future use
 
@@ -77,9 +76,7 @@ hyouji
 On your first run, you'll be prompted to enter:
 
 - **GitHub Personal Token** - Generate one [here](https://github.com/settings/tokens) with `repo` scope
-<img width="792" height="564" alt="github_token" src="https://github.com/user-attachments/assets/e460738f-833a-4158-a8ba-61752beaad72" />
-
-  
+  <img width="792" height="564" alt="github_token" src="https://github.com/user-attachments/assets/e460738f-833a-4158-a8ba-61752beaad72" />
 - **GitHub Username** - Your GitHub account name
 
 These credentials will be securely saved and reused for future sessions.
@@ -90,9 +87,11 @@ These credentials will be securely saved and reused for future sessions.
 2. **Create multiple labels on a specific repo**
 3. **Delete a single label from a specific repo**
 4. **Delete all labels from a specific repo**
-5. **Import labels from JSON file**
-6. **Display your settings** - View your saved configuration
-7. **Exit**
+5. **Import labels from JSON or YAML file**
+6. **Generate sample JSON** - Create a sample JSON file with predefined labels
+7. **Generate sample YAML** - Create a sample YAML file with predefined labels
+8. **Display your settings** - View your saved configuration
+9. **Exit**
 
 ### Settings Management
 
@@ -200,6 +199,93 @@ npm start
 
 You can use `pnpm`, `yarn` or `bun`.
 
+### File Import Support
+
+The "Import labels from JSON or YAML file" option allows you to import multiple labels from external files. Both JSON and YAML formats are supported.
+
+#### Supported File Formats
+
+- **JSON files** (`.json` extension)
+- **YAML files** (`.yaml` or `.yml` extension)
+
+#### Label Structure
+
+Both formats support the same label structure:
+
+- `name` (required): The label name
+- `color` (optional): Hex color code without the `#` symbol
+- `description` (optional): Label description
+
+#### JSON Example
+
+```json
+[
+  {
+    "name": "bug",
+    "color": "d73a4a",
+    "description": "Something isn't working"
+  },
+  {
+    "name": "enhancement",
+    "color": "a2eeef",
+    "description": "New feature or request"
+  },
+  {
+    "name": "documentation",
+    "color": "0075ca",
+    "description": "Improvements or additions to documentation"
+  }
+]
+```
+
+#### YAML Example
+
+```yaml
+# Sample YAML file for importing GitHub labels
+- name: 'bug'
+  color: 'd73a4a'
+  description: "Something isn't working"
+
+- name: 'enhancement'
+  color: 'a2eeef'
+  description: 'New feature or request'
+
+- name: 'documentation'
+  color: '0075ca'
+  description: 'Improvements or additions to documentation'
+
+# Labels with minimal configuration (name only)
+- name: 'good first issue'
+  color: '7057ff'
+  description: 'Good for newcomers'
+
+# Labels without description (optional field)
+- name: 'wontfix'
+  color: 'ffffff'
+
+# Labels without color (will use GitHub default)
+- name: 'question'
+  description: 'Further information is requested'
+```
+
+#### Sample Files
+
+You can find complete example files in the `examples/` directory:
+
+- `examples/labels.json` - Basic label examples in JSON format
+- `examples/labels.yaml` - Basic label examples in YAML format
+- `examples/project-labels.json` - Project management labels in JSON format
+- `examples/project-labels.yaml` - Project management labels in YAML format
+
+#### Generate Sample Files
+
+The tool can generate sample files for you:
+
+- **Generate sample JSON** - Creates `hyouji.json` with predefined labels
+- **Generate sample YAML** - Creates `hyouji.yaml` with predefined labels
+
+Both generated files contain the same predefined labels and can be used as starting points for your own label configurations.
+
 ### Predefined Labels
 
 The "Create multiple labels" option uses predefined labels from `src/constant.ts`. These include common labels for project management:

package/dist/index.js

@@ -4,9 +4,12 @@ import { renderFilled } from "oh-my-logo";
 import * as fs from "fs";
 import { promises, existsSync } from "fs";
 import { homedir } from "os";
+import * as path from "path";
 import { join, dirname } from "path";
 import { createHash, randomBytes, createCipheriv, createDecipheriv } from "crypto";
 import prompts from "prompts";
+import * as yaml from "js-yaml";
+import yaml__default from "js-yaml";
 import { Octokit } from "@octokit/core";
 import { exec } from "child_process";
 import { promisify } from "util";
@@ -49,10 +52,10 @@ const deleteLabel$1 = {
   name: "name",
   message: "Please type label name you want to delete"
 };
-const jsonFilePath = {
+const labelFilePath = {
   type: "text",
   name: "filePath",
-  message: "Please type the path to your JSON file"
+  message: "Please type the path to your JSON or YAML file"
 };
 const actionSelector = {
   type: "multiselect",
@@ -63,9 +66,11 @@ const actionSelector = {
     { title: "create multiple labels", value: 1 },
     { title: "delete a label", value: 2 },
     { title: "delete all labels", value: 3 },
-    { title: "import JSON", value: 4 },
-    { title: "Display your settings", value: 5 },
-    { title: "exit", value: 6 }
+    { title: "import labels from JSON or YAML", value: 4 },
+    { title: "Generate sample JSON", value: 5 },
+    { title: "Generate sample YAML", value: 6 },
+    { title: "Display your settings", value: 7 },
+    { title: "exit", value: 8 }
   ]
 };
 const holdToken = {
@@ -74,6 +79,23 @@ const holdToken = {
   message: "Do you have a personal token?",
   initial: true
 };
+const sampleData = [
+  {
+    name: "Type: Bug Fix",
+    color: "FF8A65",
+    description: "Fix features that are not working"
+  },
+  {
+    name: "Type: Enhancement",
+    color: "64B5F7",
+    description: "Add new features"
+  },
+  {
+    name: "Type: Improvement",
+    color: "4DB6AC",
+    description: "Improve existing functionality"
+  }
+];
 const labels = (
   // the following labels are based on this post
   // https://qiita.com/willow-micro/items/51eeb3efe5b4192a4abd
@@ -247,7 +269,7 @@ Thank you!
 };
 const extraGuideText = `If you don't see action selector, please hit space key.`;
 const linkToPersonalToken = "https://github.com/settings/tokens";
-const log$2 = console.log;
+const log$4 = console.log;
 const createLabel = async (configs2, label) => {
   const resp = await configs2.octokit.request(
     "POST /repos/{owner}/{repo}/labels",
@@ -262,16 +284,16 @@ const createLabel = async (configs2, label) => {
   const status = resp.status;
   switch (status) {
     case 201:
-      log$2(chalk.green(`${resp.status}: Created ${label.name}`));
+      log$4(chalk.green(`${resp.status}: Created ${label.name}`));
       break;
     case 404:
-      log$2(chalk.red(`${resp.status}: Resource not found`));
+      log$4(chalk.red(`${resp.status}: Resource not found`));
       break;
     case 422:
-      log$2(chalk.red(`${resp.status}: Validation failed`));
+      log$4(chalk.red(`${resp.status}: Validation failed`));
       break;
     default:
-      log$2(chalk.yellow(`${resp.status}: Something wrong`));
+      log$4(chalk.yellow(`${resp.status}: Something wrong`));
       break;
   }
 };
@@ -279,8 +301,8 @@ const createLabels = async (configs2) => {
   labels.forEach(async (label) => {
     createLabel(configs2, label);
   });
-  log$2("Created all labels");
-  log$2(chalk.bgBlueBright(extraGuideText));
+  log$4("Created all labels");
+  log$4(chalk.bgBlueBright(extraGuideText));
 };
 const deleteLabel = async (configs2, labelNames) => {
   for (const labelName of labelNames) {
@@ -294,15 +316,15 @@ const deleteLabel = async (configs2, labelNames) => {
         }
       );
       if (resp.status === 204) {
-        log$2(chalk.green(`${resp.status}: Deleted ${labelName}`));
+        log$4(chalk.green(`${resp.status}: Deleted ${labelName}`));
       } else {
-        log$2(chalk.yellow(`${resp.status}: Something wrong with ${labelName}`));
+        log$4(chalk.yellow(`${resp.status}: Something wrong with ${labelName}`));
       }
     } catch (error) {
       if (error && typeof error === "object" && "status" in error && error.status === 404) {
-        log$2(chalk.red(`404: Label "${labelName}" not found`));
+        log$4(chalk.red(`404: Label "${labelName}" not found`));
       } else {
-        log$2(
+        log$4(
           chalk.red(
             `Error deleting label "${labelName}": ${error instanceof Error ? error.message : "Unknown error"}`
           )
@@ -323,17 +345,17 @@ const getLabels = async (configs2) => {
     const names = await resp.data.map((label) => label.name);
     return names;
   } else {
-    log$2(chalk.red("something wrong"));
+    log$4(chalk.red("something wrong"));
     return [];
   }
 };
 const deleteLabels = async (configs2) => {
   const names = await getLabels(configs2);
   if (names.length === 0) {
-    log$2(chalk.yellow("No labels found to delete"));
+    log$4(chalk.yellow("No labels found to delete"));
     return;
   }
-  log$2(chalk.blue(`Deleting ${names.length} labels...`));
+  log$4(chalk.blue(`Deleting ${names.length} labels...`));
   for (const name of names) {
     try {
       const resp = await configs2.octokit.request(
@@ -345,15 +367,15 @@ const deleteLabels = async (configs2) => {
         }
       );
       if (resp.status === 204) {
-        log$2(chalk.green(`${resp.status}: Deleted ${name}`));
+        log$4(chalk.green(`${resp.status}: Deleted ${name}`));
       } else {
-        log$2(chalk.yellow(`${resp.status}: Something wrong with ${name}`));
+        log$4(chalk.yellow(`${resp.status}: Something wrong with ${name}`));
       }
     } catch (error) {
       if (error && typeof error === "object" && "status" in error && error.status === 404) {
-        log$2(chalk.red(`404: Label "${name}" not found`));
+        log$4(chalk.red(`404: Label "${name}" not found`));
       } else {
-        log$2(
+        log$4(
           chalk.red(
             `Error deleting label "${name}": ${error instanceof Error ? error.message : "Unknown error"}`
           )
@@ -361,8 +383,8 @@ const deleteLabels = async (configs2) => {
       }
     }
   }
-  log$2(chalk.blue("Finished deleting labels"));
-  log$2(chalk.bgBlueBright(extraGuideText));
+  log$4(chalk.blue("Finished deleting labels"));
+  log$4(chalk.bgBlueBright(extraGuideText));
 };
 const _CryptoUtils = class _CryptoUtils {
   /**
@@ -912,9 +934,9 @@ class ConfigManager {
   /**
    * Check if file exists
    */
-  async fileExists(path) {
+  async fileExists(path2) {
     try {
-      await promises.access(path);
+      await promises.access(path2);
       return true;
     } catch {
       return false;
@@ -956,19 +978,170 @@ const getConfirmation = async () => {
   const response = await prompts(holdToken);
   return response.value;
 };
+const log$3 = console.log;
+const generateSampleJson = async () => {
+  try {
+    const outputPath = "./hyouji.json";
+    const jsonContent = JSON.stringify(sampleData, null, 2);
+    log$3(chalk.blue("Generating sample JSON file..."));
+    fs.writeFileSync(outputPath, jsonContent, "utf8");
+    log$3(
+      chalk.green(
+        "✅ Sample JSON file generated successfully at ./hyouji.json"
+      )
+    );
+  } catch (error) {
+    if (error instanceof Error) {
+      const nodeError = error;
+      if (nodeError.code === "EACCES") {
+        log$3(
+          chalk.red(
+            "❌ Error generating sample JSON file: Permission denied. Please check write permissions for the current directory."
+          )
+        );
+      } else if (nodeError.code === "ENOSPC") {
+        log$3(
+          chalk.red(
+            "❌ Error generating sample JSON file: Insufficient disk space."
+          )
+        );
+      } else if (nodeError.code === "EROFS") {
+        log$3(
+          chalk.red(
+            "❌ Error generating sample JSON file: Read-only file system."
+          )
+        );
+      } else {
+        log$3(
+          chalk.red(`❌ Error generating sample JSON file: ${error.message}`)
+        );
+      }
+    } else {
+      log$3(
+        chalk.red(
+          "❌ An unexpected error occurred while generating the sample JSON file"
+        )
+      );
+    }
+  }
+};
+const log$2 = console.log;
+const generateSampleYaml = async () => {
+  try {
+    const outputPath = "./hyouji.yaml";
+    const yamlContent = yaml__default.dump(sampleData, {
+      indent: 2,
+      lineWidth: -1,
+      // Disable line wrapping
+      noRefs: true,
+      // Disable references
+      quotingType: '"',
+      // Use double quotes for strings
+      forceQuotes: false
+      // Only quote when necessary
+    });
+    log$2(chalk.blue("Generating sample YAML file..."));
+    fs.writeFileSync(outputPath, yamlContent, "utf8");
+    log$2(
+      chalk.green(
+        "✅ Sample YAML file generated successfully at ./hyouji.yaml"
+      )
+    );
+  } catch (error) {
+    if (error instanceof Error) {
+      const nodeError = error;
+      if (nodeError.code === "EACCES") {
+        log$2(
+          chalk.red(
+            "❌ Error generating sample YAML file: Permission denied. Please check write permissions for the current directory."
+          )
+        );
+      } else if (nodeError.code === "ENOSPC") {
+        log$2(
+          chalk.red(
+            "❌ Error generating sample YAML file: Insufficient disk space."
+          )
+        );
+      } else if (nodeError.code === "EROFS") {
+        log$2(
+          chalk.red(
+            "❌ Error generating sample YAML file: Read-only file system."
+          )
+        );
+      } else {
+        log$2(
+          chalk.red(`❌ Error generating sample YAML file: ${error.message}`)
+        );
+      }
+    } else {
+      log$2(
+        chalk.red(
+          "❌ An unexpected error occurred while generating the sample YAML file"
+        )
+      );
+    }
+  }
+};
+const detectFileFormat = (filePath) => {
+  const extension = path.extname(filePath).toLowerCase();
+  switch (extension) {
+    case ".json":
+      return "json";
+    case ".yaml":
+    case ".yml":
+      return "yaml";
+    default:
+      return null;
+  }
+};
+const parseJsonContent = (content) => {
+  return JSON.parse(content);
+};
+const parseYamlContent = (content) => {
+  try {
+    return yaml.load(content);
+  } catch (error) {
+    if (error instanceof yaml.YAMLException) {
+      throw new Error(`YAMLException: ${error.message}`);
+    }
+    throw error;
+  }
+};
+const getSupportedExtensions = () => {
+  return [".json", ".yaml", ".yml"];
+};
+const formatSupportedExtensions = () => {
+  return getSupportedExtensions().join(", ");
+};
 const log$1 = console.log;
-const importLabelsFromJson = async (configs2, filePath) => {
+const importLabelsFromFile = async (configs2, filePath) => {
   try {
     if (!fs.existsSync(filePath)) {
       log$1(chalk.red(`Error: File not found at path: ${filePath}`));
       return;
     }
+    const format = detectFileFormat(filePath);
+    if (!format) {
+      log$1(
+        chalk.red(
+          `Error: Unsupported file format. Supported formats: ${formatSupportedExtensions()}`
+        )
+      );
+      return;
+    }
     const fileContent = fs.readFileSync(filePath, "utf8");
-    let jsonData;
+    let parsedData;
     try {
-      jsonData = JSON.parse(fileContent);
+      if (format === "json") {
+        parsedData = parseJsonContent(fileContent);
+      } else if (format === "yaml") {
+        parsedData = parseYamlContent(fileContent);
+      }
     } catch (parseError) {
-      log$1(chalk.red(`Error: Invalid JSON syntax in file: ${filePath}`));
+      const formatName = format.toUpperCase();
+      log$1(
+        chalk.red(`Error: Invalid ${formatName} syntax in file: ${filePath}`)
+      );
       log$1(
         chalk.red(
           `Parse error: ${parseError instanceof Error ? parseError.message : "Unknown error"}`
@@ -976,13 +1149,13 @@ const importLabelsFromJson = async (configs2, filePath) => {
       );
       return;
     }
-    if (!Array.isArray(jsonData)) {
-      log$1(chalk.red("Error: JSON file must contain an array of label objects"));
+    if (!Array.isArray(parsedData)) {
+      log$1(chalk.red("Error: File must contain an array of label objects"));
       return;
     }
     const validLabels = [];
-    for (let i = 0; i < jsonData.length; i++) {
-      const item = jsonData[i];
+    for (let i = 0; i < parsedData.length; i++) {
+      const item = parsedData[i];
       if (typeof item !== "object" || item === null) {
         log$1(chalk.red(`Error: Item at index ${i} is not a valid object`));
         continue;
@@ -1063,7 +1236,7 @@ const importLabelsFromJson = async (configs2, filePath) => {
       validLabels.push(validLabel);
     }
     if (validLabels.length === 0) {
-      log$1(chalk.red("Error: No valid labels found in JSON file"));
+      log$1(chalk.red("Error: No valid labels found in file"));
       return;
     }
     log$1(chalk.blue(`Starting import of ${validLabels.length} labels...`));
@@ -1420,8 +1593,8 @@ const getGitHubConfigs = async () => {
     detectionMethod: "manual"
   };
 };
-const getJsonFilePath = async () => {
-  const response = await prompts(jsonFilePath);
+const getLabelFilePath = async () => {
+  const response = await prompts(labelFilePath);
   return response.filePath;
 };
 const getNewLabel = async () => {
@@ -1600,16 +1773,16 @@ const main = async () => {
     }
     case 4: {
       try {
-        const filePath = await getJsonFilePath();
+        const filePath = await getLabelFilePath();
         if (filePath) {
-          await importLabelsFromJson(configs, filePath);
+          await importLabelsFromFile(configs, filePath);
         } else {
           log(chalk.yellow("No file path provided. Returning to main menu."));
         }
       } catch (error) {
         log(
           chalk.red(
-            `Error during JSON import: ${error instanceof Error ? error.message : "Unknown error"}`
+            `Error during label import: ${error instanceof Error ? error.message : "Unknown error"}`
           )
         );
       }
@@ -1617,11 +1790,37 @@ const main = async () => {
       break;
     }
     case 5: {
-      await displaySettings();
+      try {
+        await generateSampleJson();
+      } catch (error) {
+        log(
+          chalk.red(
+            `Error generating sample JSON: ${error instanceof Error ? error.message : "Unknown error"}`
+          )
+        );
+      }
       firstStart = firstStart && false;
       break;
     }
     case 6: {
+      try {
+        await generateSampleYaml();
+      } catch (error) {
+        log(
+          chalk.red(
+            `Error generating sample YAML: ${error instanceof Error ? error.message : "Unknown error"}`
+          )
+        );
+      }
+      firstStart = firstStart && false;
+      break;
+    }
+    case 7: {
+      await displaySettings();
+      firstStart = firstStart && false;
+      break;
+    }
+    case 8: {
       console.log("exit");
       process.exit(0);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyouji",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Hyouji (表示) — A command-line tool for organizing and displaying GitHub labels with clarity and harmony.",
   "main": "dist/index.js",
   "bin": {
@@ -20,7 +20,10 @@
     "hyouji",
     "cli",
     "表示",
-    "Hyouji(表示)"
+    "Hyouji(表示)",
+    "JSON",
+    "yaml",
+    "yml"
   ],
   "scripts": {
     "start": "node dist/index.js",
@@ -60,6 +63,7 @@
     "prompts": "^2.4.2"
   },
   "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^24.0.13",
     "@vitest/coverage-v8": "^3.2.4",
     "@vitest/ui": "^3.2.4",