create-nextly-app 0.0.2-alpha.7 → 0.0.2-alpha.71

package/templates/plugin/src/plugin.ts

@@ -0,0 +1,48 @@
+import { definePlugin } from "@nextlyhq/plugin-sdk";
+
+import { Examples } from "./collections/example";
+import type { MyPluginOptions } from "./types";
+
+/**
+ * Your plugin factory. Call it in a host app's `defineConfig({ plugins: [...] })`.
+ *
+ * @example
+ * ```ts
+ * import { myPlugin } from "{{pluginName}}";
+ * export default defineConfig({ plugins: [myPlugin({ greeting: "Hi" })] });
+ * ```
+ */
+export const myPlugin = (opts: MyPluginOptions = {}) =>
+  definePlugin({
+    name: "{{pluginName}}",
+    version: "0.1.0",
+    nextly: "{{nextlyRange}}",
+    enabled: opts.enabled,
+    contributes: {
+      collections: [Examples],
+      permissions: [
+        { action: "manage", resource: "examples", label: "Manage Examples" },
+      ],
+      admin: {
+        menu: [
+          {
+            label: "Examples",
+            to: "/admin/collections/examples",
+            icon: "Sparkles",
+          },
+        ],
+        settings: { component: "{{pluginName}}/admin#SettingsPage" },
+      },
+    },
+    init(ctx) {
+      const greeting = opts.greeting ?? "Hello";
+      // Resolve your own slug via ctx.self so this keeps working if the host
+      // renames the collection (D54). React to the post-commit create event.
+      ctx.events.on(`collection.${ctx.self.collections.examples}.created`, () =>
+        ctx.logger.info(`${greeting} from {{pluginName}} — example created`)
+      );
+    },
+    destroy() {
+      // Clean up here (subscriptions are auto-dropped on registry reset).
+    },
+  });

package/templates/plugin/src/types.ts

@@ -0,0 +1,17 @@
+/**
+ * Options accepted by your plugin factory. These are JSDoc-documented so editors
+ * surface them at the call site (D44).
+ */
+export interface MyPluginOptions {
+  /**
+   * Greeting prefix used by the example collection's `afterCreate` hook.
+   * @default "Hello"
+   */
+  greeting?: string;
+
+  /**
+   * Disable the plugin's behavior (init/hooks/events/routes/admin) while still
+   * applying its schema contributions. Default `true`.
+   */
+  enabled?: boolean;
+}

package/templates/plugin/template.json

@@ -0,0 +1,14 @@
+{
+  "name": "plugin",
+  "label": "Plugin",
+  "description": "Build a reusable Nextly plugin (publishable npm package)",
+  "hint": "Plugin package + embedded /dev playground; no schema approach",
+  "approaches": [],
+  "defaultApproach": null,
+  "collections": [],
+  "singles": [],
+  "hasDemoData": false,
+  "hasFrontendPages": false,
+  "recommendedDatabase": "sqlite",
+  "release": "alpha"
+}

package/templates/plugin/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": false
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "dev"]
+}

package/templates/plugin/tsdown.config.ts

@@ -0,0 +1,30 @@
+import { defineConfig } from "tsdown";
+
+// The host provides these. Each name and its subpaths stay external: bundling
+// one would ship a second copy of code the host already provides.
+const HOST_PACKAGES = [
+  "nextly",
+  "@nextlyhq/admin",
+  "@nextlyhq/plugin-sdk",
+  "@nextlyhq/ui",
+  "react",
+  "react-dom",
+];
+
+// Builds the publishable plugin. `dev/` is NOT an entry — it never ships.
+export default defineConfig({
+  entry: ["src/index.ts", "src/admin/index.ts"],
+  format: ["esm"],
+  dts: true,
+  clean: true,
+  sourcemap: true,
+  treeshake: true,
+  deps: {
+    neverBundle: id =>
+      HOST_PACKAGES.some(name => id === name || id.startsWith(`${name}/`)),
+  },
+  // `.mjs` and `.d.ts`, the names the package's exports map publishes.
+  outExtensions() {
+    return { js: ".mjs", dts: ".d.ts" };
+  },
+});

package/templates/plugin/vitest.config.ts

@@ -0,0 +1,27 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    environment: "node",
+    include: ["src/**/*.test.ts"],
+    /*
+     * Sized for an instance boot, because that is what this suite does.
+     *
+     * `plugin.test.ts` calls `createTestNextly` in `beforeEach`, which builds a
+     * DI container, registers the plugin's schema and runs auto-sync against a
+     * real SQLite database. Vitest's defaults are sized for a unit test that
+     * touches none of that: 5s for a case and 10s for a hook. A boot is about a
+     * second and a half on a warm machine, and the first run of a freshly
+     * scaffolded project is the least warm moment there is - a cold install, no
+     * build cache, whatever the laptop or CI container is doing.
+     *
+     * This is the first command a new plugin author runs, so a timeout here
+     * reads as "the scaffold ships a broken test" rather than "the budget was
+     * tight". The monorepo solves the same problem by routing boots to a lane
+     * with a 30s budget; a single-package project has one lane and nothing to
+     * contend with, so it states the budget instead.
+     */
+    testTimeout: 30_000,
+    hookTimeout: 30_000,
+  },
+});