nekos 1.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# How to Contribute
+
+We welcome contributions! If you want to add a new ASCII art, please follow these rules.
+
+## Adding New ASCII Art
+
+You can add new cat ASCII art to the `aa/` directory. A pull request is required to add a file.
+
+### Contribution Rules
+
+Our system will automatically check your pull request to ensure it follows these rules:
+
+1.  **Do not modify or delete** existing files in the `aa/` directory.
+2.  Please add **only one file** per pull request.
+3.  The filename must be **unique** and end with the `.txt` extension.
+4.  The filename (without the extension) can only contain **lowercase letters (a-z)**, **numbers (0-9)**, **underscores (_)**, and **hyphens (-)**.
+
+Thank you for your contribution! 🐱
+
+---
+
+## コントリビューションの方法 (日本語)
+
+コントリビューションを歓迎します！新しいアスキーアートを追加したい場合は、以下のルールに従ってください。
+
+### 新しいアスキーアートの追加
+
+`aa/` ディレクトリに新しい猫のアスキーアートを追加できます。ファイルを追加するにはプルリクエストが必要です。
+
+### コントリビューションのルール
+
+システムは、あなたのプルリクエストが以下のルールに従っているかを自動的にチェックします。
+
+1.  **既存のファイルを変更・削除しないこと**：`aa/` ディレクトリ内の既存のファイルは変更したり削除したりしないでください。
+2.  **プルリクエストごとに1ファイルのみ**：1回のプルリクエストで追加できるファイルは1つだけです。
+3.  **ユニークなファイル名**：ファイル名は他と重複しないユニークなもので、必ず `.txt` で終わるようにしてください。
+4.  **使用可能な文字**：ファイル名（拡張子を除く）には、**小文字の英字 (a-z)**、**数字 (0-9)**、**アンダースコア (_)**、**ハイフン (-)** のみ使用できます。
+
+ご協力ありがとうございます！ 🐱

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 [otoneko.]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,129 @@
+# nekos 🐱
+
+[![npm version](https://badge.fury.io/js/nekos.svg)](https://badge.fury.io/js/nekos)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Validate AA Contribution](https://github.com/otoneko1102/nekos/actions/workflows/validate-aa.yml/badge.svg)](https://github.com/otoneko110/nekos/actions/workflows/validate-aa.yml)
+
+A simple CLI tool to display cat ASCII art in your console.
+
+## Install
+
+```bash
+npm install nekos
+```
+
+## Usage
+
+```javascript
+import nekos from "nekos";
+
+// Log a random cat
+nekos();
+
+// Log a specific cat by ID
+nekos({ id: "my_cat" });
+
+// Log a cat with a rainbow gradient
+nekos({ colors: "RAINBOW" });
+
+// Log a cat with a single random color
+nekos({ colors: "RANDOM" });
+
+// Log a cat with a custom gradient
+nekos({ colors: ["#ff00ff", "#00ffff"] });
+```
+
+[Example - demo.js](test/demo.js)
+
+## API
+
+`nekos(options)`
+
+### options
+
+Type: `object`
+
+#### id
+
+Type: `string`
+
+The ID of the ASCII art to display (the filename without the `.txt` extension). If not provided, a random cat will be shown.
+
+#### colors
+
+Type: `string | string[]`
+
+Specify the color(s) for the ASCII art.
+
+- **String Keywords:**
+  - `'RANDOM'`: Applies a single random solid color.
+  - `'RAINBOW'`: Applies a rainbow gradient.
+- **String Array:** An array of color strings (e.g., hex codes, color names) to create a custom gradient.
+
+## Contributing
+
+Contributions are welcome! Please see the [Contributing Guidelines](CONTRIBUTING.md) for more details.
+
+---
+
+## nekos 🐱 (日本語)
+
+コンソールに猫のアスキーアートを表示する、シンプルな CLI ツールです。
+
+## インストール
+
+```bash
+npm install nekos
+```
+
+## 使い方
+
+```javascript
+import nekos from "nekos";
+
+// ランダムな猫を表示
+nekos();
+
+// IDを指定して特定の猫を表示
+nekos({ id: "my_cat" });
+
+// 虹色のグラデーションで猫を表示
+nekos({ colors: "RAINBOW" });
+
+// ランダムな単色で猫を表示
+nekos({ colors: "RANDOM" });
+
+// カスタムグラデーションで猫を表示
+nekos({ colors: ["#ff00ff", "#00ffff"] });
+```
+
+[Example - demo.js](test/demo.js)
+
+## API
+
+`nekos(options)`
+
+### options
+
+型: `object`
+
+#### id
+
+型: `string`
+
+表示したいアスキーアートの ID（`.txt`を除いたファイル名）。指定しない場合は、ランダムな猫が表示されます。
+
+#### colors
+
+型: `string | string[]`
+
+アスキーアートの色を指定します。
+
+- **文字列キーワード:**
+  - `'RANDOM'`: ランダムな単色を適用します。
+  - `'RAINBOW'`: 虹色のグラデーションを適用します。
+- **文字列配列:** カスタムグラデーションを作成するための色の配列（例: HEX コード、色名）。
+
+## コントリビューション
+
+コントリビューションを歓迎します！詳細は[コントリビューションガイドライン](CONTRIBUTING.md)をご覧ください。

package/aa/my_cat.txt

@@ -0,0 +1,2 @@
+  ^   ^
+= ⠈ w⠈ =

package/aa/neko.txt

@@ -0,0 +1,5 @@
+   ⣄  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀  ⠀   ⣄
+  ⢿⠀⠘⣄⠀ ⠀⠀⠀⠀⠀⠀⠀⠀ ⣄⠘⠀⢿  ⢿
+ ⢿⠀⠀⠀⠈⠇⠸⠘⠈⠈⠃⠸⠇⠈         ⢿
+⢿ ⠀⠀   ٍ  ⠀ ⠈ ⠀w⠀ ⠈⠀ ٍ ⠀⠀⠀   ⠀⢿
+⢿                                ⢿

package/index.d.ts

@@ -0,0 +1,30 @@
+// index.d.ts
+
+/**
+ * An object of options for the nekos function.
+ */
+interface NekosOptions {
+  /**
+   * The ID (filename without .txt) of a specific ASCII art file to display.
+   */
+  id?: string;
+
+  /**
+   * A single color, a keyword ("RANDOM", "RAINBOW"), or an array of colors/keywords for a gradient.
+   */
+  colors?: string | string[];
+}
+
+/**
+ * Logs a cat ASCII art to the console.
+ * @param options The options object.
+ *
+ * @example
+ * import nekos from 'nekos';
+ *
+ * // Log a cat with the ID 'my_cat'
+ * nekos({ id: 'my_cat' });
+ */
+declare function nekos(options?: NekosOptions): void;
+
+export default nekos;

package/index.js

@@ -0,0 +1,97 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import gradient from "gradient-string";
+
+/**
+ * Generates a random HEX color code (e.g., #1a2b3c).
+ * @returns {string} A random color code.
+ */
+function getRandomHexColor() {
+  const randomColor = Math.floor(Math.random() * 16777216).toString(16);
+  return `#${randomColor.padStart(6, "0")}`;
+}
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const aaDir = path.join(__dirname, "aa");
+
+/**
+ * Logs a cat ASCII art to the console.
+ * @param {object} [options={}] - The options object.
+ * @param {string|string[]} [options.colors] - A single color, a keyword ("RANDOM", "RAINBOW"), or an array of colors/keywords.
+ * @param {string} [options.id] - The ID (filename without .txt) of a specific ASCII art file to display.
+ */
+function nekos(options = {}) {
+  const { id } = options;
+  let { colors } = options;
+  let catAscii = "";
+
+  try {
+    const files = fs.readdirSync(aaDir);
+    if (files.length === 0) {
+      console.error("Error: 'aa' directory is empty or does not exist.");
+      return;
+    }
+
+    let targetFile;
+
+    if (id && files.includes(`${id}.txt`)) {
+      targetFile = `${id}.txt`;
+    } else {
+      const randomIndex = Math.floor(Math.random() * files.length);
+      targetFile = files[randomIndex];
+    }
+
+    const filePath = path.join(aaDir, targetFile);
+    catAscii = fs.readFileSync(filePath, "utf-8");
+  } catch (error) {
+    console.error("Error reading ascii art file:", error);
+    return;
+  }
+
+  if (colors) {
+    let processedColors;
+    const rainbowColors = [
+      "red",
+      "orange",
+      "yellow",
+      "green",
+      "blue",
+      "violet",
+    ];
+
+    if (typeof colors === "string") {
+      const upperCaseColor = colors.toUpperCase();
+      if (upperCaseColor === "RAINBOW") {
+        processedColors = rainbowColors;
+      } else if (upperCaseColor === "RANDOM") {
+        processedColors = [getRandomHexColor()];
+      } else {
+        processedColors = [colors];
+      }
+    } else if (Array.isArray(colors)) {
+      processedColors = colors.map((color) =>
+        typeof color === "string" && color.toUpperCase() === "RANDOM"
+          ? getRandomHexColor()
+          : color
+      );
+    } else {
+      processedColors = colors;
+    }
+
+    if (Array.isArray(processedColors) && processedColors.length === 1) {
+      processedColors.push(processedColors[0]);
+    }
+
+    if (processedColors && processedColors.length > 0) {
+      console.log(gradient(processedColors)(catAscii));
+    } else {
+      console.log(catAscii);
+    }
+  } else {
+    console.log(catAscii);
+  }
+}
+
+export default nekos;

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "nekos",
+  "version": "1.0.0",
+  "description": "Let's have cute cats mess around in the log!",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "type": "module",
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/otoneko1102/nekos.git"
+  },
+  "keywords": [
+    "log",
+    "kawaii",
+    "joke",
+    "cat",
+    "cats",
+    "neko",
+    "nekos"
+  ],
+  "author": "otoneko.",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/otoneko1102/nekos/issues"
+  },
+  "homepage": "https://github.com/otoneko1102/nekos#readme",
+  "dependencies": {
+    "gradient-string": "^3.0.0"
+  },
+  "devDependencies": {
+    "jest": "^30.1.1"
+  }
+}