@jungvonmatt/contentful-migrations 6.2.5 → 7.0.0

package/cli.js

@@ -2,19 +2,37 @@
 
 /* eslint-disable no-console */
 /* eslint-env node */
-const fs = require('fs-extra');
-const path = require('path');
-const pc = require('picocolors');
-const { Command } = require('commander');
+const fs = require("fs-extra");
+const path = require("path");
+const pc = require("picocolors");
+const { Command } = require("commander");
 
-const { initializeContentModel, migrateToContentStorage, migrateToTagStorage } = require('./lib/backend');
-const { createMigration, runMigrations, fetchMigration, executeMigration } = require('./lib/migration');
-const { versionDelete, versionAdd } = require('./lib/version');
-const { transferContent } = require('./lib/content');
-const { createOfflineDocs } = require('./lib/doc');
-const { createEnvironment, removeEnvironment, resetEnvironment } = require('./lib/environment');
-const { getConfig, confirm, STORAGE_CONTENT, STORAGE_TAG } = require('./lib/config');
-const pkg = require('./package.json');
+const {
+  initializeContentModel,
+  migrateToContentStorage,
+  migrateToTagStorage,
+} = require("./lib/backend");
+const {
+  createMigration,
+  runMigrations,
+  fetchMigration,
+  executeMigration,
+} = require("./lib/migration");
+const { versionDelete, versionAdd } = require("./lib/version");
+const { transferContent } = require("./lib/content");
+const { createOfflineDocs } = require("./lib/doc");
+const {
+  createEnvironment,
+  removeEnvironment,
+  resetEnvironment,
+} = require("./lib/environment");
+const {
+  getConfig,
+  confirm,
+  STORAGE_CONTENT,
+  STORAGE_TAG,
+} = require("./lib/config");
+const pkg = require("./package.json");
 
 const parseArgs = (cmd) => {
   const { parent = {} } = cmd || {};
@@ -37,9 +55,9 @@ const parseArgs = (cmd) => {
 const errorHandler = (error, log) => {
   if (log) {
     const { errors, message } = error;
-    console.error(pc.red('\nError:'), message);
+    console.error(pc.red("\nError:"), message);
     (errors || []).forEach((err) => {
-      console.error(pc.red('Error:'), err.message);
+      console.error(pc.red("Error:"), err.message);
     });
   }
   process.exit(1);
@@ -56,28 +74,31 @@ const program = new Command();
 
 program.version(pkg.version);
 program
-  .command('init')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
-  .description('Initialize contentful-migrations')
+  .command("init")
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
+  .description("Initialize contentful-migrations")
   .action(
     actionRunner(async (cmd) => {
       const config = await getConfig(
         parseArgs(cmd || {}),
         [],
         [
-          'managementToken',
-          'host',
-          'organizationId',
-          'spaceId',
-          'environmentId',
-          'storage',
-          'fieldId',
-          'migrationContentTypeId',
-          'directory',
-        ]
+          "managementToken",
+          "host",
+          "organizationId",
+          "spaceId",
+          "environmentId",
+          "storage",
+          "fieldId",
+          "migrationContentTypeId",
+          "directory",
+        ],
       );
 
       if (config.storage === STORAGE_CONTENT) {
@@ -88,12 +109,22 @@ program
         await migrateToTagStorage(config);
       }
 
-      const storeConfig = await confirm({ message: 'Do you want to store the configuration?' });
+      const storeConfig = await confirm({
+        message: "Do you want to store the configuration?",
+      });
 
       if (storeConfig) {
         // only store relevant config values without management token
         // management token should not be stored inside the project
-        const { host, spaceId, environmentId, storage, fieldId, migrationContentTypeId, directory } = config;
+        const {
+          host,
+          spaceId,
+          environmentId,
+          storage,
+          fieldId,
+          migrationContentTypeId,
+          directory,
+        } = config;
 
         const data = {
           host,
@@ -101,200 +132,275 @@ program
           environmentId,
           directory,
           storage,
-          ...(storage === STORAGE_CONTENT ? { migrationContentTypeId } : { fieldId }),
+          ...(storage === STORAGE_CONTENT
+            ? { migrationContentTypeId }
+            : { fieldId }),
         };
 
         // try to store in package.json
-        const { pkgUp } = await import('pkg-up');
-        const localPkg = await pkgUp();
+        const { packageUp } = await import("package-up");
+        const localPkg = await packageUp();
         if (localPkg) {
           const packageJson = await fs.readJson(localPkg);
-          data.directory = path.relative(path.dirname(localPkg), data.directory);
+          data.directory = path.relative(
+            path.dirname(localPkg),
+            data.directory,
+          );
           packageJson.migrations = data;
           await fs.outputJson(localPkg, packageJson, { spaces: 2 });
         } else {
           // store in .migrationsrc if no package.json is available
           const cwd = cmd.cwd ? path.resolve(cmd.cwd) : process.cwd();
           data.directory = path.relative(cwd, data.directory);
-          await fs.outputJson(path.join(cwd, '.migrationsrc.json'), data, { spaces: 2 });
+          await fs.outputJson(path.join(cwd, ".migrationsrc.json"), data, {
+            spaces: 2,
+          });
         }
       }
-    })
+    }),
   );
 
 program
-  .command('fetch')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-c, --content-type <content-type...>', 'Specify content-types')
-  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are saved')
-  .option('-v, --verbose', 'Verbosity')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
-  .description('Generate a new Contentful migration from content type')
+  .command("fetch")
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option(
+    "-e, --environment-id <environment-id>",
+    "Change the Contentful environment",
+  )
+  .option("-c, --content-type <content-type...>", "Specify content-types")
+  .option(
+    "-p, --path <path/to/migrations>",
+    "Change the path where the migrations are saved",
+  )
+  .option("-v, --verbose", "Verbosity")
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
+  .description("Generate a new Contentful migration from content type")
   .action(
     actionRunner(async (cmd) => {
       const config = await getConfig(parseArgs(cmd || {}), [
-        'managementToken',
-        'spaceId',
-        'environmentId',
-        'directory',
+        "managementToken",
+        "spaceId",
+        "environmentId",
+        "directory",
       ]);
 
       await fetchMigration({ ...config, contentType: cmd.contentType });
-    })
+    }),
   );
 
 program
-  .command('generate')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are saved')
-  .option('-v, --verbose', 'Verbosity')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
-  .description('Generate a new Contentful migration')
+  .command("generate")
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option(
+    "-e, --environment-id <environment-id>",
+    "Change the Contentful environment",
+  )
+  .option(
+    "-p, --path <path/to/migrations>",
+    "Change the path where the migrations are saved",
+  )
+  .option("-v, --verbose", "Verbosity")
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
+  .description("Generate a new Contentful migration")
   .action(
     actionRunner(async (cmd) => {
       const config = await getConfig(parseArgs(cmd || {}), [
-        'managementToken',
-        'spaceId',
-        'environmentId',
-        'directory',
+        "managementToken",
+        "spaceId",
+        "environmentId",
+        "directory",
       ]);
       await createMigration(config);
-    })
+    }),
   );
 
 program
-  .command('migrate')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are stored')
-  .option('-v, --verbose', 'Verbosity')
-  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
-  .option('--bail', 'Abort execution after first failed migration (default: true)', true)
-  .option('--no-bail', 'Ignore failed migrations')
-  .description('Execute all unexecuted migrations available.')
+  .command("migrate")
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option(
+    "-e, --environment-id <environment-id>",
+    "Change the Contentful environment",
+  )
+  .option(
+    "-p, --path <path/to/migrations>",
+    "Change the path where the migrations are stored",
+  )
+  .option("-v, --verbose", "Verbosity")
+  .option(
+    "-y, --yes",
+    'Assume "yes" as answer to all prompts and run non-interactively.',
+  )
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
+  .option(
+    "--bail",
+    "Abort execution after first failed migration (default: true)",
+    true,
+  )
+  .option("--no-bail", "Ignore failed migrations")
+  .description("Execute all unexecuted migrations available.")
   .action(
     actionRunner(async (cmd) => {
       const config = await getConfig(parseArgs(cmd || {}), [
-        'managementToken',
-        'spaceId',
-        'environmentId',
-        'storage',
-        'fieldId',
-        'migrationContentTypeId',
-        'directory',
+        "managementToken",
+        "spaceId",
+        "environmentId",
+        "storage",
+        "fieldId",
+        "migrationContentTypeId",
+        "directory",
       ]);
 
       const { missingStorageModel } = config;
       if (missingStorageModel) {
-        console.error(pc.red('\nError:'), `Missing migration content type. Run ${pc.cyan('npx migrations init')}`);
+        console.error(
+          pc.red("\nError:"),
+          `Missing migration content type. Run ${pc.cyan("npx migrations init")}`,
+        );
         process.exit(1);
       }
 
       await runMigrations(config);
-    }, false)
+    }, false),
   );
 
 program
-  .command('execute <file>')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-v, --verbose', 'Verbosity')
-  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
-  .description('Execute a single migration.')
+  .command("execute <file>")
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option(
+    "-e, --environment-id <environment-id>",
+    "Change the Contentful environment",
+  )
+  .option("-v, --verbose", "Verbosity")
+  .option(
+    "-y, --yes",
+    'Assume "yes" as answer to all prompts and run non-interactively.',
+  )
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
+  .description("Execute a single migration.")
   .action(
     actionRunner(async (file, options) => {
       const config = await getConfig(parseArgs(options || {}), [
-        'managementToken',
-        'spaceId',
-        'environmentId',
-        'storage',
-        'fieldId',
-        'migrationContentTypeId',
-        'directory',
+        "managementToken",
+        "spaceId",
+        "environmentId",
+        "storage",
+        "fieldId",
+        "migrationContentTypeId",
+        "directory",
       ]);
 
       const { missingStorageModel } = config;
       if (missingStorageModel) {
-        console.error(pc.red('\nError:'), `Missing migration content type. Run ${pc.cyan('npx migrations init')}`);
+        console.error(
+          pc.red("\nError:"),
+          `Missing migration content type. Run ${pc.cyan("npx migrations init")}`,
+        );
         process.exit(1);
       }
       await executeMigration(path.resolve(file), config);
-    }, false)
+    }, false),
   );
 
 program
-  .command('version <file>')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-v, --verbose', 'Verbosity')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--add', 'Mark migration as migrated')
-  .option('--remove', 'Delete migration entry in Contentful')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
-  .description('Manually mark a migration as migrated or not. (Only available with the Content-model storage)')
+  .command("version <file>")
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option(
+    "-e, --environment-id <environment-id>",
+    "Change the Contentful environment",
+  )
+  .option("-v, --verbose", "Verbosity")
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option("--add", "Mark migration as migrated")
+  .option("--remove", "Delete migration entry in Contentful")
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
+  .description(
+    "Manually mark a migration as migrated or not. (Only available with the Content-model storage)",
+  )
   .action(
     actionRunner(async (file, options) => {
       const { remove, add } = options;
       const config = await getConfig(parseArgs(options || {}), [
-        'managementToken',
-        'spaceId',
-        'environmentId',
-        'storage',
-        'fieldId',
-        'migrationContentTypeId',
-        'directory',
+        "managementToken",
+        "spaceId",
+        "environmentId",
+        "storage",
+        "fieldId",
+        "migrationContentTypeId",
+        "directory",
       ]);
 
       const { missingStorageModel } = config;
       if (missingStorageModel) {
-        console.error(pc.red('\nError:'), `Missing migration content type. Run ${pc.cyan('npx migrations init')}`);
+        console.error(
+          pc.red("\nError:"),
+          `Missing migration content type. Run ${pc.cyan("npx migrations init")}`,
+        );
         process.exit(1);
       }
 
       const { storage } = config || {};
       if (storage === STORAGE_TAG) {
-        throw new Error('The version command is not available for the "tag" storage');
+        throw new Error(
+          'The version command is not available for the "tag" storage',
+        );
       }
       if (remove) {
         await versionDelete(file, config);
       } else if (add) {
         await versionAdd(file, config);
       }
-    }, true)
+    }, true),
   );
 
 program
-  .command('environment <environment-id>')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-v, --verbose', 'Verbosity')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--create', 'Create new contentful environment')
-  .option('--remove', 'Delete contentful environment')
-  .option('--reset', 'Reset contentful environment')
-  .option('--source-environment-id <environment-id>', 'Set the source environment to clone new environment from')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
-  .description('Add or remove a contentful environment for migrations')
+  .command("environment <environment-id>")
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option("-v, --verbose", "Verbosity")
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option("--create", "Create new contentful environment")
+  .option("--remove", "Delete contentful environment")
+  .option("--reset", "Reset contentful environment")
+  .option(
+    "--source-environment-id <environment-id>",
+    "Set the source environment to clone new environment from",
+  )
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
+  .description("Add or remove a contentful environment for migrations")
   .action(
     actionRunner(async (environmentId, options) => {
       const { remove, create, reset } = options;
-      const config = await getConfig(parseArgs({ ...(options || {}), environmentId }), [
-        'managementToken',
-        'spaceId',
-        'environmentId',
+      const config = await getConfig(parseArgs({ ...options, environmentId }), [
+        "managementToken",
+        "spaceId",
+        "environmentId",
       ]);
 
       if (create) {
@@ -308,54 +414,91 @@ program
       if (reset) {
         return resetEnvironment(environmentId, config);
       }
-    }, true)
+    }, true),
   );
 
 program
-  .command('doc')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
-  .option('-p, --path <path/to/docs>', 'Change the path where the docs are stored')
-  .option('-v, --verbose', 'Verbosity')
-  .option('-t, --template <path/to/template>', 'Use custom template for docs')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--extension <file-extension>', 'Use custom file extension (default is `md`)')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
-  .description('Generate offline docs from content-types')
+  .command("doc")
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option(
+    "-e, --environment-id <environment-id>",
+    "Change the Contentful environment",
+  )
+  .option(
+    "-p, --path <path/to/docs>",
+    "Change the path where the docs are stored",
+  )
+  .option("-v, --verbose", "Verbosity")
+  .option("-t, --template <path/to/template>", "Use custom template for docs")
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option(
+    "--extension <file-extension>",
+    "Use custom file extension (default is `md`)",
+  )
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
+  .description("Generate offline docs from content-types")
   .action(
     actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}), ['managementToken', 'spaceId', 'environmentId']);
+      const config = await getConfig(parseArgs(cmd || {}), [
+        "managementToken",
+        "spaceId",
+        "environmentId",
+      ]);
       await createOfflineDocs(config);
-    }, true)
+    }, true),
   );
 
 program
-  .command('content')
-  .requiredOption('--source-environment-id <environment-id>', 'Set the Contentful source environment (from)')
-  .requiredOption('--dest-environment-id <environment-id>', 'Set the Contentful destination environment (to)')
-  .option('-s, --space-id <space-id>', 'Contentful space id')
-  .option('-c, --content-type <content-type>', 'Specify content-type')
-  .option('-v, --verbose', 'Verbosity')
-  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
-  .option('--host <host>', 'Management API host')
-  .option('--config <path/to/config>', 'Config file path (disables auto detect)')
-  .option('--diff', 'Manually choose skip/overwrite for every conflict')
-  .option('--force', 'No manual diffing. Overwrites all conflicting entries/assets')
-  .description('Transfer content from source environment to destination environment')
-  .option('--cwd <directory>', 'Working directory. Defaults to process.cwd()')
+  .command("content")
+  .requiredOption(
+    "--source-environment-id <environment-id>",
+    "Set the Contentful source environment (from)",
+  )
+  .requiredOption(
+    "--dest-environment-id <environment-id>",
+    "Set the Contentful destination environment (to)",
+  )
+  .option("-s, --space-id <space-id>", "Contentful space id")
+  .option("-c, --content-type <content-type>", "Specify content-type")
+  .option("-v, --verbose", "Verbosity")
+  .option(
+    "-y, --yes",
+    'Assume "yes" as answer to all prompts and run non-interactively.',
+  )
+  .option("--host <host>", "Management API host")
+  .option(
+    "--config <path/to/config>",
+    "Config file path (disables auto detect)",
+  )
+  .option("--diff", "Manually choose skip/overwrite for every conflict")
+  .option(
+    "--force",
+    "No manual diffing. Overwrites all conflicting entries/assets",
+  )
+  .description(
+    "Transfer content from source environment to destination environment",
+  )
+  .option("--cwd <directory>", "Working directory. Defaults to process.cwd()")
   .action(
     actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}), ['managementToken', 'spaceId', 'storage']);
+      const config = await getConfig(parseArgs(cmd || {}), [
+        "managementToken",
+        "spaceId",
+        "storage",
+      ]);
 
       // run migrations on destination environment
       await transferContent({
         ...config,
-        contentType: cmd.contentType || '',
+        contentType: cmd.contentType || "",
         forceOverwrite: cmd.force || false,
         diffConflicts: cmd.diff || false,
       });
-    })
+    }),
   );
 
 program.parse(process.argv);