@contentful/create-contentful-app 1.3.78 → 1.4.0

package/lib/index.js

@@ -23,12 +23,13 @@ const tildify_1 = __importDefault(require("tildify"));
 const template_1 = require("./template");
 const utils_1 = require("./utils");
 const logger_1 = require("./logger");
+const chalk_1 = __importDefault(require("chalk"));
 const DEFAULT_APP_NAME = 'contentful-app';
 function successMessage(folder) {
     console.log(`
-${(0, logger_1.success)('Success!')} Created a new Contentful app in ${(0, logger_1.highlight)((0, tildify_1.default)(folder))}.
-
-Now kick it off by running
+${(0, logger_1.success)('Success!')} Created a new Contentful app in ${(0, logger_1.highlight)((0, tildify_1.default)(folder))}.`);
+    (0, logger_1.wrapInBlanks)((0, logger_1.highlight)('---- Next Steps'));
+    console.log(`Now kick it off by running
 
     ${(0, logger_1.code)(`cd ${(0, tildify_1.default)(folder)}`)}
     ${(0, logger_1.code)(`npm start`)}
@@ -85,7 +86,9 @@ function initProject(appName, options) {
             console.log(`Creating a Contentful app in ${(0, logger_1.highlight)((0, tildify_1.default)(fullAppFolder))}.`);
             yield (0, template_1.cloneTemplateIn)(fullAppFolder, normalizedOptions);
             updatePackageName(fullAppFolder);
-            if (normalizedOptions.yarn || (0, utils_1.detectManager)() === 'yarn') {
+            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) {
                 yield (0, utils_1.exec)('yarn', [], { cwd: fullAppFolder });
             }
             else {

package/lib/logger.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.code = exports.success = exports.choice = exports.highlight = exports.error = exports.warn = void 0;
+exports.code = exports.success = exports.choice = exports.highlight = exports.wrapInBlanks = exports.error = exports.warn = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 function warn(message) {
     console.log(`${chalk_1.default.yellow('Warning:')} ${message}`);
@@ -25,6 +25,12 @@ function error(message, error) {
     }
 }
 exports.error = error;
+function wrapInBlanks(message) {
+    console.log(' ');
+    console.log(message);
+    console.log(' ');
+}
+exports.wrapInBlanks = wrapInBlanks;
 function highlight(str) {
     return chalk_1.default.bold(str);
 }

package/lib/template.js

@@ -20,26 +20,93 @@ const rimraf_1 = __importDefault(require("rimraf"));
 const types_1 = require("./types");
 const logger_1 = require("./logger");
 const utils_1 = require("./utils");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const chalk_1 = __importDefault(require("chalk"));
 const EXAMPLES_PATH = 'contentful/apps/examples/';
 function isContentfulTemplate(url) {
     return Object.values(types_1.ContentfulExample).some((t) => url.includes(EXAMPLES_PATH + t));
 }
+function getGithubFolderNames(username, repo, path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = `https://api.github.com/repos/${username}/${repo}/contents/${path}`;
+        const response = yield (0, node_fetch_1.default)(url);
+        const contents = yield response.json();
+        return contents.filter((content) => content.type === "dir")
+            .map((content) => content.name);
+    });
+}
+function promptExampleSelection() {
+    return __awaiter(this, void 0, void 0, function* () {
+        let template = 'typescript';
+        // ask user whether to start with a blank template or use an example template
+        const { starter } = yield inquirer_1.default.prompt([
+            {
+                name: 'starter',
+                message: 'Do you want to start with an example template or use one of the blank templates?',
+                type: 'list',
+                choices: ['blank', 'example'],
+                default: 'blank',
+            },
+        ]);
+        // if the user chose to use an blank template, ask which language they prefer
+        if (starter === "blank") {
+            const { language } = yield inquirer_1.default.prompt([
+                {
+                    name: 'language',
+                    message: 'Do you prefer Typescript or Javascript',
+                    type: 'list',
+                    choices: ['typescript', 'javascript'],
+                    default: 'typescript',
+                },
+            ]);
+            template = language;
+        }
+        else {
+            // get available templates from examples
+            const availableTemplates = yield getGithubFolderNames("contentful", "apps", "examples");
+            // ask user to select a template from the available examples
+            const { example } = yield inquirer_1.default.prompt([
+                {
+                    name: 'example',
+                    message: 'Select a template',
+                    type: 'list',
+                    choices: availableTemplates,
+                },
+            ]);
+            template = example;
+        }
+        // return the selected template
+        return selectTemplate(template);
+    });
+}
+function selectTemplate(template) {
+    (0, logger_1.wrapInBlanks)((0, logger_1.highlight)(`---- Cloning the ${chalk_1.default.cyan(template)} template...`));
+    return EXAMPLES_PATH + template;
+}
 function makeContentfulExampleSource(options) {
-    if (options.example) {
-        return EXAMPLES_PATH + options.example;
-    }
-    if (options.javascript) {
-        return EXAMPLES_PATH + types_1.ContentfulExample.Javascript;
-    }
-    return EXAMPLES_PATH + types_1.ContentfulExample.Typescript;
+    return __awaiter(this, void 0, void 0, function* () {
+        if (options.example) {
+            return selectTemplate(options.example);
+        }
+        if (options.javascript) {
+            return selectTemplate(types_1.ContentfulExample.Javascript);
+        }
+        if (options.typescript) {
+            return selectTemplate(types_1.ContentfulExample.Typescript);
+        }
+        return yield promptExampleSelection();
+    });
 }
 function getTemplateSource(options) {
     var _a;
-    const source = (_a = options.source) !== null && _a !== void 0 ? _a : makeContentfulExampleSource(options);
-    if (options.source && !isContentfulTemplate(source)) {
-        (0, logger_1.warn)(`Template at ${(0, logger_1.highlight)(source)} is not an official Contentful app template!`);
-    }
-    return source;
+    return __awaiter(this, void 0, void 0, function* () {
+        const source = (_a = options.source) !== null && _a !== void 0 ? _a : yield makeContentfulExampleSource(options);
+        if (options.source && !isContentfulTemplate(source)) {
+            (0, logger_1.warn)(`Template at ${(0, logger_1.highlight)(source)} is not an official Contentful app template!`);
+        }
+        return source;
+    });
 }
 function clone(source, destination) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -77,8 +144,9 @@ function cleanUp(destination) {
 }
 function cloneTemplateIn(destination, options) {
     return __awaiter(this, void 0, void 0, function* () {
-        const source = getTemplateSource(options);
+        const source = yield getTemplateSource(options);
         yield clone(source, destination);
+        console.log((0, logger_1.success)('Done!'));
         try {
             validate(destination);
         }

package/lib/utils.js

@@ -63,9 +63,6 @@ function normalizeOptions(options) {
         fallbackOption = '--typescript';
         delete normalizedOptions.javascript;
     }
-    if (!normalizedOptions.javascript) {
-        normalizedOptions.typescript = true;
-    }
     if (currentMutuallyExclusiveOptions.length > 1) {
         (0, logger_1.warn)(`Options ${(0, logger_1.highlight)('--source')}, ${(0, logger_1.highlight)('--example')}, ${(0, logger_1.highlight)('--typescript')} and ${(0, logger_1.highlight)('--javascript')} are mutually exclusive, using ${(0, logger_1.choice)(fallbackOption)}.`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "1.3.78",
+  "version": "1.4.0",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -35,11 +35,12 @@
     "build": "tsc"
   },
   "dependencies": {
-    "@contentful/app-scripts": "1.5.4",
+    "@contentful/app-scripts": "1.5.5",
     "chalk": "4.1.2",
     "commander": "9.4.1",
     "degit": "2.8.4",
     "inquirer": "8.2.5",
+    "node-fetch": "2.6.7",
     "rimraf": "3.0.2",
     "tildify": "2.0.0",
     "validate-npm-package-name": "5.0.0"
@@ -60,9 +61,10 @@
     "@types/degit": "2.8.3",
     "@types/inquirer": "8.2.1",
     "@types/node": "14.18.35",
+    "@types/node-fetch": "^2.6.2",
     "@types/rimraf": "3.0.2",
     "@types/tildify": "2.0.2",
     "@types/validate-npm-package-name": "4.0.0"
   },
-  "gitHead": "0364960b2f111e50bb266a50f2b241d0fee13171"
+  "gitHead": "00e9dff6579274c1cb492e329161cc7bac8445e0"
 }