@contentful/create-contentful-app 4.1.0 → 4.1.2

package/README.md

@@ -56,6 +56,20 @@ Select between predefined and custom templates:
 
 These flags are mutually exclusive. If no flag is provided, the TypeScript template is used.
 
+### AI App-Building Skill
+
+By default, `create-contentful-app` installs Contentful's official app-building AI skill ([`contentful-custom-app-from-scratch`](https://github.com/contentful/skills)) into your new app. The skill gives AI coding harnesses (Claude Code, OpenAI Codex, Cursor, and others) expert guidance for building Contentful apps. It is pulled live via the [`skills`](https://skills.sh) CLI at scaffold time, so you always get the current version, and the CLI automatically detects your harness.
+
+In interactive mode you are asked whether to include it (default yes). Installation is best-effort: if it fails (e.g. you are offline), your app is still created and a message shows the command to add it later.
+
+- `--skip-skills` (or `--no-skills`): do not install the app-building skill.
+
+To install it manually later, run this inside your app folder:
+
+```bash
+npx -y skills add contentful/skills --skill contentful-custom-app-from-scratch -y
+```
+
 Some popular templates are:
 
 | Template                                                                         | CLI Command                                       |
@@ -98,6 +112,8 @@ Options:
                                                 format: URL (HTTPS or SSH) or vendor:user/repo (e.g., github:user/repo)
   -f, --function <function-template-name>       include the specified function template
   --skip-ui                                     use with --function to clone the template without a user interface (UI).
+  --skip-skills                                 skip installing the Contentful app-building AI skill into the new app
+  --no-skills                                   alias for --skip-skills
   -h, --help                                    shows all available CLI options
 ```
 

package/lib/index.js

@@ -17,10 +17,22 @@ const logger_1 = require("./logger");
 const chalk_1 = __importDefault(require("chalk"));
 const constants_1 = require("./constants");
 const getTemplateSource_1 = require("./getTemplateSource");
+const skills_1 = require("./skills");
 const analytics_1 = require("./analytics");
 const app_scripts_1 = require("@contentful/app-scripts");
 const fs_2 = __importDefault(require("fs"));
 const DEFAULT_APP_NAME = 'contentful-app';
+/**
+ * Whether the CLI is running without any template-selecting flags. In that case
+ * we prompt the user (e.g. for the app-building skill); otherwise we honor the flags.
+ */
+function isInteractiveRun(options) {
+    return (!options.example &&
+        !options.source &&
+        !options.javascript &&
+        !options.typescript &&
+        !options.function);
+}
 function successMessage(folder, packageManager) {
     let command = '';
     if (packageManager === 'yarn') {
@@ -112,6 +124,10 @@ async function initProject(appName, options) {
         else {
             await (0, utils_1.exec)('npm', ['install', '--no-audit', '--no-fund'], { cwd: fullAppFolder });
         }
+        const includeSkill = await (0, skills_1.resolveShouldIncludeSkill)(normalizedOptions, isInteractiveRun(normalizedOptions));
+        if (includeSkill) {
+            await (0, skills_1.installAppBuildingSkill)(fullAppFolder);
+        }
         successMessage(fullAppFolder, packageManager);
     }
     catch (err) {
@@ -119,11 +135,7 @@ async function initProject(appName, options) {
         process.exit(1);
     }
     async function addAppExample(fullAppFolder) {
-        const isInteractive = !normalizedOptions.example &&
-            !normalizedOptions.source &&
-            !normalizedOptions.javascript &&
-            !normalizedOptions.typescript &&
-            !normalizedOptions.function;
+        const isInteractive = isInteractiveRun(normalizedOptions);
         const templateSource = await (0, getTemplateSource_1.getTemplateSource)(options);
         (0, analytics_1.track)({
             template: templateSource,
@@ -193,6 +205,8 @@ async function initProject(appName, options) {
     ].join('\n'))
         .option('-f, --function [function-template-name]', 'include the specified function template')
         .option('--skip-ui', 'use with --function to clone the template without a user interface (UI).')
+        .option('--skip-skills', 'skip installing the Contentful app-building AI skill into the new app')
+        .option('--no-skills', 'alias for --skip-skills')
         .action(initProject);
     await commander_1.program.parseAsync();
 })();

package/lib/skills.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveShouldIncludeSkill = exports.promptIncludeSkill = exports.installAppBuildingSkill = exports.MANUAL_INSTALL_COMMAND = exports.APP_BUILDING_SKILL = exports.SKILLS_SOURCE = void 0;
+const inquirer_1 = __importDefault(require("inquirer"));
+const child_process_1 = require("child_process");
+const logger_1 = require("./logger");
+exports.SKILLS_SOURCE = 'contentful/skills';
+exports.APP_BUILDING_SKILL = 'contentful-custom-app-from-scratch';
+/**
+ * The command a user can run manually to install the skill later. Kept in sync
+ * with the arguments passed to the default runner below.
+ */
+exports.MANUAL_INSTALL_COMMAND = `npx -y skills add ${exports.SKILLS_SOURCE} --skill ${exports.APP_BUILDING_SKILL} -y`;
+const defaultRunner = (appFolder) => new Promise((resolve, reject) => {
+    const child = (0, child_process_1.spawn)('npx', ['-y', 'skills', 'add', exports.SKILLS_SOURCE, '--skill', exports.APP_BUILDING_SKILL, '-y'], { stdio: 'inherit', shell: true, cwd: appFolder });
+    child.on('error', reject);
+    child.on('exit', (exitCode) => {
+        if (exitCode === 0) {
+            resolve();
+        }
+        else {
+            reject(new Error(`skills installer exited with code ${exitCode ?? 'unknown'}`));
+        }
+    });
+});
+/**
+ * Best-effort installation of the Contentful app-building skill into a scaffolded
+ * app. The skill is pulled live via the `skills` CLI so it is always current and
+ * works across AI harnesses (Claude Code, OpenAI Codex, Cursor, and others — the
+ * CLI auto-detects the active harness).
+ *
+ * This never throws: a failure (offline, npx error, etc.) is logged as a warning
+ * with the manual command so app creation always completes.
+ *
+ * @returns `true` if the skill was installed, `false` if installation was skipped
+ *          due to an error.
+ */
+async function installAppBuildingSkill(appFolder, deps = {}) {
+    const run = deps.run ?? defaultRunner;
+    console.log(`Installing the Contentful app-building AI skill (${(0, logger_1.highlight)(exports.APP_BUILDING_SKILL)})...`);
+    try {
+        await run(appFolder);
+        console.log(`${(0, logger_1.success)('Done!')} Added the ${(0, logger_1.highlight)(exports.APP_BUILDING_SKILL)} skill to your app.`);
+        return true;
+    }
+    catch (e) {
+        const reason = e instanceof Error ? e.message : String(e);
+        (0, logger_1.warn)(`Could not install the Contentful app-building AI skill (${reason}). Your app was created successfully. ` +
+            `To add it later, run ${(0, logger_1.choice)(exports.MANUAL_INSTALL_COMMAND)} inside your app folder.`);
+        return false;
+    }
+}
+exports.installAppBuildingSkill = installAppBuildingSkill;
+/**
+ * Prompts the user (interactive mode only) whether to include the app-building
+ * skill. Defaults to yes.
+ */
+async function promptIncludeSkill() {
+    const { includeSkill } = await inquirer_1.default.prompt([
+        {
+            type: 'confirm',
+            name: 'includeSkill',
+            message: 'Include the Contentful app-building AI skill?',
+            default: true,
+        },
+    ]);
+    return includeSkill;
+}
+exports.promptIncludeSkill = promptIncludeSkill;
+/**
+ * Resolves whether the app-building skill should be installed.
+ *
+ * - An explicit opt-out (`--skip-skills`, or commander's `--no-skills` which sets
+ *   `skills: false`) always wins and never prompts.
+ * - In interactive mode, the user is prompted (default yes).
+ * - In non-interactive / flagged runs, the skill is installed by default.
+ */
+async function resolveShouldIncludeSkill(options, isInteractive, prompt = promptIncludeSkill) {
+    if (options.skipSkills === true || options.skills === false) {
+        return false;
+    }
+    if (isInteractive) {
+        return prompt();
+    }
+    return true;
+}
+exports.resolveShouldIncludeSkill = resolveShouldIncludeSkill;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -36,7 +36,7 @@
     "test": "mocha 'test/**/*.spec.{js,ts}'"
   },
   "dependencies": {
-    "@contentful/app-scripts": "4.1.0",
+    "@contentful/app-scripts": "4.1.1",
     "@segment/analytics-node": "^3.0.0",
     "chalk": "4.1.2",
     "commander": "12.1.0",