@jungvonmatt/contentful-migrations 6.2.5 → 7.0.0

package/lib/migration.js

@@ -1,18 +1,22 @@
-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;
+const fs = require("fs-extra");
+const { format: oxfmt } = require("oxfmt");
+const path = require("path");
+const { stripIndent } = require("common-tags");
+const { runMigration } = require("contentful-migration");
 const {
   getContentTypes,
   generateMigrationScript,
-} = require('contentful-cli/dist/lib/cmds/space_cmds/generate_cmds/migration');
-const pc = require('picocolors');
-const { getEnvironment, getOrganizationId } = require('./contentful');
+} = require("contentful-cli/dist/lib/cmds/space_cmds/generate_cmds/migration");
+const pc = require("picocolors");
+const { getEnvironment, getOrganizationId } = require("./contentful");
 
-const { confirm, STATE_SUCCESS, STATE_FAILURE } = require('./config');
+const { confirm, STATE_SUCCESS, STATE_FAILURE } = require("./config");
 
-const { storeMigration, getNewMigrations } = require('./backend');
+const {
+  storeMigration,
+  getNewMigrations,
+  getVersionFromFile,
+} = require("./backend");
 
 const migrationHeader = stripIndent`/* eslint-env node */
   const { withHelpers } = require('@jungvonmatt/contentful-migrations');
@@ -33,42 +37,30 @@ const migrationHeader = stripIndent`/* eslint-env node */
 const createMigration = async (config) => {
   let module = false;
   try {
-    const { readPackageUp } = await import('read-pkg-up');
+    const { readPackageUp } = await import("read-package-up");
     const data = await readPackageUp();
-    module = data?.packageJson?.type === 'module';
+    module = data?.packageJson?.type === "module";
   } catch (err) {
     console.log(err);
   }
 
   const { directory } = config || {};
   const timestamp = Date.now();
-  const filename = path.join(directory, `${timestamp}-migration.${module ? 'cjs' : 'js'}`);
+  const filename = path.join(
+    directory,
+    `${timestamp}-migration.${module ? "cjs" : "js"}`,
+  );
   const content = stripIndent`${migrationHeader}
     // Add your migration code here
   })`;
 
-  await fs.outputFile(filename, await format(filename, content, config));
+  await fs.outputFile(filename, await format(filename, content));
   console.log(`Generated new migration file to ${pc.green(filename)}`);
 };
 
-const format = async (file, content, config) => {
-  try {
-    const prettierOptions = await prettier.resolveConfig(file, { editorconfig: true });
-    return prettier.format(content, {
-      parser: 'babel',
-      ...prettierOptions,
-    });
-  } catch (error) {
-    if (config?.verbose) {
-      console.log(pc.red('Error resolving prettier config. Using default settings.'));
-      console.log();
-      console.log(error);
-      console.log();
-    }
-    return prettier.format(content, {
-      parser: 'babel',
-    });
-  }
+const format = async (file, content) => {
+  const { code } = await oxfmt(file, content, { singleQuote: true });
+  return code;
 };
 
 /**
@@ -80,51 +72,56 @@ const fetchMigration = async (config) => {
   const client = await getEnvironment(config);
   let module = false;
   try {
-    const { readPackageUp } = await import('read-pkg-up');
+    const { readPackageUp } = await import("read-package-up");
     const data = await readPackageUp();
-    module = data?.packageJson?.type === 'module';
+    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 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.${module ? 'cjs' : 'js'}`);
+    const filename = path.join(
+      directory,
+      `${timestamp++}-create-${entry.sys.id}-migration.${module ? "cjs" : "js"}`,
+    );
 
     const content = await generateMigrationScript(client, [entry]);
     // Fetch migration script generated by contentful
     let modifiedContent = content.toString();
     // Modify migration script to use our helpers
-    const testDefaultValueRegex = /(defaultValue\({\s*)[^\:]+([^\)]+)/g;
+    const testDefaultValueRegex = /(defaultValue\({\s*)[^:]+([^)]+)/g;
     if (testDefaultValueRegex.test(modifiedContent)) {
       modifiedContent = content
         .toString()
         // Add call to utils.getDefaultLocale() to the top
         .replace(
-          'module.exports = function (migration) {',
+          "module.exports = function (migration) {",
           `
           ${migrationHeader}
           const defaultLocale = await helpers.locale.getDefaultLocale();
-        `
+        `,
         )
         // Replace the default locale with defaultLocale.code so that the migration
         // still works as expected when the locale is changed in contentful
-        .replace(testDefaultValueRegex, '$1[defaultLocale.code]$2')
+        .replace(testDefaultValueRegex, "$1[defaultLocale.code]$2")
         // Add a closing parentheses as we wrap the migration function.
-        .replace(/};\s*$/g, '});');
+        .replace(/};\s*$/g, "});");
     } else {
       // If we don't have a default value we just wrap the migration function with our withHelpers wrapper
       modifiedContent = content
         .toString()
-        .replace('module.exports = function (migration) {', migrationHeader)
-        .replace(/};\s*$/g, '});');
+        .replace("module.exports = function (migration) {", migrationHeader)
+        .replace(/};\s*$/g, "});");
     }
 
-    await fs.outputFile(filename, await format(filename, modifiedContent, config));
+    await fs.outputFile(filename, await format(filename, modifiedContent));
     console.log(`Generated new migration file to ${pc.green(filename)}`);
   });
 
@@ -143,7 +140,13 @@ const executeMigration = async (file, config) => {
   const environmentId = client.sys.id;
   const organizationId = await getOrganizationId(config);
   const name = path.basename(file);
-  const [, version] = /^(\d+)-/.exec(name);
+  const version = getVersionFromFile(file);
+  if (!version) {
+    console.error(
+      `Invalid migration file name "${name}". Must start with a timestamp.`,
+    );
+    process.exit(1);
+  }
 
   const options = {
     filePath: path.resolve(file),
@@ -159,7 +162,9 @@ const executeMigration = async (file, config) => {
     options.host = config.host;
   }
 
-  console.log(`\nRun migration ${pc.green(version)} in environment ${pc.green(environmentId)}`);
+  console.log(
+    `\nRun migration ${pc.green(version)} in environment ${pc.green(environmentId)}`,
+  );
   const proceed = await confirm(config);
   if (!proceed) {
     return;
@@ -168,8 +173,13 @@ const executeMigration = async (file, config) => {
     await runMigration(options);
     await storeMigration({ version, name, state: STATE_SUCCESS }, config);
   } catch (error) {
-    const message = (error.errors || [error]).map((error) => error.message).join('\n');
-    await storeMigration({ version, name, state: STATE_FAILURE, message }, config);
+    const message = (error.errors || [error])
+      .map((error) => error.message)
+      .join("\n");
+    await storeMigration(
+      { version, name, state: STATE_FAILURE, message },
+      config,
+    );
 
     throw error;
   }
@@ -193,8 +203,15 @@ const runMigrations = async (config) => {
     console.log(error.message);
     throw error;
   }
-  console.log(`Found ${pc.green(migrations.length)} unexecuted migrations in environment ${pc.green(environmentId)}`);
-
+  console.log(
+    `Found ${pc.green(migrations.length)} unexecuted migrations in environment ${pc.green(environmentId)}`,
+  );
+  if (config?.verbose) {
+    for (const migration of migrations) {
+      console.log(`  ${pc.green(migration)}`);
+    }
+    console.log();
+  }
   const proceed = migrations.length === 0 || (await confirm(config));
   if (!proceed) {
     return;
@@ -210,7 +227,7 @@ const runMigrations = async (config) => {
     }
   }
 
-  console.log(pc.green('\nAll done'), '🚀');
+  console.log(pc.green("\nAll done"), "🚀");
 };
 
 module.exports.fetchMigration = fetchMigration;

package/package.json

@@ -1,153 +1,90 @@
 {
   "name": "@jungvonmatt/contentful-migrations",
-  "version": "6.2.5",
+  "version": "7.0.0",
   "description": "Helper to handle migrations in contentful",
-  "main": "index.js",
-  "files": [
-    "index.d.ts",
-    "index.js",
-    "cli.js",
-    "lib"
+  "keywords": [
+    "content-type",
+    "contentful",
+    "migration"
   ],
-  "typings": "index.d.ts",
-  "bin": {
-    "contentful-migrations": "cli.js",
-    "migrations": "cli.js"
-  },
+  "license": "MIT",
+  "author": "Ben Zörb <benjamin.zoerb@jvm.de>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jungvonmatt/contentful-migrations.git"
   },
-  "author": "Ben Zörb <benjamin.zoerb@jvm.de>",
-  "license": "MIT",
-  "engines": {
-    "node": ">=18"
+  "bin": {
+    "contentful-migrations": "cli.js",
+    "migrations": "cli.js"
   },
-  "keywords": [
-    "contentful",
-    "migration",
-    "content-type"
+  "files": [
+    "index.d.ts",
+    "index.js",
+    "cli.js",
+    "lib",
+    "!lib/**/*.test.js"
   ],
+  "main": "index.js",
+  "typings": "index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
-    "@contentful/rich-text-plain-text-renderer": "^17.1.6",
-    "@jungvonmatt/contentful-config": "^4.0.3",
-    "array.prototype.flatmap": "^1.3.3",
+    "@contentful/rich-text-plain-text-renderer": "^17.2.1",
+    "@jungvonmatt/contentful-config": "^5.0.1",
     "ascii-tree": "^0.3.0",
     "cli-progress": "^3.12.0",
-    "commander": "^8.3.0",
+    "commander": "^14.0.3",
     "common-tags": "^1.8.2",
-    "contentful-cli": "^3.10.2",
-    "contentful-import": "^9.4.129",
-    "contentful-management": "^11.67.0",
-    "contentful-migration": "^4.31.5",
-    "deep-diff": "^1.0.2",
-    "diff": "^5.1.0",
+    "contentful-cli": "^4.0.1",
+    "contentful-import": "^10.0.5",
+    "contentful-management": "^12.5.0",
+    "contentful-migration": "^5.0.0",
+    "diff": "^9.0.0",
     "enquirer": "^2.4.1",
-    "fs-extra": "^10.1.0",
-    "globby": "^12.0.2",
+    "fs-extra": "^11.3.5",
     "markdown-table": "^3.0.4",
     "merge-options": "^3.0.4",
+    "microdiff": "^1.5.0",
     "mustache": "^4.2.0",
-    "node-fetch": "^3.3.2",
-    "node-object-hash": "^2.3.10",
-    "picocolors": "^1.0.0",
-    "pkg-up": "^4.0.0",
-    "prettier": "^2.7.1",
-    "read-pkg-up": "^9.1.0"
+    "node-object-hash": "^3.1.1",
+    "oxfmt": "^0.50.0",
+    "package-up": "^5.0.0",
+    "picocolors": "^1.1.1",
+    "read-package-up": "^12.0.0",
+    "tinyglobby": "^0.2.16"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "^7.28.5",
-    "eslint": "^8.20.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^7.0.4",
-    "jest": "^27.5.1",
-    "jest-sonar-reporter": "^2.0.0",
-    "lint-staged": "^12.1.2"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "prettier": {
-    "singleQuote": true,
-    "printWidth": 120
+    "@vitest/coverage-v8": "^4.1.6",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.0.5",
+    "oxlint": "^1.65.0",
+    "vitest": "^4.1.6"
   },
-  "eslintConfig": {
-    "ignorePatterns": [
-      "**/*.d.ts"
-    ],
-    "plugins": [
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": "error"
-    },
-    "extends": [
-      "prettier"
-    ],
-    "parser": "@babel/eslint-parser",
-    "parserOptions": {
-      "requireConfigFile": false,
-      "allowImportExportEverywhere": true,
-      "ecmaFeatures": {
-        "ecmaVersion": 2017,
-        "impliedStrict": true
-      }
-    },
-    "env": {
-      "node": true
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
     }
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": [
-      "prettier --write --ignore-path .gitignore",
-      "eslint --fix --ignore-path .gitignore"
-    ],
-    "*.md": [
-      "prettier --write"
+      "oxfmt",
+      "oxlint --fix"
     ]
   },
-  "jest": {
-    "testResultsProcessor": "jest-sonar-reporter",
-    "coverageDirectory": "<rootDir>/__coverage__/",
-    "collectCoverageFrom": [
-      "<rootDir>/lib/*/**"
-    ],
-    "roots": [
-      "<rootDir>/lib/"
-    ],
-    "moduleFileExtensions": [
-      "js"
-    ],
-    "testRegex": "/lib/.*\\.test.js$",
-    "moduleDirectories": [
-      "node_modules"
-    ],
-    "globals": {
-      "DEVELOPMENT": false
-    },
-    "reporters": [
-      "default"
-    ]
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
+  "engines": {
+    "node": ">=22"
   },
   "migrations": {
     "storage": "content",
     "migrationContentTypeId": "contentful-migrations",
     "directory": "migrations"
   },
-  "jestSonar": {
-    "reportPath": "__coverage__",
-    "reportFile": "test-report.xml",
-    "indent": 2
-  },
   "scripts": {
-    "test": "jest --coverage && pnpm run lint",
-    "lint": "eslint .  --ext .js,.ts,.tsx --ignore-path .gitignore",
-    "fix-lint": "pnpm run lint -- --fix"
+    "test": "vitest run --coverage && pnpm run lint",
+    "lint": "oxlint",
+    "fix-lint": "oxlint --fix",
+    "fmt": "oxfmt",
+    "fmt:check": "oxfmt --check"
   }
 }