create-nxpage-app 0.1.18 → 0.1.19

package/README.md

@@ -0,0 +1,60 @@
+# create-nxpage-app
+
+CLI to scaffold a Next.js TypeScript app and wire in NxPage.
+
+## Why use this CLI
+
+This package gives you a fast way to start a Next.js app that can serve optimized JSON responses to AI agents (ChatGPT/OpenAI, Claude, Perplexity, and others) using `nxpage`.
+
+It helps you quickly adopt a dual-delivery model:
+
+- normal users -> regular Next.js HTML
+- AI agents -> lightweight NxPage JSON (when route filters allow)
+
+## Usage
+
+```bash
+npx create-nxpage-app my-app
+```
+
+## What the CLI does
+
+1. Creates a Next.js app with TypeScript and App Router.
+2. Installs `nxpage`.
+3. Adds `server.ts` from template.
+4. Updates scripts in generated `package.json`:
+   - `dev`: `next dev`
+   - `build`: `next build && nxpage build`
+   - `start`: `NODE_ENV=production node server.js`
+
+## After scaffold (recommended)
+
+1. Open generated `server.ts`.
+2. Configure:
+   - `includeRoutePatterns`
+   - `blockRoutePatterns`
+3. Build app and run production server.
+
+This setup can reduce agent-response transfer volume dramatically (often large savings, up to ~99% in favorable cases).
+
+## Template Files
+
+- `templates/server.ts`
+- `templates/next.config.ts`
+
+These are copied into generated app output (via build pipeline).
+
+## Local Development (Monorepo)
+
+```bash
+cd newupdate/packages/create-nxpage-app
+npm install
+npm run build
+```
+
+## Publish Notes
+
+This package ships:
+
+- `dist/index.cjs`
+- `dist/templates/*`

package/dist/index.cjs

@@ -36,30 +36,16 @@ var root = import_path.default.resolve(process.cwd(), appName);
 var templateDir = import_path.default.join(__dirname, "../dist/templates");
 import_cross_spawn.default.sync(
   "npx",
-  [
-    "create-next-app@latest",
-    appName,
-    "--ts",
-    "--use-npm",
-    "--eslint",
-    "--app"
-  ],
+  ["create-next-app@latest", appName, "--ts", "--use-npm", "--eslint", "--app"],
   { stdio: "inherit" }
 );
-import_cross_spawn.default.sync(
-  "npm",
-  ["install", "nxpage"],
-  { cwd: root, stdio: "inherit" }
-);
-import_fs.default.copyFileSync(
-  import_path.default.join(templateDir, "server.ts"),
-  import_path.default.join(root, "server.ts")
-);
-var pkgPath = import_path.default.join(root, "package.json");
-var pkg = JSON.parse(import_fs.default.readFileSync(pkgPath, "utf-8"));
-pkg.scripts.dev = "next dev";
-pkg.scripts.build = "next build && nxpage build";
-pkg.scripts.start = "NODE_ENV=production node server.js";
-import_fs.default.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
-import_fs.default.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
+import_cross_spawn.default.sync("npm", ["install", "nxpage"], { cwd: root, stdio: "inherit" });
+import_fs.default.copyFileSync(import_path.default.join(templateDir, "nxpage.config.js"), import_path.default.join(root, "nxpage.config.js"));
+import_fs.default.copyFileSync(import_path.default.join(templateDir, "server.js"), import_path.default.join(root, "server.js"));
+var packageJsonPath = import_path.default.join(root, "package.json");
+var packageJson = JSON.parse(import_fs.default.readFileSync(packageJsonPath, "utf-8"));
+packageJson.scripts.dev = "nxpage dev";
+packageJson.scripts.build = "nxpage build";
+packageJson.scripts.start = "nxpage start";
+import_fs.default.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
 console.log("NxPage app created successfully.");

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/templates/nxpage.config.js

@@ -0,0 +1,12 @@
+module.exports = function getNxPageConfig() {
+  return {
+    server: {
+          port: 3000,
+    },
+    build: {
+        distDir: ".next",
+        includeRoutePatterns: [],
+        blockRoutePatterns: [],
+    }
+  }
+};

package/dist/templates/server.js

@@ -0,0 +1,3 @@
+const { createNxPageServer } = require("nxpage");
+
+createNxPageServer();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-nxpage-app",
   "description": "A CLI to scaffold a production-ready Next.js app with NxPage bot-optimized server setup and Turbopack-safe build pipeline.",
-  "version": "0.1.18",
+  "version": "0.1.19",
   "bin": {
     "create-nxpage-app": "./dist/index.cjs"
   },
@@ -37,18 +37,23 @@
     "chatgpt bot optimizer"
   ],
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "templates"
   ],
   "scripts": {
     "build": "tsup && cpx \"templates/**/*\" dist/templates",
-    "dev": "tsup --watch"
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist"
   },
   "dependencies": {
     "cpx": "^1.5.0",
-    "cross-spawn": "^7.0.3",
-    "nxpage": "0.0.21"
+    "cross-spawn": "^7.0.3"
   },
   "devDependencies": {
-    "@types/cross-spawn": "^6.0.6"
+    "@types/cross-spawn": "^6.0.6",
+    "@types/node": "^20.19.33",
+    "tsup": "^8.x",
+    "typescript": "^5.x"
   }
 }

package/src/index.ts

@@ -0,0 +1,34 @@
+import spawn from "cross-spawn";
+import fs from "fs";
+import path from "path";
+
+const appName = process.argv[2];
+
+if (!appName) {
+  console.error("Please provide a project name.");
+  process.exit(1);
+}
+
+const root = path.resolve(process.cwd(), appName);
+const templateDir = path.join(__dirname, "../dist/templates");
+
+spawn.sync(
+  "npx",
+  ["create-next-app@latest", appName, "--ts", "--use-npm", "--eslint", "--app"],
+  { stdio: "inherit" }
+);
+
+spawn.sync("npm", ["install", "nxpage"], { cwd: root, stdio: "inherit" });
+
+fs.copyFileSync(path.join(templateDir, "nxpage.config.js"), path.join(root, "nxpage.config.js"));
+fs.copyFileSync(path.join(templateDir, "server.js"), path.join(root, "server.js"));
+
+const packageJsonPath = path.join(root, "package.json");
+const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
+packageJson.scripts.dev = "nxpage dev";
+packageJson.scripts.build = "nxpage build";
+packageJson.scripts.start = "nxpage start";
+
+fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+
+console.log("NxPage app created successfully.");

package/templates/nxpage.config.js

@@ -0,0 +1,12 @@
+module.exports = function getNxPageConfig() {
+  return {
+    server: {
+          port: 3000,
+    },
+    build: {
+        distDir: ".next",
+        includeRoutePatterns: [],
+        blockRoutePatterns: [],
+    }
+  }
+};

package/templates/server.js

@@ -0,0 +1,3 @@
+const { createNxPageServer } = require("nxpage");
+
+createNxPageServer();

package/dist/templates/next.config.ts

@@ -1,6 +0,0 @@
-import type { NextConfig } from "next";
-import { withNxPage } from "nxpage";
-
-const nextConfig: NextConfig = {};
-
-export default withNxPage(nextConfig);

package/dist/templates/server.ts

@@ -1,5 +0,0 @@
-const { createNxPageServer } = require("nxpage");
-
-createNxPageServer({
-  port: process.env.PORT || 3000,
-});