create-objectstack 4.0.3 → 4.0.4

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> create-objectstack@4.0.3 build /home/runner/work/framework/framework/packages/create-objectstack
+> create-objectstack@4.0.4 build /home/runner/work/framework/framework/packages/create-objectstack
 > tsup
 
 CLI Building entry: src/index.ts
@@ -9,5 +9,5 @@
 CLI Target: es2022
 CLI Cleaning output folder
 ESM Build start
-ESM dist/index.js 16.79 KB
-ESM ⚡️ Build success in 30ms
+ESM dist/index.js 17.97 KB
+ESM ⚡️ Build success in 45ms

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # create-objectstack
 
+## 4.0.4
+
 ## 4.0.3
 
 ## 4.0.2

package/dist/index.js

@@ -4,6 +4,10 @@ import chalk from "chalk";
 import fs from "fs";
 import path from "path";
 import { execSync } from "child_process";
+import { fileURLToPath } from "url";
+var __filename = fileURLToPath(import.meta.url);
+var __dirname = path.dirname(__filename);
+var TEMPLATES_DIR = path.resolve(__dirname, "templates");
 var TEMPLATES = {
   "minimal-api": {
     description: "Server + memory driver + 1 object + REST API",
@@ -541,6 +545,12 @@ MIT
     }
   }
 };
+function readTemplate(filename) {
+  return fs.readFileSync(path.join(TEMPLATES_DIR, filename), "utf-8");
+}
+var AI_CONFIG_FILES = {
+  ".github/copilot-instructions.md": (name) => readTemplate("copilot-instructions.md").replaceAll("{{PROJECT_NAME}}", name).replaceAll("{{PROJECT_TITLE}}", toTitleCase(name))
+};
 function toTitleCase(str) {
   return str.replace(/[-_]/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
 }
@@ -600,7 +610,8 @@ var program = new Command().name("create-objectstack").description("Create a new
     if (!fs.existsSync(targetDir)) {
       fs.mkdirSync(targetDir, { recursive: true });
     }
-    for (const [filePath, contentFn] of Object.entries(template.files)) {
+    const allFiles = { ...template.files, ...AI_CONFIG_FILES };
+    for (const [filePath, contentFn] of Object.entries(allFiles)) {
       const fullPath = path.join(targetDir, filePath);
       const dir = path.dirname(fullPath);
       if (!fs.existsSync(dir)) {
@@ -625,6 +636,21 @@ var program = new Command().name("create-objectstack").description("Create a new
         console.log("");
       }
     }
+    if (!options.skipInstall) {
+      printStep("Installing AI skills for your coding agent...");
+      try {
+        execSync("npx -y skills add objectstack-ai/framework --all", {
+          stdio: "inherit",
+          cwd: targetDir
+        });
+        console.log("");
+      } catch {
+        printWarning(
+          "Skills installation skipped. Run manually:\n    npx skills add objectstack-ai/framework"
+        );
+        console.log("");
+      }
+    }
     printSuccess("Project created!");
     console.log("");
     console.log(chalk.bold("  Next steps:"));
@@ -636,6 +662,11 @@ var program = new Command().name("create-objectstack").description("Create a new
     }
     console.log(chalk.dim("    npm run dev           # Start development server"));
     console.log(chalk.dim("    npm run validate      # Check configuration"));
+    if (options.skipInstall) {
+      console.log("");
+      console.log(chalk.bold("  AI Skills (recommended):"));
+      console.log(chalk.dim("    npx skills add objectstack-ai/framework"));
+    }
     console.log("");
   } catch (error) {
     printError(error.message || String(error));

package/dist/templates/copilot-instructions.md

@@ -0,0 +1,74 @@
+# {{PROJECT_TITLE}} — Copilot Instructions
+
+> Auto-generated by `create-objectstack`. Customise freely.
+
+## Project Context
+
+This is an **ObjectStack** application — a metadata-driven low-code project
+that defines business objects, views, automations, and AI agents in TypeScript.
+
+- **Entry point:** `objectstack.config.ts` (uses `defineStack()`)
+- **Spec package:** `@objectstack/spec` (Zod-first schemas and types)
+
+## Naming Conventions
+
+| Context | Convention | Example |
+|:--------|:-----------|:--------|
+| Config keys (TS props) | `camelCase` | `maxLength`, `defaultValue` |
+| Machine names (data values) | `snake_case` | `project_task`, `first_name` |
+| Metadata type names | singular | `'agent'`, `'view'`, `'flow'` |
+| File names | `{name}.{type}.ts` | `task.object.ts`, `main.app.ts` |
+
+## Key Rules
+
+1. **Zod First** — All schema definitions start with Zod. Types are derived via `z.infer<>`.
+2. `defineStack()` is the single configuration entry point in `objectstack.config.ts`.
+3. Use `Object.values()` barrel pattern for metadata arrays.
+4. Import from `@objectstack/spec` — never use relative paths into the spec package.
+
+## Project Structure
+
+```
+{{PROJECT_NAME}}/
+├── objectstack.config.ts    # defineStack() — the single entry point
+├── src/
+│   ├── objects/              # Business object definitions (snake_case names)
+│   ├── views/                # UI view definitions (list, form, kanban, calendar)
+│   ├── apps/                 # App navigation & page structure
+│   ├── flows/                # Automation flows & workflows
+│   ├── actions/              # Custom actions (buttons, bulk ops)
+│   ├── dashboards/           # BI dashboards
+│   ├── reports/              # Analytics reports
+│   ├── agents/               # AI agent definitions
+│   ├── i18n/                 # Translation bundles
+│   └── handlers/             # Runtime hook handlers
+```
+
+## AI Skills
+
+This project uses ObjectStack skills from `objectstack-ai/framework`.
+Install or update skills with the standard [skills CLI](https://skills.sh/):
+
+```bash
+npx skills add objectstack-ai/framework
+```
+
+Skills are triggered automatically based on task context:
+
+| Skill | Trigger Context |
+|:------|:----------------|
+| **objectstack-schema** | Define objects, fields, relationships, validations, indexes |
+| **objectstack-query** | Filters, sorting, pagination, aggregation, ObjectQL |
+| **objectstack-ui** | Views, dashboards, apps, reports, actions, navigation |
+| **objectstack-api** | REST endpoints, authentication, service contracts |
+| **objectstack-plugin** | Plugin lifecycle, DI, services, hooks, events |
+| **objectstack-automation** | Flows, workflows, triggers, approvals, state machines |
+| **objectstack-ai** | Agents, tools, skills, RAG pipelines, LLM config |
+| **objectstack-quickstart** | Project setup, defineStack(), driver selection |
+| **objectstack-i18n** | Translation bundles, locale config, coverage detection |
+
+## Learn More
+
+- [ObjectStack Documentation](https://objectstack.com/docs)
+- [GitHub: objectstack-ai/framework](https://github.com/objectstack-ai/framework)
+- [Skills CLI](https://skills.sh/) — Manage AI skills across agents

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-objectstack",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Create a new ObjectStack project — npx create-objectstack",
   "bin": {
     "create-objectstack": "./bin/create-objectstack.js"

package/src/index.ts

@@ -5,6 +5,11 @@ import chalk from 'chalk';
 import fs from 'fs';
 import path from 'path';
 import { execSync } from 'child_process';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const TEMPLATES_DIR = path.resolve(__dirname, 'templates');
 
 // ─── Template Registry ──────────────────────────────────────────────
 
@@ -555,6 +560,23 @@ MIT
   },
 };
 
+// ─── Shared AI Configuration Files ──────────────────────────────────
+// These files are added to every template so third-party developers
+// get AI-assisted development (Copilot + Claude) out of the box.
+// Templates are maintained as standalone files in src/templates/ for
+// easy editing — no need to modify TypeScript code.
+
+function readTemplate(filename: string): string {
+  return fs.readFileSync(path.join(TEMPLATES_DIR, filename), 'utf-8');
+}
+
+const AI_CONFIG_FILES: TemplateFiles = {
+  '.github/copilot-instructions.md': (name) =>
+    readTemplate('copilot-instructions.md')
+      .replaceAll('{{PROJECT_NAME}}', name)
+      .replaceAll('{{PROJECT_TITLE}}', toTitleCase(name)),
+};
+
 // ─── Helpers ────────────────────────────────────────────────────────
 
 function toCamelCase(str: string): string {
@@ -650,8 +672,11 @@ const program = new Command()
         fs.mkdirSync(targetDir, { recursive: true });
       }
 
-      // Write every file defined by the template
-      for (const [filePath, contentFn] of Object.entries(template.files)) {
+      // Merge template files with shared AI configuration files
+      const allFiles: TemplateFiles = { ...template.files, ...AI_CONFIG_FILES };
+
+      // Write every file defined by the template + AI config
+      for (const [filePath, contentFn] of Object.entries(allFiles)) {
         const fullPath = path.join(targetDir, filePath);
         const dir = path.dirname(fullPath);
 
@@ -684,6 +709,24 @@ const program = new Command()
         }
       }
 
+      // Install ObjectStack AI skills via the standard skills CLI
+      if (!options.skipInstall) {
+        printStep('Installing AI skills for your coding agent...');
+        try {
+          execSync('npx -y skills add objectstack-ai/framework --all', {
+            stdio: 'inherit',
+            cwd: targetDir,
+          });
+          console.log('');
+        } catch {
+          printWarning(
+            'Skills installation skipped. Run manually:\n' +
+            '    npx skills add objectstack-ai/framework',
+          );
+          console.log('');
+        }
+      }
+
       printSuccess('Project created!');
       console.log('');
 
@@ -697,6 +740,11 @@ const program = new Command()
       }
       console.log(chalk.dim('    npm run dev           # Start development server'));
       console.log(chalk.dim('    npm run validate      # Check configuration'));
+      if (options.skipInstall) {
+        console.log('');
+        console.log(chalk.bold('  AI Skills (recommended):'));
+        console.log(chalk.dim('    npx skills add objectstack-ai/framework'));
+      }
       console.log('');
 
     } catch (error: any) {

package/src/templates/copilot-instructions.md

@@ -0,0 +1,74 @@
+# {{PROJECT_TITLE}} — Copilot Instructions
+
+> Auto-generated by `create-objectstack`. Customise freely.
+
+## Project Context
+
+This is an **ObjectStack** application — a metadata-driven low-code project
+that defines business objects, views, automations, and AI agents in TypeScript.
+
+- **Entry point:** `objectstack.config.ts` (uses `defineStack()`)
+- **Spec package:** `@objectstack/spec` (Zod-first schemas and types)
+
+## Naming Conventions
+
+| Context | Convention | Example |
+|:--------|:-----------|:--------|
+| Config keys (TS props) | `camelCase` | `maxLength`, `defaultValue` |
+| Machine names (data values) | `snake_case` | `project_task`, `first_name` |
+| Metadata type names | singular | `'agent'`, `'view'`, `'flow'` |
+| File names | `{name}.{type}.ts` | `task.object.ts`, `main.app.ts` |
+
+## Key Rules
+
+1. **Zod First** — All schema definitions start with Zod. Types are derived via `z.infer<>`.
+2. `defineStack()` is the single configuration entry point in `objectstack.config.ts`.
+3. Use `Object.values()` barrel pattern for metadata arrays.
+4. Import from `@objectstack/spec` — never use relative paths into the spec package.
+
+## Project Structure
+
+```
+{{PROJECT_NAME}}/
+├── objectstack.config.ts    # defineStack() — the single entry point
+├── src/
+│   ├── objects/              # Business object definitions (snake_case names)
+│   ├── views/                # UI view definitions (list, form, kanban, calendar)
+│   ├── apps/                 # App navigation & page structure
+│   ├── flows/                # Automation flows & workflows
+│   ├── actions/              # Custom actions (buttons, bulk ops)
+│   ├── dashboards/           # BI dashboards
+│   ├── reports/              # Analytics reports
+│   ├── agents/               # AI agent definitions
+│   ├── i18n/                 # Translation bundles
+│   └── handlers/             # Runtime hook handlers
+```
+
+## AI Skills
+
+This project uses ObjectStack skills from `objectstack-ai/framework`.
+Install or update skills with the standard [skills CLI](https://skills.sh/):
+
+```bash
+npx skills add objectstack-ai/framework
+```
+
+Skills are triggered automatically based on task context:
+
+| Skill | Trigger Context |
+|:------|:----------------|
+| **objectstack-schema** | Define objects, fields, relationships, validations, indexes |
+| **objectstack-query** | Filters, sorting, pagination, aggregation, ObjectQL |
+| **objectstack-ui** | Views, dashboards, apps, reports, actions, navigation |
+| **objectstack-api** | REST endpoints, authentication, service contracts |
+| **objectstack-plugin** | Plugin lifecycle, DI, services, hooks, events |
+| **objectstack-automation** | Flows, workflows, triggers, approvals, state machines |
+| **objectstack-ai** | Agents, tools, skills, RAG pipelines, LLM config |
+| **objectstack-quickstart** | Project setup, defineStack(), driver selection |
+| **objectstack-i18n** | Translation bundles, locale config, coverage detection |
+
+## Learn More
+
+- [ObjectStack Documentation](https://objectstack.com/docs)
+- [GitHub: objectstack-ai/framework](https://github.com/objectstack-ai/framework)
+- [Skills CLI](https://skills.sh/) — Manage AI skills across agents

package/tsup.config.ts

@@ -1,10 +1,15 @@
 // Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
 
 import { defineConfig } from 'tsup';
+import { cpSync } from 'fs';
 
 export default defineConfig({
   entry: ['src/index.ts'],
   format: ['esm'],
   clean: true,
   shims: true,
+  onSuccess: async () => {
+    // Copy template files to dist/ so they sit alongside the bundled JS
+    cpSync('src/templates', 'dist/templates', { recursive: true });
+  },
 });