@contentful/create-contentful-app 2.1.13 → 2.2.0

package/README.md

@@ -30,6 +30,9 @@ npx create-contentful-app <app-name>
 # npm
 npm init contentful-app <app-name>
 
+# pnpm
+pnpm init contentful-app <app-name>
+
 # Yarn
 yarn create contentful-app <app-name>
 ```
@@ -38,11 +41,9 @@ yarn create contentful-app <app-name>
 
 ### Package Manager
 
-`--npm` or `--yarn`
-
-Use npm or Yarn to manage dependencies. If omitted, defaults to the manager used to run `create-contentful-app`.
+`--npm` or `--pnpm` or `--yarn`
 
-Both flags are mutually exclusive.
+Use npm, pnpm, or Yarn to manage dependencies. If omitted, or if more than one flag is passed, will default to the manager used to run `create-contentful-app`.
 
 ### Template
 

package/lib/getTemplateSource.js

@@ -49,8 +49,7 @@ async function promptExampleSelection() {
         // get available templates from examples
         const availableTemplates = await (0, getGithubFolderNames_1.getGithubFolderNames)();
         // filter out the ignored ones that are listed as templates instead of examples
-        const filteredTemplates = availableTemplates
-            .filter((template) => !constants_1.IGNORED_EXAMPLE_FOLDERS.includes(template));
+        const filteredTemplates = availableTemplates.filter((template) => !constants_1.IGNORED_EXAMPLE_FOLDERS.includes(template));
         console.log(availableTemplates.length, filteredTemplates.length);
         // ask user to select a template from the available examples
         const { example } = await inquirer_1.default.prompt([

package/lib/index.js

@@ -21,14 +21,24 @@ 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) {
+function successMessage(folder, packageManager) {
+    let command = '';
+    if (packageManager === 'yarn') {
+        command = 'yarn create-app-definition';
+    }
+    else if (packageManager === 'pnpm') {
+        command = 'pnpm create-app-definition';
+    }
+    else {
+        command = 'npm run create-app-definition';
+    }
     console.log(`
 ${(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 create an app definition for your app by running
 
     ${(0, logger_1.code)(`cd ${(0, tildify_1.default)(folder)}`)}
-    ${(0, logger_1.code)(useYarn ? 'yarn create-app-definition' : 'npm run create-app-definition')}
+    ${(0, logger_1.code)(command)}
 
     or you can create it manually in web app:
     ${(0, logger_1.highlight)(constants_1.CREATE_APP_DEFINITION_GUIDE_URL)}
@@ -36,7 +46,7 @@ ${(0, logger_1.success)('Success!')} Created a new Contentful app in ${(0, logge
     console.log(`Then kick it off by running
 
     ${(0, logger_1.code)(`cd ${(0, tildify_1.default)(folder)}`)}
-    ${(0, logger_1.code)(`${useYarn ? 'yarn' : 'npm'} start`)}
+    ${(0, logger_1.code)(`${packageManager} start`)}
   `);
 }
 function updatePackageName(appFolder) {
@@ -79,6 +89,8 @@ async function validateAppName(appName) {
 }
 async function initProject(appName, options) {
     const normalizedOptions = (0, utils_1.normalizeOptions)(options);
+    const activePackageManager = (0, utils_1.detectActivePackageManager)();
+    const packageManager = (0, utils_1.getNormalizedPackageManager)(normalizedOptions, activePackageManager);
     try {
         appName = await validateAppName(appName);
         const fullAppFolder = (0, path_1.resolve)(process.cwd(), appName);
@@ -90,15 +102,17 @@ async function initProject(appName, options) {
             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) {
+        (0, logger_1.wrapInBlanks)((0, logger_1.highlight)(`---- Installing the dependencies for your app (using ${chalk_1.default.cyan(packageManager)})...`));
+        if (packageManager === 'yarn') {
             await (0, utils_1.exec)('yarn', [], { cwd: fullAppFolder });
         }
+        else if (packageManager === 'pnpm') {
+            await (0, utils_1.exec)('pnpm', ['install'], { cwd: fullAppFolder });
+        }
         else {
             await (0, utils_1.exec)('npm', ['install', '--no-audit', '--no-fund'], { cwd: fullAppFolder });
         }
-        successMessage(fullAppFolder, useYarn);
+        successMessage(fullAppFolder, packageManager);
     }
     catch (err) {
         (0, logger_1.error)(`Failed to create ${(0, logger_1.highlight)(chalk_1.default.cyan(appName))}`, err);
@@ -113,7 +127,7 @@ async function initProject(appName, options) {
         const templateSource = await (0, getTemplateSource_1.getTemplateSource)(options);
         (0, analytics_1.track)({
             template: templateSource,
-            manager: normalizedOptions.npm ? 'npm' : 'yarn',
+            manager: packageManager,
             interactive: isInteractive,
         });
         await (0, template_1.cloneTemplateIn)(fullAppFolder, templateSource);
@@ -147,7 +161,7 @@ async function initProject(appName, options) {
             example: normalizedOptions.function,
             language: normalizedOptions.javascript ? 'javascript' : 'typescript',
             name: functionName,
-            keepPackageJson: normalizedOptions.skipUi === true
+            keepPackageJson: normalizedOptions.skipUi === true,
         });
     }
 }
@@ -168,6 +182,7 @@ async function initProject(appName, options) {
     ].join('\n'))
         .argument('[app-name]', 'app name')
         .option('--npm', 'use npm')
+        .option('--pnpm', 'use pnpm')
         .option('--yarn', 'use Yarn')
         .option('-ts, --typescript', 'use TypeScript template (default)')
         .option('-js, --javascript', 'use JavaScript template')

package/lib/template.js

@@ -62,6 +62,7 @@ function validate(destination) {
     }
 }
 function cleanUp(destination) {
+    (0, utils_1.rmIfExists)((0, path_1.resolve)(destination, 'pnpm-lock.json'));
     (0, utils_1.rmIfExists)((0, path_1.resolve)(destination, 'package-lock.json'));
     (0, utils_1.rmIfExists)((0, path_1.resolve)(destination, 'yarn.lock'));
 }

package/lib/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isContentfulTemplate = exports.normalizeOptions = exports.detectManager = exports.rmIfExists = exports.exec = void 0;
+exports.isContentfulTemplate = exports.normalizeOptions = exports.getNormalizedPackageManager = exports.detectActivePackageManager = exports.rmIfExists = exports.exec = void 0;
 const child_process_1 = require("child_process");
 const fs_1 = require("fs");
 const path_1 = require("path");
@@ -28,25 +28,75 @@ function rmIfExists(path) {
     }
 }
 exports.rmIfExists = rmIfExists;
-function detectManager() {
+function detectActivePackageManager() {
+    if ((0, fs_1.existsSync)('pnpm-lock.yaml'))
+        return 'pnpm';
+    if ((0, fs_1.existsSync)('yarn.lock'))
+        return 'yarn';
+    if ((0, fs_1.existsSync)('package-lock.json'))
+        return 'npm';
+    (0, logger_1.warn)('No lock files found, we will try to detect the active package manager from package.json.');
+    try {
+        const pkg = JSON.parse((0, fs_1.readFileSync)('package.json', 'utf8'));
+        if (pkg.packageManager?.startsWith('pnpm'))
+            return 'pnpm';
+        if (pkg.packageManager?.startsWith('yarn'))
+            return 'yarn';
+        if (pkg.packageManager?.startsWith('npm'))
+            return 'npm';
+    }
+    catch {
+        (0, logger_1.warn)(`Unable to determine active package manager from package.json. We will try to detect it from npm_execpath.`);
+    }
     switch ((0, path_1.basename)(process.env.npm_execpath || '')) {
         case 'yarn.js':
             return 'yarn';
+        case 'pnpm.cjs':
+            return 'pnpm';
         case 'npx-cli.js':
         case 'npm-cli.js':
         default:
             return 'npm';
     }
 }
-exports.detectManager = detectManager;
+exports.detectActivePackageManager = detectActivePackageManager;
+// By the time this function is called, the options have already been normalized
+// so we would not need to consider multiple package manager flags at once
+function getNormalizedPackageManager(options, activePackageManager) {
+    // Prefer to get the package manager from options
+    if (options.pnpm) {
+        return 'pnpm';
+    }
+    else if (options.yarn) {
+        return 'yarn';
+    }
+    else if (options.npm) {
+        return 'npm';
+    }
+    // Fallback to active package manager
+    return activePackageManager;
+}
+exports.getNormalizedPackageManager = getNormalizedPackageManager;
 function normalizeOptions(options) {
     const normalizedOptions = { ...options };
-    if (normalizedOptions.npm && normalizedOptions.yarn) {
-        (0, logger_1.warn)(`Provided both ${(0, logger_1.highlight)('--yarn')} and ${(0, logger_1.highlight)('--npm')} flags, using ${(0, logger_1.choice)('--npm')}.`);
-        delete normalizedOptions.yarn;
+    const selectedPackageManagers = [
+        ['npm', normalizedOptions.npm],
+        ['pnpm', normalizedOptions.pnpm],
+        ['yarn', normalizedOptions.yarn],
+    ].filter(([, n]) => n);
+    const activePackageManager = detectActivePackageManager();
+    if (selectedPackageManagers.length > 1) {
+        (0, logger_1.warn)(`Too many package manager flags were provided, we will use ${(0, logger_1.choice)(`--${activePackageManager}`)}.`);
+        // Delete all package manager options
+        selectedPackageManagers.forEach(([packageManager]) => {
+            delete normalizedOptions[packageManager];
+        });
+        // Select active package manager
+        normalizedOptions[activePackageManager] = true;
     }
-    if (!normalizedOptions.yarn) {
-        normalizedOptions.npm = true;
+    // No package manager flags were provided, use active package manager
+    if (selectedPackageManagers.length === 0) {
+        normalizedOptions[activePackageManager] = true;
     }
     let fallbackOption = '--typescript';
     const currentMutuallyExclusiveOptions = MUTUALLY_EXCLUSIVE_OPTIONS.filter((option) => normalizedOptions[option]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/create-contentful-app",
-  "version": "2.1.13",
+  "version": "2.2.0",
   "description": "A template for building Contentful Apps",
   "keywords": [
     "contentful",
@@ -46,7 +46,7 @@
     "rimraf": "5.0.8",
     "tiged": "^2.12.7",
     "tildify": "2.0.0",
-    "validate-npm-package-name": "6.0.1"
+    "validate-npm-package-name": "6.0.2"
   },
   "bugs": {
     "url": "https://github.com/contentful/create-contentful-app/issues"
@@ -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.52.2",
+    "contentful-management": "11.54.4",
     "mocha": "^11.2.2",
-    "sinon": "^20.0.0",
+    "sinon": "^21.0.0",
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.2"
   },
-  "gitHead": "e14fb27df06ed59ffb4e08972dde3f4bdacc1f50"
+  "gitHead": "4c69fe11610e734125777512ec1322e26f4e5456"
 }