foundruu-plugin-security 0.1.0

package/README.md

@@ -0,0 +1,25 @@
+# foundruu-plugin-security
+
+[FoundRuu](https://github.com/Ruu5LP/foundruu) の公式プラグインサンプルです。
+`foundruu doctor` にセキュリティ観点のチェックを追加します。
+
+## インストール
+
+```bash
+npm install -D foundruu-plugin-security
+```
+
+プロジェクトの `node_modules` に入っていれば自動で読み込まれます（設定不要）。
+
+## 追加されるチェック
+
+| チェック | severity | 内容 |
+|---|---|---|
+| SECURITY.md | warn | 脆弱性報告窓口の明記 |
+| .env が gitignore されている | error | 秘密情報のコミット防止 |
+| 依存更新の自動化 | warn | Dependabot / Renovate の設定 |
+
+## プラグインを自作する
+
+このパッケージの [index.js](index.js) が参考実装です。`foundruu-plugin-*` という名前で
+`register({ program, addDoctorCheck, log })` をエクスポートするだけで動きます。

package/index.js

@@ -0,0 +1,45 @@
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * FoundRuu 公式プラグインサンプル。
+ * doctor にセキュリティ観点のチェックを3つ追加する。
+ * プラグインの書き方の参考実装でもある(https://github.com/Ruu5LP/foundruu#プラグイン)。
+ */
+module.exports = {
+  name: "security",
+  register({ addDoctorCheck }) {
+    addDoctorCheck({
+      id: "security-md",
+      label: "SECURITY.md",
+      category: "セキュリティ",
+      severity: "warn",
+      hint: "SECURITY.md で脆弱性の報告窓口を明記してください",
+      check: (ctx) => ctx.existsAny(["SECURITY.md", ".github/SECURITY.md"]),
+    });
+    addDoctorCheck({
+      id: "security-env-ignored",
+      label: ".env が gitignore されている",
+      category: "セキュリティ",
+      severity: "error",
+      hint: ".gitignore に .env を追加し、秘密情報のコミットを防いでください",
+      check: (ctx) => {
+        const gitignore = path.join(ctx.cwd, ".gitignore");
+        if (!fs.existsSync(gitignore)) return false;
+        return fs
+          .readFileSync(gitignore, "utf8")
+          .split(/\r?\n/)
+          .some((line) => /^\.env(\..*)?$|^\*\.env$/.test(line.trim()));
+      },
+    });
+    addDoctorCheck({
+      id: "security-deps-automation",
+      label: "依存更新の自動化 (Dependabot / Renovate)",
+      category: "セキュリティ",
+      severity: "warn",
+      hint: ".github/dependabot.yml または renovate.json を追加してください",
+      check: (ctx) =>
+        ctx.existsAny([".github/dependabot.yml", ".github/dependabot.yaml", "renovate.json", ".renovaterc.json"]),
+    });
+  },
+};

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "foundruu-plugin-security",
+  "version": "0.1.0",
+  "description": "FoundRuu 公式プラグインサンプル - セキュリティ関連の doctor チェックを追加",
+  "license": "MIT",
+  "main": "index.js",
+  "files": ["index.js"],
+  "keywords": ["foundruu", "foundruu-plugin", "security"],
+  "author": "Ruu5LP",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Ruu5LP/foundruu.git",
+    "directory": "plugins/foundruu-plugin-security"
+  },
+  "peerDependencies": {
+    "foundruu": ">=0.5.0"
+  }
+}