Feature create-apostrophe

.changeset/env-secrets-support.md

@@ -0,0 +1,5 @@
+---
+"apostrophe": minor
+---
+
+The session secret and the uploadfs `disabledFileKey` can now be supplied via the `APOS_SESSION_SECRET` and `APOS_UPLOADFS_DISABLED_FILE_KEY` environment variables. As with other Apostrophe environment variables, these take precedence over the corresponding `app.js` configuration.

.changeset/soft-hats-smile.md

@@ -0,0 +1,6 @@
+---
+"@apostrophecms/cli": major
+---
+
+**Breaking:** `apos create` is now an interactive guided installer (it delegates to `create-apostrophe`). The `<shortname>` positional argument and the `--starter` and `--mongodb-uri` options have been removed - project name, starter kit, and database are now chosen through prompts. For scripted installs, use `npm create apostrophe@latest -- --unattended` instead.
+

.gitignore

@@ -8,3 +8,4 @@ coverage/
 .nyc_output
 claude-tools/logs/
 .claude
+specs/

packages/apostrophe/modules/@apostrophecms/express/index.js

@@ -579,6 +579,8 @@ module.exports = {
           name: self.apos.shortName + '.sid',
           cookie: {}
         });
+        // Env overrides config, per Apostrophe convention.
+        sessionOptions.secret = process.env.APOS_SESSION_SECRET || sessionOptions.secret;
         _.defaults(sessionOptions.cookie, {
           path: '/',
           httpOnly: true,

packages/apostrophe/modules/@apostrophecms/uploadfs/index.js

@@ -41,6 +41,9 @@ module.exports = {
         const uploadfsSettings = {};
         _.merge(uploadfsSettings, uploadfsDefaultSettings);
         _.merge(uploadfsSettings, options);
+        if (process.env.APOS_UPLOADFS_DISABLED_FILE_KEY) {
+          uploadfsSettings.disabledFileKey = process.env.APOS_UPLOADFS_DISABLED_FILE_KEY;
+        }
         if (process.env.APOS_S3_BUCKET) {
           _.merge(uploadfsSettings, {
             backend: 's3',

packages/cli/bin/apostrophe

@@ -15,6 +15,7 @@ async function execute () {
   util.checkDependencies();
 
   require('../lib/commands/create')(program);
+  require('../lib/commands/telemetry')(program);
   require('../lib/commands/add')(program, versionInfo.core);
 
   await confUtils.checkConf();

packages/cli/lib/commands/create.js

@@ -1,202 +1,13 @@
-require('shelljs/global');
-// Utilities from shelljs
-/* globals cd rm */
-const prompts = require('prompts');
-const path = require('path');
-const util = require('../util');
-const config = require('../../config');
-const fs = require('fs');
-const { stripIndent } = require('common-tags');
+// Thin delegate: hands off to create-apostrophe's guided installer. Owns
+// no UI of its own — Commander supplies `--help` for this subcommand.
 
 module.exports = function (program) {
   program
-    .command('create <shortname-without-spaces>')
-    .description(
-      stripIndent`
-      Create an Apostrophe project (using the apostrophe essentials starter kit by default).
-      Example: \`apos create my-website\`
-    `
-    )
-    .option(
-      '--starter <url>',
-      'Use a specific git repository to use as the project starter.\n You can also use the short name of any Apostrophe starter kit, e.g. "ecommerce"'
-    )
-    .option(
-      '--mongodb-uri <url>',
-      'Add a connection string to connect to a hosted MongoDB instance.'
-    )
-    .action(async function (shortName, options) {
-      if (!/^[\w-]+$/.test(shortName)) {
-        await util.error('create', 'The shortname must only contain letters, numbers, hyphens, and underscores.');
-        return false;
-      }
-
-      // If options.starter is undefined, use config.BOILERPLATE
-      const input = options.starter ? options.starter : config.BOILERPLATE;
-
-      // Check for complete repo URL, starterkit name, or incomplete URL fallback
-      let boilerplateUrl;
-      if (/^\w+:/.test(input)) {
-        boilerplateUrl = input;
-      } else if (input.includes('/')) {
-        boilerplateUrl = `https://github.com/${
-          input.startsWith('/') ? input.slice(1) : input
-        }`;
-      } else {
-        boilerplateUrl = `https://github.com/apostrophecms/starter-kit-${input}.git`;
-      }
-      util.log(
-        'create',
-        `Grabbing the ${boilerplateUrl} starter from Github [1/4]`
-      );
-
-      // Clone the boilerplate project
-      if ((await util.spawnSafe('git', [ 'clone', boilerplateUrl, shortName ])).code !== 0) {
-        await util.error('create', 'Error cloning starter code.');
-        return false;
-      }
-
-      cd(shortName);
-
-      // Remove the initial .git directory.
-      rm('-rf', '.git/');
-
-      // Auto-detect Astro projects by checking for backend directory
-      const isAstroProject = fs.existsSync('backend');
-      const backendPath = isAstroProject ? 'backend' : '.';
-      const resolvePath = (relativePath) => {
-        if (backendPath === '.') {
-          return relativePath;
-        }
-        return path.join(backendPath, relativePath);
-      };
-
-      util.log('create', `Adding your project shortname (${shortName}) [2/4]`);
-
-      // Do some token replaces to rename the project
-      // replaces the shortname in app.js
-      replaceInConfig(/(shortName:).*?,/gi, `$1 '${shortName}',`, resolvePath);
-      // replaces the shortname in package.json
-      replaceInConfig(/("name":).*?,/g, `$1 "${shortName}",`, resolvePath);
-
-      // Generate session secret
-      let secret = util.secret();
-
-      const expressIndexPath = resolvePath('lib/modules/apostrophe-express/index.js');
-      if (fs.existsSync(expressIndexPath)) {
-        util.replaceInFiles(
-          [ expressIndexPath ],
-          /secret: undefined/,
-          `secret: '${secret}'`
-        );
-      }
-
-      // Set disabledFileKey for uploadfs
-      secret = util.secret();
-
-      util.replaceInFiles(
-        [ resolvePath('app.js') ],
-        /disabledFileKey: undefined/,
-        `disabledFileKey: '${secret}'`
-      );
-
-      // Remove lock file and install packages.
-      util.log('create', 'Installing packages [3/4]');
-
-      const packageLockPath = resolvePath('package-lock.json');
-      const yarnLockPath = resolvePath('yarn.lock');
-
-      if (fs.existsSync(packageLockPath)) {
-        rm(packageLockPath);
-      }
-      if (fs.existsSync(yarnLockPath)) {
-        rm(yarnLockPath);
-      }
-
-      // Run npm install in the appropriate directories
-      if (isAstroProject) {
-        // Install backend packages
-        try {
-          await util.spawnWithSpinner('npm install --prefix backend', {
-            spinnerMessage:
-              'Installing backend packages. This will take a little while...'
-          });
-        } catch (error) {
-          await util.error('create', 'Error installing backend packages');
-
-          console.error(error);
-        }
-
-        // Install frontend packages
-        try {
-          await util.spawnWithSpinner('npm install --prefix frontend', {
-            spinnerMessage:
-              'Installing frontend packages. This will take a little while...'
-          });
-        } catch (error) {
-          await util.error('create', 'Error installing frontend packages');
-
-          console.error(error);
-        }
-      } else {
-        try {
-          await util.spawnWithSpinner('npm install', {
-            spinnerMessage:
-              'Installing packages. This will take a little while...'
-          });
-        } catch (error) {
-          await util.error('create', 'Error installing packages');
-
-          console.error(error);
-        }
-      }
-
-      const cwd = process.cwd();
-      const aposPath = path.join(cwd, resolvePath('node_modules/apostrophe'));
-
-      // Append the installed Apostrophe version, if in an active project.
-      if (!fs.existsSync(aposPath)) {
-        await util.error('create', 'Error installing new project packages.');
-        return false;
-      }
-      const version = require(`${aposPath}/package.json`).version;
-      await util.getMajorVersion('create', version);
-
-      // Create an admin user (note this will prompt for password)
-      util.log('create', 'Creating an admin user [4/4]');
-      util.log('create', 'Choose a password for the admin user');
-
-      const response = await prompts({
-        type: 'password',
-        name: 'pw',
-        message: '🔏 Please enter a password:'
-      });
-
-      const userTask = '@apostrophecms/user:add';
-      const appJsPath = resolvePath('app.js');
-      const createUserArgs = [ appJsPath, userTask, 'admin', 'admin' ];
-
-      const createUserEnv = { ...process.env };
-      if (options.mongodbUri) {
-        createUserEnv.APOS_MONGODB_URI = options.mongodbUri;
-      }
-      util.log('create', `Creating admin user: node ${createUserArgs.join(' ')}`);
-      const createUserResult = await util.spawnSafe('node', createUserArgs, {
-        env: createUserEnv,
-        input: `${response.pw ?? ''}\n`
-      });
-      if (createUserResult.code !== 0) {
-        await util.error('create', `Admin user creation exited with code ${createUserResult.code}.`);
-        return false;
-      }
-      util.log('create', 'All done! 🎉 Login as "admin" at the /login URL.');
-
-      await util.success('create');
-      return true;
+    .command('create')
+    .description('Create an Apostrophe project — launches the guided installer.')
+    .action(async function () {
+      const { runInteractive } = await import('create-apostrophe');
+      const code = await runInteractive();
+      process.exit(typeof code === 'number' ? code : 0);
     });
 };
-
-function replaceInConfig(regex, replacement, resolvePath) {
-  const files = [ resolvePath('app.js'), resolvePath('package.json') ];
-  util.replaceInFiles(files, regex, replacement);
-}

packages/cli/lib/commands/telemetry.js

@@ -0,0 +1,24 @@
+// Thin delegate: forwards each `apos telemetry <sub>` to create-apostrophe.
+// Commander supplies `--help` for the parent and each subcommand.
+
+module.exports = function (program) {
+  const telemetry = program
+    .command('telemetry')
+    .description('Manage telemetry preference for ApostropheCMS CLI.');
+
+  for (const [ sub, summary ] of [
+    [ 'status', 'Show current telemetry preference.' ],
+    [ 'on', 'Opt in.' ],
+    [ 'off', 'Opt out.' ],
+    [ 'preview', 'Print the exact payload that would be sent.' ]
+  ]) {
+    telemetry
+      .command(sub)
+      .description(summary)
+      .action(async function () {
+        const { runTelemetryCommand } = await import('create-apostrophe');
+        const code = await runTelemetryCommand({ sub });
+        process.exit(typeof code === 'number' ? code : 0);
+      });
+  }
+};

packages/cli/package.json

@@ -21,6 +21,7 @@
     "commander": "^5.1.0",
     "common-tags": "^1.8.0",
     "conf": "^6.2.4",
+    "create-apostrophe": "workspace:^",
     "lodash": "^4.18.1",
     "ora": "^5.4.1",
     "pkginfo": "^0.4.1",

packages/create-apostrophe/.mocharc.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+// ESM specs, discovered recursively under test/. Mocha 11 runs .mjs/.js
+// ESM natively (package is "type": "module").
+module.exports = {
+  spec: [ 'test/**/*.test.js' ],
+  recursive: true,
+  timeout: 10000
+};