@contentful/create-contentful-app 2.1.6 → 2.1.8

package/README.md

@@ -96,6 +96,7 @@ Options:
   -s, --source <url>                            provide a template by its source repository.
                                                 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).
   -h, --help                                    shows all available CLI options
 ```
 

package/lib/index.js

@@ -19,6 +19,7 @@ const constants_1 = require("./constants");
 const getTemplateSource_1 = require("./getTemplateSource");
 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';
 function successMessage(folder, useYarn) {
     console.log(`
@@ -82,6 +83,28 @@ async function initProject(appName, options) {
         appName = await validateAppName(appName);
         const fullAppFolder = (0, path_1.resolve)(process.cwd(), appName);
         console.log(`Creating a Contentful app in ${(0, logger_1.highlight)((0, tildify_1.default)(fullAppFolder))}.`);
+        if (normalizedOptions.function && normalizedOptions.skipUi) {
+            await addFunctionTemplate(fullAppFolder);
+        }
+        else {
+            await addAppExample(fullAppFolder);
+        }
+        updatePackageName(fullAppFolder);
+        const useYarn = normalizedOptions.yarn || (0, utils_1.detectManager)() === 'yarn';
+        (0, logger_1.wrapInBlanks)((0, logger_1.highlight)(`---- Installing the dependencies for your app (using ${chalk_1.default.cyan(useYarn ? 'yarn' : 'npm')})...`));
+        if (useYarn) {
+            await (0, utils_1.exec)('yarn', [], { cwd: fullAppFolder });
+        }
+        else {
+            await (0, utils_1.exec)('npm', ['install', '--no-audit', '--no-fund'], { cwd: fullAppFolder });
+        }
+        successMessage(fullAppFolder, useYarn);
+    }
+    catch (err) {
+        (0, logger_1.error)(`Failed to create ${(0, logger_1.highlight)(chalk_1.default.cyan(appName))}`, err);
+        process.exit(1);
+    }
+    async function addAppExample(fullAppFolder) {
         const isInteractive = !normalizedOptions.example &&
             !normalizedOptions.source &&
             !normalizedOptions.javascript &&
@@ -100,36 +123,32 @@ async function initProject(appName, options) {
             if (normalizedOptions.function === true) {
                 normalizedOptions.function = 'external-references';
             }
-            process.chdir(fullAppFolder);
-            (0, logger_1.wrapInBlanks)(`To add additional function templates to your app, use ${(0, logger_1.highlight)(chalk_1.default.green(`
+            await addFunctionTemplate(fullAppFolder);
+        }
+    }
+    async function addFunctionTemplate(fullAppFolder) {
+        if (!fs_2.default.existsSync(fullAppFolder)) {
+            fs_2.default.mkdirSync(fullAppFolder, { recursive: true });
+        }
+        process.chdir(fullAppFolder);
+        (0, logger_1.wrapInBlanks)(`To add additional function templates to your app, use ${(0, logger_1.highlight)(chalk_1.default.green(`
           npx @contentful/app-scripts@latest generate-function \\
             --ci \\
-            --name <name> \\
+            --name <n> \\
             --example <example> \\
             --language <typescript/javascript>`))}`);
-            const functionName = normalizedOptions.function
-                .toLowerCase()
-                .replace(/-([a-z])/g, (match, letter) => letter.toUpperCase());
-            await app_scripts_1.generateFunction.nonInteractive({
-                example: normalizedOptions.function,
-                language: normalizedOptions.javascript ? 'javascript' : 'typescript',
-                name: functionName,
-            });
-        }
-        updatePackageName(fullAppFolder);
-        const useYarn = normalizedOptions.yarn || (0, utils_1.detectManager)() === 'yarn';
-        (0, logger_1.wrapInBlanks)((0, logger_1.highlight)(`---- Installing the dependencies for your app (using ${chalk_1.default.cyan(useYarn ? 'yarn' : 'npm')})...`));
-        if (useYarn) {
-            await (0, utils_1.exec)('yarn', [], { cwd: fullAppFolder });
+        if (typeof normalizedOptions.function !== 'string') {
+            throw new Error('Function template name is required');
         }
-        else {
-            await (0, utils_1.exec)('npm', ['install', '--no-audit', '--no-fund'], { cwd: fullAppFolder });
-        }
-        successMessage(fullAppFolder, useYarn);
-    }
-    catch (err) {
-        (0, logger_1.error)(`Failed to create ${(0, logger_1.highlight)(chalk_1.default.cyan(appName))}`, err);
-        process.exit(1);
+        const functionName = normalizedOptions.function
+            .toLowerCase()
+            .replace(/-([a-z])/g, (match, letter) => letter.toUpperCase());
+        await app_scripts_1.generateFunction.nonInteractive({
+            example: normalizedOptions.function,
+            language: normalizedOptions.javascript ? 'javascript' : 'typescript',
+            name: functionName,
+            keepPackageJson: normalizedOptions.skipUi === true
+        });
     }
 }
 (async function main() {
@@ -158,6 +177,7 @@ async function initProject(appName, options) {
         `format: URL (HTTPS or SSH) or ${(0, logger_1.code)('vendor:user/repo')} (e.g., ${(0, logger_1.code)('github:user/repo')})`,
     ].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).')
         .action(initProject);
     await commander_1.program.parseAsync();
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -36,7 +36,7 @@
     "test": "mocha 'test/**/*.spec.{js,ts}'"
   },
   "dependencies": {
-    "@contentful/app-scripts": "2.4.0",
+    "@contentful/app-scripts": "2.5.0",
     "@segment/analytics-node": "^2.2.0",
     "chalk": "4.1.2",
     "commander": "12.1.0",
@@ -74,11 +74,11 @@
     "@types/validate-npm-package-name": "4.0.2",
     "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
-    "contentful-management": "11.50.1",
+    "contentful-management": "11.51.0",
     "mocha": "^10.2.0",
     "sinon": "^20.0.0",
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "571371b92e6f7a3542d76192a15f002771708a86"
+  "gitHead": "f60bbb2e3b86350ae3ae6125f1cf4a5c1ccf85e6"
 }