@smapiot/pilet-template-angular 1.0.18-beta.8445c7e → 1.0.19-beta.9a34a2e

package/lib/index.js

@@ -1614,7 +1614,7 @@ function getStandardPackageJson(cliVersion, ngVersion, majorNgVersion) {
 // src/index.ts
 var root = (0, import_path.resolve)(__dirname, "..");
 var index_default = (0, import_template_utils.createPiletTemplateFactory)(root, (projectRoot, args, details) => {
-  const { sourceName } = args;
+  const { sourceName, agents } = args;
   const piralInstance = (0, import_template_utils.getPiralInstance)(projectRoot, sourceName);
   if (typeof args.standalone === "undefined") {
     args.standalone = detectMode(piralInstance);
@@ -1694,6 +1694,13 @@ var index_default = (0, import_template_utils.createPiletTemplateFactory)(root,
       target: "<root>/tsconfig.json"
     }
   ];
+  if (agents) {
+    templates.push({
+      languages: ["js", "ts"],
+      name: "AGENTS.md",
+      target: "<root>/AGENTS.md"
+    });
+  }
   if (args.ngStandalone) {
     templates.push({
       languages: ["ts"],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smapiot/pilet-template-angular",
-  "version": "1.0.18-beta.8445c7e",
+  "version": "1.0.19-beta.9a34a2e",
   "description": "Official scaffolding template for pilets: 'angular'.",
   "keywords": [
     "piral-cli",
@@ -31,6 +31,11 @@
       "description": "Defines the (major) version of Angular to use in case of a standalone pilet.",
       "default": 20,
       "type": "number"
+    },
+    "agents": {
+      "description": "Generate an AGENTS.md rules file for AI assistants.",
+      "default": true,
+      "type": "boolean"
     }
   },
   "author": "smapiot",
@@ -59,7 +64,7 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "devDependencies": {
-    "@smapiot/template-utils": "1.0.18-beta.8445c7e"
+    "@smapiot/template-utils": "1.0.19-beta.9a34a2e"
   },
-  "gitHead": "8445c7e2d3e950ebf24f5cd90c9b521dff4174fd"
+  "gitHead": "9a34a2ee4fe3fbaa52ac34fc9b8bee63b795eae8"
 }

package/src/index.ts

@@ -15,10 +15,11 @@ interface AngularPiletArgs {
   ngVersion: number;
   ngStandalone: boolean;
   withZone?: boolean;
+  agents?: boolean;
 }
 
 export default createPiletTemplateFactory<AngularPiletArgs>(root, (projectRoot, args, details) => {
-  const { sourceName } = args;
+  const { sourceName, agents } = args;
   const piralInstance = getPiralInstance(projectRoot, sourceName);
 
   if (typeof args.standalone === 'undefined') {
@@ -109,6 +110,14 @@ export default createPiletTemplateFactory<AngularPiletArgs>(root, (projectRoot,
     },
   ];
 
+  if (agents) {
+    templates.push({
+      languages: ['js', 'ts'],
+      name: 'AGENTS.md',
+      target: '<root>/AGENTS.md',
+    });
+  }
+
   if (args.ngStandalone) {
     templates.push({
       languages: ['ts'],

package/templates/AGENTS.md.ejs

@@ -0,0 +1,39 @@
+# Micro Frontend project rules (for AI assistants)
+
+> Generated when this pilet was scaffolded. Most assistants read AGENTS.md
+> (Cursor/Claude), .cursorrules, or .github/copilot-instructions.md — copy or
+> symlink as needed. Keep this in sync with the app shell's real capabilities.
+
+This repository is the pilet **<%- piletName %>**, built with Piral (React micro
+frontends). It uses Angular to declare and expose components and primarely targets
+the app shell **<%- sourceName %>**.
+
+## Contract
+
+- App shell package: `<%- sourceName %>`. Import the Pilet API as:
+  `import type { PiletApi } from '<%- sourceName %>'`.
+- Installed Pilet API plugins — only these methods exist: <%- (typeof plugins !== 'undefined' && plugins && plugins.length) ? plugins.join(', ') : 'see the app shell package.json' %>.
+- Centrally shared externals (provided by the shell — never bundle, never import a
+  different version): `react`, `react-dom`, and anything else the shell declares in
+  its `importmap` (e.g. `react-router-dom`, a design system).
+- Extension slots: list the slot names (and their `params`) your app shell and other pilets expose.
+
+## Conventions
+
+- A pilet's only entry is a single exported `setup(api: PiletApi)` function.
+  Register pages, menus, and extensions there.
+- Only call Pilet API methods provided by the plugins listed above. Do not invent methods.
+- Never install `piral-cli` globally; never use `pilet new` or `piral new`. Run the
+  CLI via npm scripts or `npx` (`npx pilet debug | build | publish`).
+- Share libraries via the `importmap` in `package.json`; treat the externals above
+  as provided by the shell.
+- Pilets must not import each other. Compose UI via extension slots; share data via
+  events or the shared data store.
+- Registrations are cleaned up automatically on unload/hot-reload; only call
+  `unregister*` for genuinely dynamic cases.
+- Prefer `piral-core` over `piral` for long-lived shells (same API, explicit plugins).
+- Write tests with Vitest by unit-testing `setup()` with a mock `PiletApi`.
+
+## Docs
+
+- Piral documentation: https://docs.piral.io