@jungvonmatt/contentful-migrations 5.0.0 → 5.1.1

package/index.js

@@ -4,7 +4,6 @@
 /* eslint-env node */
 const fs = require('fs-extra');
 const path = require('path');
-const pkgUp = require('pkg-up');
 const chalk = require('chalk');
 const { Command } = require('commander');
 
@@ -79,6 +78,8 @@ program
       }
 
       // try to store in package.json
+
+      const {pkgUp} = await import('pkg-up');
       const localPkg = await pkgUp();
       if (localPkg) {
         const packageJson = await fs.readJson(localPkg);
@@ -224,7 +225,7 @@ program
     actionRunner(async (environmentId, options) => {
       const { remove, create, reset } = options;
       const config = await getConfig(parseArgs({ ...(options || {}), environmentId }));
-      const verified = await askMissingaskMissing(config, ['accessToken', 'spaceId', 'environmentId']);
+      const verified = await askMissing(config, ['accessToken', 'spaceId', 'environmentId']);
 
       if (create) {
         return createEnvironment(environmentId, verified);

package/lib/backend.js

@@ -1,5 +1,4 @@
 const path = require('path');
-const globby = require('globby');
 const chalk = require('chalk');
 const cliProgress = require('cli-progress');
 const { getEnvironment, getDefaultLocale } = require('./contentful');
@@ -192,7 +191,9 @@ const migrateToContentStorage = async (config) => {
 
   const client = await getEnvironment(config);
   const version = await getMigrationVersionFromTag(config);
-  const migrations = await globby(`${directory}/*.js`);
+
+  const {globby} = await import('globby');
+  const migrations = await globby([`${directory}/*.js`,`${directory}/*.cjs`]);
   const environmentId = client.sys.id;
   const filtered = migrations.filter((file) => {
     const name = path.basename(file);
@@ -351,25 +352,45 @@ const getLatestVersion = async (config) => {
   return getMigrationVersionFromTag(config);
 };
 
+const getVersionFromFile = file => {
+  const name = path.basename(file);
+  const [, num] = /^(\d+)-/.exec(name);
+  return parseInt(num,10);
+}
+
 /**
  * Get all unexecuted migration files
  * @param {Object} config The config object including all required data
  */
 const getNewMigrations = async (config) => {
-  const { directory, storage } = config || {};
-  const migrations = await globby(`${directory}/*.js`);
+  const { directory, storage, migrationContentTypeId } = config || {};
+  const {globby} = await import('globby');
+  const migrations = (await globby([`${directory}/*.js`,`${directory}/*.cjs`])).sort((a,b) => {
+    const numA = getVersionFromFile(a);
+    const numB = getVersionFromFile(b);
+    return numA-numB;
+  });
 
   if (storage === STORAGE_CONTENT) {
     try {
       const versions = await getMigrationVersions(config);
 
-      return migrations.filter((file) => {
-        const name = path.basename(file);
-        const [, num] = /^(\d+)-/.exec(name);
-
-        return !(versions || []).includes(parseInt(num, 10));
+      const result = migrations.filter((file) => {
+        const num = getVersionFromFile(file);
+        return !(versions || []).includes(num);
       });
+
+      return result;
     } catch (error) {
+      // check if we have a migration scheduled which adds the initial content-type
+      const regexp = new RegExp(`createContentType\\(['"]${migrationContentTypeId}['"]\\)`,'mg');
+      const initial = (await Promise.all(migrations.map(async file => {
+        return fs.readFile(file, 'utf8');
+      }))).some(content => regexp.test(content));
+
+      if (initial) {
+        return migrations;
+      }
       console.error(chalk.red('\nError:'), `Missing migration content type. Run ${chalk.cyan('npx migrations init')}`);
       process.exit(1);
     }

package/lib/config.js

@@ -188,7 +188,7 @@ const confirm = async (config = {}) => {
   if (config.yes) {
     return true;
   }
-  const { proceed } = await inquirer.prompt([
+  const { check } = await inquirer.prompt([
     {
       type: 'confirm',
       name: 'check',
@@ -197,7 +197,7 @@ const confirm = async (config = {}) => {
     },
   ]);
 
-  return proceed;
+  return check;
 };
 
 module.exports.getConfig = getConfig;

package/lib/doc.js

@@ -1,11 +1,11 @@
 const path = require('path');
-const table = require('markdown-table');
 const chalk = require('chalk');
 const fs = require('fs-extra');
 const Mustache = require('mustache');
 const { getEditorInterfaces, getContentTypes, getContentTypeId, getContentId } = require('./contentful');
 
-const getFieldTable = (fields, editorInterfaces) => {
+const getFieldTable = async (fields, editorInterfaces) => {
+  const { markdownTable: table } = await import('markdown-table');
   const { controls = [] } = editorInterfaces;
   return table([
     ['Id', 'Name', 'Type', 'Required', 'Localized', 'HelpText', 'Remarks'],
@@ -27,7 +27,8 @@ const getFieldTable = (fields, editorInterfaces) => {
   ]);
 };
 
-const createDoc = (contentType, editorInterfaces) => {
+const createDoc = async (contentType, editorInterfaces) => {
+  const { markdownTable: table } = await import('markdown-table');
   const { name, displayField, description, sys, fields } = contentType || {};
   const { id } = sys || {};
 
@@ -50,7 +51,7 @@ ${description}
 
 ## Fields
 
-${getFieldTable(fields, editorInterfaces)}
+${await getFieldTable(fields, editorInterfaces)}
 `;
 };
 
@@ -68,7 +69,7 @@ const prepareData = (contentType, editorInterfaces) => {
 };
 
 const getCustomRenderer = async (template) => {
-  if (template && template.endsWith('.js')) {
+  if (template && (template.endsWith('.js') || template.endsWith('.cjs'))) {
     const module = await import(path.resolve(template));
     return (data) => module.default(data);
   } else if (template && template.endsWith('.mustache')) {
@@ -98,7 +99,7 @@ const createOfflineDocs = async (config) => {
       const data = prepareData(contentType, interfaces);
       content = await customRender(data);
     } else {
-      content = createDoc(contentType, interfaces);
+      content = await createDoc(contentType, interfaces);
     }
 
     const filename = `${getContentId(contentType)}.${extension}`;

package/lib/migration.js

@@ -1,4 +1,5 @@
 const fs = require('fs-extra');
+const prettier = require('prettier');
 const path = require('path');
 const { stripIndent } = require('common-tags');
 const runMigration = require('contentful-migration/built/bin/cli').runMigration;
@@ -19,9 +20,18 @@ const { storeMigration, getNewMigrations } = require('./backend');
  * @param {Object} config The config object including all required data
  */
 const createMigration = async (config) => {
+  let module = false;
+  try {
+    const { readPackageUp } = await import('read-pkg-up');
+    const data = await readPackageUp();
+    module = data?.packageJson?.type === 'module';
+  } catch (err) {
+    console.log(err);
+  }
+
   const { directory } = config || {};
   const timestamp = Date.now();
-  const filename = path.join(directory, `${timestamp}-migration.js`);
+  const filename = path.join(directory, `${timestamp}-migration.${module ? 'cjs' : 'js'}`);
   const content = stripIndent`
   /* eslint-env node */
 
@@ -33,10 +43,18 @@ const createMigration = async (config) => {
     // See: https://github.com/contentful/contentful-migration
   }`;
 
-  await fs.outputFile(filename, content);
+  await fs.outputFile(filename, await format(filename, content));
   console.log(`Generated new migration file to ${chalk.green(filename)}`);
 };
 
+const format = async (file, content) => {
+  const prettierOptions = await prettier.resolveConfig(file, { editorconfig: true });
+  return prettier.format(content, {
+    parser: 'babel',
+    ...prettierOptions,
+  });
+};
+
 /**
  * Fetch migration from contentful
  * @param {Object} config The config object including all required data
@@ -44,15 +62,26 @@ const createMigration = async (config) => {
 const fetchMigration = async (config) => {
   const { contentType, directory } = config || {};
   const client = await getEnvironment(config);
+  let module = false;
+  try {
+    const { readPackageUp } = await import('read-pkg-up');
+    const data = await readPackageUp();
+    module = data?.packageJson?.type === 'module';
+  } catch (err) {
+    console.log(err);
+  }
+
   let timestamp = Date.now();
   const contentTypes = contentType
     ? (await Promise.all(contentType.map((ct) => getContentTypes(client, ct)))).flat()
     : await getContentTypes(client);
 
   const promises = contentTypes.map(async (entry) => {
-    const filename = path.join(directory, `${timestamp++}-create-${entry.sys.id}-migration.js`);
+    const filename = path.join(directory, `${timestamp++}-create-${entry.sys.id}-migration.${module ? 'cjs' : 'js'}`);
+
     const content = await generateMigrationScript(client, [entry]);
-    await fs.outputFile(filename, content);
+
+    await fs.outputFile(filename, await format(filename, content));
     console.log(`Generated new migration file to ${chalk.green(filename)}`);
   });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jungvonmatt/contentful-migrations",
-  "version": "5.0.0",
+  "version": "5.1.1",
   "description": "Helper to handle migrations in contentful",
   "main": "index.js",
   "files": [
@@ -30,39 +30,40 @@
     "content-type"
   ],
   "dependencies": {
-    "@contentful/rich-text-plain-text-renderer": "^15.5.1",
+    "@contentful/rich-text-plain-text-renderer": "^15.6.2",
     "array.prototype.flatmap": "^1.2.5",
     "ascii-tree": "^0.3.0",
     "chalk": "^4.1.2",
     "cli-progress": "^3.9.1",
     "commander": "^8.3.0",
-    "common-tags": "^1.8.0",
+    "common-tags": "^1.8.2",
     "contentful-cli": "^1.8.23",
     "contentful-import": "^8.2.22",
-    "contentful-management": "^7.32.0",
+    "contentful-management": "^7.45.2",
     "contentful-migration": "^4.3.0",
     "cosmiconfig": "^7.0.1",
     "deep-diff": "^1.0.2",
     "diff": "^5.0.0",
     "dotenv": "^10.0.0",
     "fs-extra": "^10.0.0",
-    "globby": "^11.0.3",
+    "globby": "^12.0.2",
     "inquirer": "^8.2.0",
-    "markdown-table": "^2.0.0",
+    "markdown-table": "^3.0.1",
     "merge-options": "^3.0.4",
     "mustache": "^4.2.0",
-    "node-fetch": "^3.0.0",
+    "node-fetch": "^3.1.0",
     "node-object-hash": "^2.3.10",
-    "pkg-up": "^3.1.0"
+    "pkg-up": "^4.0.0",
+    "prettier": "^2.4.1",
+    "read-pkg-up": "^9.0.0"
   },
   "devDependencies": {
     "babel-eslint": "^10.1.0",
-    "eslint": "^8.1.0",
+    "eslint": "^8.3.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.4",
-    "lint-staged": "^11.2.6",
-    "prettier": "^2.4.1"
+    "lint-staged": "^12.1.2"
   },
   "publishConfig": {
     "access": "public"
@@ -108,7 +109,6 @@
     }
   },
   "migrations": {
-    "spaceId": "89na9aswdzfj",
     "storage": "content",
     "migrationContentTypeId": "contentful-migrations",
     "directory": "migrations"