npm - nekos - Versions diffs - 3.2.2 → 3.2.3 - Mend

nekos 3.2.2 → 3.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/CONTRIBUTING-ja.md ADDED Viewed

@@ -0,0 +1,37 @@
+# コントリビューションの方法 (日本語)
+[English](./CONTRIBUTING.md) | **日本語**
+コントリビューションを歓迎します！新しいアスキーアートを追加したい場合は、以下のルールに従ってください。
+## 必要な手順
+### セットアップ
+```bash
+npm install
+```
+### テスト
+```bash
+npm run build
+npm run test
+```
+## 新しいアスキーアートの追加
+`aa/` ディレクトリに新しい猫のアスキーアートを追加できます。ファイルを追加するにはプルリクエストが必要です。
+> [!Warning]
+> `requests` や `dev` ブランチにアスキーアートのためのプルリクエストを送信しないでください。 `main` ブランチに送信をお願いします。
+### コントリビューションのルール
+システムは、あなたのプルリクエストが以下のルールに従っているかを自動的にチェックします。
+1.  **既存のファイルを変更・削除しないこと**：`aa/` ディレクトリ内の既存のファイルは変更したり削除したりしないでください。
+2.  **ユニークなファイル名**：ファイル名は他と重複しないユニークなもので、必ず `.txt` で終わるようにしてください。
+3.  **使用可能な文字**：ファイル名（拡張子を除く）には、**小文字の英字 (a-z)**、**数字 (0-9)**、**アンダースコア (_)**、**ハイフン (-)** のみ使用できます。
+ご協力ありがとうございます！ 🐱

package/CONTRIBUTING.md CHANGED Viewed

@@ -1,5 +1,7 @@
 # How to Contribute
+**English** | [日本語](./CONTRIBUTING-ja.md)
 We welcome contributions! If you want to add a new ASCII art, please follow these rules.
 ## Required Process
@@ -21,7 +23,8 @@ npm run test
 You can add new cat ASCII art to the `aa/` directory. A pull request is required to add a file.
-> ⚠ Do not send a pull request for ASCII art to `requests` or `dev` branch. Please send to `main` branch.
+> [!Warning]
+> Do not send a pull request for ASCII art to `requests` or `dev` branch. Please send to `main` branch.
 ### Contribution Rules
@@ -32,40 +35,3 @@ Our system will automatically check your pull request to ensure it follows these
 3.  The filename (without the extension) can only contain **lowercase letters (a-z)**, **numbers (0-9)**, **underscores (_)**, and **hyphens (-)**.
 Thank you for your contribution! 🐱
----
-# コントリビューションの方法 (日本語)
-コントリビューションを歓迎します！新しいアスキーアートを追加したい場合は、以下のルールに従ってください。
-## 必要な手順
-### セットアップ
-```bash
-npm install
-```
-### テスト
-```bash
-npm run build
-npm run test
-```
-## 新しいアスキーアートの追加
-`aa/` ディレクトリに新しい猫のアスキーアートを追加できます。ファイルを追加するにはプルリクエストが必要です。
-> ⚠ `requests` や `dev` ブランチにアスキーアートのためのプルリクエストを送信しないでください。 `main` ブランチに送信をお願いします。
-### コントリビューションのルール
-システムは、あなたのプルリクエストが以下のルールに従っているかを自動的にチェックします。
-1.  **既存のファイルを変更・削除しないこと**：`aa/` ディレクトリ内の既存のファイルは変更したり削除したりしないでください。
-2.  **ユニークなファイル名**：ファイル名は他と重複しないユニークなもので、必ず `.txt` で終わるようにしてください。
-3.  **使用可能な文字**：ファイル名（拡張子を除く）には、**小文字の英字 (a-z)**、**数字 (0-9)**、**アンダースコア (_)**、**ハイフン (-)** のみ使用できます。
-ご協力ありがとうございます！ 🐱

package/README-ja.md ADDED Viewed

@@ -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)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![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 href="https://www.buymeacoffee.com/devuloper" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
+<a href='https://ko-fi.com/E1E41LY2C9' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi6.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
+[English](./README.md) | **日本語**
+コンソールに猫のアスキーアートを表示する、シンプルな CLI ツールです。
+![sample](img/sample.png)
+## インストール
+```bash
+npm install nekos
+```
+## 使い方
+```javascript
+// ESM
+import nekos from "nekos";
+// CJS
+const nekos = require("nekos").default;
+// ランダムな猫を表示
+nekos();
+// IDを指定して特定の猫を表示
+nekos({ id: "my_cat" });
+// 虹色のグラデーションで猫を表示
+nekos({ colors: "RAINBOW" });
+// ランダムな単色で猫を表示
+nekos({ colors: "RANDOM" });
+// カスタムグラデーションで猫を表示
+nekos({ colors: ["#ff00ff", "#00ffff"] });
+// IDを指定した猫に、2色のランダムなグラデーションを適用
+nekos({ id: "sad_cat", colors: ["RANDOM", "RANDOM"] });
+```
+[ESM Example - demo.js](test/demo.js)
+[CJS Example - demo.cjs](test/demo.cjs)
+---
+## コマンドラインでの使い方
+コマンドラインで使うには、パッケージをグローバルインストールするか、`npx`を利用します。
+```bash
+# グローバルインストール
+npm install -g nekos
+```
+### 実行例
+```bash
+# ランダムな猫を表示
+nekos
+# IDを指定して特定の猫を表示
+nekos --id my_cat
+nekos -i
+# 虹色のグラデーションで猫を表示
+nekos --colors RAINBOW
+nekos -c RAINBOW
+# 2色のランダムなグラデーションで猫を表示
+nekos --colors RANDOM RANDOM
+nekos -c RANDOM RANDOM
+# IDを指定した猫にカスタムグラデーションを適用
+nekos --id sad_cat --colors "#ff00ff" "#00ffff"
+nekos -i sad_cat -c "#ff00ff" "#00ffff"
+# グローバルインストールなしでnpxを使っても実行できます
+npx nekos --colors "#ff00ff #00ffff"
+npx nekos -c "#ff00ff" "#00ffff"
+# 現在のバージョンを確認
+nekos --version
+nekos -v
+```
+---
+## API
+`nekos(options)`
+### options
+型: `object`
+#### id
+型: `string`
+表示したいアスキーアートの ID（`.txt`を除いたファイル名）。指定しない場合は、ランダムな猫が表示されます。
+#### colors
+型: `string | string[]`
+アスキーアートの色を指定します。
+- **文字列キーワード:**
+  - `'RANDOM'`: ランダムな単色を適用します。
+  - `'RAINBOW'`: 虹色のグラデーションを適用します。
+- **文字列配列:** カスタムグラデーションを作成するための色の配列（例: HEX コード、色名）。
+## コントリビューション
+コントリビューションを歓迎します！詳細は[コントリビューションガイドライン](CONTRIBUTING.md)をご覧ください。
+# 貢献者
+[![Contributors](https://contrib.rocks/image?repo=otoneko1102/nekos)](https://github.com/otoneko1102/nekos/graphs/contributors)

package/README.md CHANGED Viewed

@@ -9,6 +9,8 @@
 <a href='https://ko-fi.com/E1E41LY2C9' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi6.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
+**English** | [日本語](./README-ja.md)
 A simple CLI tool to display cat ASCII art in your console.
 ![sample](img/sample.png)
@@ -122,121 +124,6 @@ Specify the color(s) for the ASCII art.
 Contributions are welcome! Please see the [Contributing Guidelines](CONTRIBUTING.md) for more details.
----
-## nekos 🐱 (日本語)
-コンソールに猫のアスキーアートを表示する、シンプルな CLI ツールです。
-## インストール
-```bash
-npm install nekos
-```
-## 使い方
-```javascript
-// ESM
-import nekos from "nekos";
-// CJS
-const nekos = require("nekos").default;
-// ランダムな猫を表示
-nekos();
-// IDを指定して特定の猫を表示
-nekos({ id: "my_cat" });
-// 虹色のグラデーションで猫を表示
-nekos({ colors: "RAINBOW" });
-// ランダムな単色で猫を表示
-nekos({ colors: "RANDOM" });
-// カスタムグラデーションで猫を表示
-nekos({ colors: ["#ff00ff", "#00ffff"] });
-// IDを指定した猫に、2色のランダムなグラデーションを適用
-nekos({ id: "sad_cat", colors: ["RANDOM", "RANDOM"] });
-```
-[ESM Example - demo.js](test/demo.js)
-[CJS Example - demo.cjs](test/demo.cjs)
----
-## コマンドラインでの使い方
-コマンドラインで使うには、パッケージをグローバルインストールするか、`npx`を利用します。
-```bash
-# グローバルインストール
-npm install -g nekos
-```
-### 実行例
-```bash
-# ランダムな猫を表示
-nekos
-# IDを指定して特定の猫を表示
-nekos --id my_cat
-nekos -i
-# 虹色のグラデーションで猫を表示
-nekos --colors RAINBOW
-nekos -c RAINBOW
-# 2色のランダムなグラデーションで猫を表示
-nekos --colors RANDOM RANDOM
-nekos -c RANDOM RANDOM
-# IDを指定した猫にカスタムグラデーションを適用
-nekos --id sad_cat --colors "#ff00ff" "#00ffff"
-nekos -i sad_cat -c "#ff00ff" "#00ffff"
-# グローバルインストールなしでnpxを使っても実行できます
-npx nekos --colors "#ff00ff #00ffff"
-npx nekos -c "#ff00ff" "#00ffff"
-# 現在のバージョンを確認
-nekos --version
-nekos -v
-```
----
-## API
-`nekos(options)`
-### options
-型: `object`
-#### id
-型: `string`
-表示したいアスキーアートの ID（`.txt`を除いたファイル名）。指定しない場合は、ランダムな猫が表示されます。
-#### colors
-型: `string | string[]`
-アスキーアートの色を指定します。
-- **文字列キーワード:**
-  - `'RANDOM'`: ランダムな単色を適用します。
-  - `'RAINBOW'`: 虹色のグラデーションを適用します。
-- **文字列配列:** カスタムグラデーションを作成するための色の配列（例: HEX コード、色名）。
-## コントリビューション
-コントリビューションを歓迎します！詳細は[コントリビューションガイドライン](CONTRIBUTING.md)をご覧ください。
 # Contributors
 [![Contributors](https://contrib.rocks/image?repo=otoneko1102/nekos)](https://github.com/otoneko1102/nekos/graphs/contributors)

package/dist/index.cjs CHANGED Viewed

@@ -85,7 +85,7 @@ function nekos(options = {}) {
         import_consola.consola.warn("Cannot use the value, 'RAINBOW' in array.");
       }
       processedColors = colors.map(
-        (color2) => typeof color2 === "string" && color2.toUpperCase() === "RANDOM" ? (0, import_color.hex)("#") : color2
+        (color) => typeof color === "string" && color.toUpperCase() === "RANDOM" ? (0, import_color.hex)("#") : color
       );
     } else {
       processedColors = colors;

package/dist/index.js CHANGED Viewed

@@ -55,7 +55,7 @@ function nekos(options = {}) {
         consola.warn("Cannot use the value, 'RAINBOW' in array.");
       }
       processedColors = colors.map(
-        (color2) => typeof color2 === "string" && color2.toUpperCase() === "RANDOM" ? hex("#") : color2
+        (color) => typeof color === "string" && color.toUpperCase() === "RANDOM" ? hex("#") : color
       );
     } else {
       processedColors = colors;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "nekos",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "Let's have cute cats mess around in the log!",
   "bin": {
     "nekos": "bin/nekos.js"
@@ -43,18 +43,18 @@
   "homepage": "https://github.com/otoneko1102/nekos#readme",
   "dependencies": {
     "@randplus/color": "^3.0.0",
-    "commander": "^14.0.0",
+    "commander": "^14.0.3",
     "consola": "^3.4.2",
     "gradient-string": "^3.0.0",
-    "is-package-latest": "^1.0.0"
+    "is-package-latest": "^2.0.0"
   },
   "devDependencies": {
-    "@types/node": "^24.3.0",
-    "cross-env": "^10.0.0",
-    "esbuild": "^0.25.9",
-    "jest": "^30.1.1",
-    "prettier": "3.6.2",
-    "rimraf": "^6.0.1",
-    "typescript": "^5.9.2"
+    "@types/node": "^25.2.3",
+    "cross-env": "^10.1.0",
+    "esbuild": "^0.27.3",
+    "jest": "^30.2.0",
+    "prettier": "3.8.1",
+    "rimraf": "^6.1.3",
+    "typescript": "^5.9.3"
   }
 }