shevky-plugin-robots-txt 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Fatih Tatoğlu
+
+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,51 @@
+# shevky-plugin-robots-txt
+
+A simple Shevky plugin that generates `robots.txt`. It runs on the `dist:clean` hook, uses allow/disallow lists from the config, and adds a `Sitemap` line based on the site root URL.
+
+## Features
+
+- Automatically generates `robots.txt`
+- Reads `Allow` and `Disallow` rules from config
+- Writes `Sitemap` as `<site-url>/sitemap.xml`
+
+## Installation
+
+```bash
+npm i shevky-plugin-robots-txt
+```
+
+## Usage
+
+The example config below uses `identity.url`, `robots.allow`, and `robots.disallow`:
+
+```json
+// site.json (example)
+{
+  "identity": {
+    "url": "https://example.com",
+  },
+  "robots": {
+    "allow": ["/", "/blog/"],
+    "disallow": ["/admin/", "/private/"],
+  },
+  "plugins": [
+    "shevky-plugin-robots-txt",
+  ],
+}
+```
+
+Example generated `robots.txt` output:
+
+```text
+User-agent: *
+Allow: /
+Allow: /blog/
+Disallow: /admin/
+Disallow: /private/
+
+Sitemap: https://example.com/sitemap.xml
+```
+
+## License
+
+MIT

package/main.js

@@ -0,0 +1,36 @@
+const PLUGIN = {
+  name: "shevky-robots-txt",
+  version: "0.0.1",
+  hooks: {
+    "dist:clean": async function (ctx, services) {
+      const _cfg = ctx.config;
+      const base = _cfg.identity.url.replace(/\/+$/, "");
+      const allowList = _cfg.robots.allow;
+      const disallowList = _cfg.robots.disallow;
+
+      const lines = ["User-agent: *"];
+
+      allowList.forEach((path) => {
+        if (typeof path === "string" && path.trim().length > 0) {
+          lines.push(`Allow: ${path.trim()}`);
+        }
+      });
+
+      disallowList.forEach((path) => {
+        if (typeof path === "string" && path.trim().length > 0) {
+          lines.push(`Disallow: ${path.trim()}`);
+        }
+      });
+
+      lines.push("");
+      lines.push(`Sitemap: ${base}/sitemap.xml`);
+      lines.push("");
+
+      const payload = lines.join("\n");
+
+      await services.write("robots.txt", payload, {});
+    },
+  },
+};
+
+export default PLUGIN;

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "shevky-plugin-robots-txt",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "main.js",
+  "exports": "./main.js",
+  "files": [
+    "main.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "shevky",
+    "plugin",
+    "robots.txt",
+    "robots",
+    "sitemap",
+    "seo"
+  ],
+  "author": "Fatih Tatoğlu <fatih@tatoglu.net>",
+  "license": "MIT",
+  "description": "Shevky plugin that generates robots.txt from allow/disallow rules and adds a sitemap line.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fatihtatoglu/shevky-plugin-robots-txt.git"
+  },
+  "homepage": "https://github.com/fatihtatoglu/shevky-plugin-robots-txt#readme",
+  "bugs": {
+    "url": "https://github.com/fatihtatoglu/shevky-plugin-robots-txt/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}