keigo-utils

keigo-utils

This is my package description.

Usage

Install package:

# ✨ Auto-detect
npx nypm install keigo-utils

# npm
npm install keigo-utils

# yarn
yarn add keigo-utils

# pnpm
pnpm install keigo-utils

# bun
bun install keigo-utils

# deno
deno install keigo-utils

Import:

ESM (Node.js, Bun, Deno)

import {
  getNuxtPagePaths,
  isPortAvailable,
  checkMigration,
  isImageSizeValid,
  getImageSize,
  sendDiscordWebhook,
  sendSimpleDiscordMessage,
} from "keigo-utils";

機能一覧

このパッケージは以下の機能を提供します：

getNuxtPagePaths

Nuxtアプリケーションのページディレクトリ内にある全ての.vueファイルのパスを収集して返す関数です。

const pagePaths = await getNuxtPagePaths();

isPortAvailable

指定されたポートが利用可能かどうかを確認する関数です。

const isAvailable = await isPortAvailable(3000);

checkMigration

Gitリポジトリ内のSQLファイルの変更を検出し、データベースマイグレーションが必要かどうかを通知する関数です。

await checkMigration();

Discord Webhook

Discordにwebhookメッセージを送信するための関数です。

// 簡単なメッセージを送信
await sendSimpleDiscordMessage({
  webhookUrl: "https://discord.com/api/webhooks/your-webhook-url",
  message: "こんにちは、これはテストメッセージです！",
  username: "テストボット",
});

// カスタム埋め込みを含むメッセージを送信
await sendDiscordWebhook({
  webhookUrl: "https://discord.com/api/webhooks/your-webhook-url",
  payload: {
    username: "システム通知",
    embeds: [
      {
        title: "処理が完了しました",
        description: "タスクが正常に完了しました",
        color: 0x00_ff_00,
        fields: [
          { name: "処理時間", value: "5分", inline: true },
          { name: "ステータス", value: "成功", inline: true },
        ],
      },
    ],
  },
});

Nuxt関連の機能 詳細

Nuxt関連の追加機能は別のエントリポイントとして提供されています。これらの機能を使用するには、追加の依存関係が必要です。

// Nuxt関連の機能をインポート
import { createTestServer } from "keigo-utils/nuxt";

注意: Nuxt関連の機能を使用するには、@nuxt/test-utilsをインストールする必要があります：

npm install -D @nuxt/test-utils

詳細なドキュメントは各機能のディレクトリ内のREADMEを参照してください。

Development

local development

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using pnpm install
• Run interactive tests using pnpm dev

License

Published under the MIT license. Made by community 💛

🤖 auto updated with automd