@jungvonmatt/contentful-migrations 6.0.0 → 6.1.0

package/README.md

@@ -26,11 +26,41 @@ This initializes migrations and stores the config values in the `package.json` o
 
 #### Configuration files
 
-The default configuration file name is `.migrationsrc`. But since we use [cosmiconfig](https://github.com/davidtheclark/cosmiconfig#cosmiconfig) you can also use the other supported config file formats and name patterns like `migrationsrc.json` or `migrations.config.js`.
+We use [`@jungvonmatt/contentful-config`](https://github.com/jungvonmatt/contentful-ssg/tree/main/packages/contentful-config) (built on [`@jungvonmatt/config-loader`](https://github.com/jungvonmatt/config-loader) and [`c12`](https://github.com/unjs/c12)) which provides extensive configuration loading capabilities from multiple sources.
+
+**Supported configuration locations (in order of priority):**
+- Configuration overrides passed via command line arguments
+- User-specified config file (via `--config-file` option)
+- `migrations.config.{js,ts,mjs,cjs,mts,cts}`
+- `.config/migrations.{js,ts,mjs,cjs,mts,cts,json,jsonc,json5,yaml,yml,toml}`
+- `.migrationsrc.{js,ts,mjs,cjs,mts,cts,json,jsonc,json5,yaml,yml,toml}`
+- `.migrationsrc`
+- `package.json` (in a `migrations` property)
+- Environment variables (with `CONTENTFUL_MIGRATIONS_CONFIG_*` prefix)
+- `.env` files (`.env.{NODE_ENV}`, `.env`)
+- Default configuration
+
+**Extending configurations:**
+You can extend configurations from other files or remote sources using the `extends` property:
+```js
+// migrations.config.js
+export default {
+  extends: ['./base.config.js', 'github:user/repo'],
+  // your config...
+}
+```
 
-You can also use any config file path by adding the `-f <path/to/confg>` or `--config-file <path/to/config>` command line argument. The extensions `.json`, `.yaml`, `.yml`, `.js`, `.ts`, `.mjs`, or `.cjs` are supported.
+**Environment-specific configuration:**
+```js
+// migrations.config.js
+export default {
+  spaceId: 'default-space',
+  $development: { spaceId: 'dev-space' },
+  $production: { spaceId: 'prod-space' }
+}
+```
 
-By specifying the config file path you can use multiple config files for different environments or spaces in your project.
+You can specify any config file path using the `--config-file <path/to/config>` command line argument. Multiple config files can be used for different environments or spaces in your project.
 
 #### Configuration values
 

package/cli.js

@@ -66,15 +66,21 @@ program
   .description('Initialize contentful-migrations')
   .action(
     actionRunner(async (cmd) => {
-      const config = await getConfig(parseArgs(cmd || {}), [
-        'managementToken',
-        'spaceId',
-        'environmentId',
-        'storage',
-        'fieldId',
-        'migrationContentTypeId',
-        'directory',
-      ]);
+      const config = await getConfig(
+        parseArgs(cmd || {}),
+        [],
+        [
+          'managementToken',
+          'host',
+          'organizationId',
+          'spaceId',
+          'environmentId',
+          'storage',
+          'fieldId',
+          'migrationContentTypeId',
+          'directory',
+        ]
+      );
 
       const { managementToken, accessToken, environmentId, spaceId, ...rest } = config;
 

package/lib/config.js

@@ -13,13 +13,14 @@ const STATE_FAILURE = 'failure';
  * Get configuration
  * @param {Object} args
  */
-const getConfig = async (args, required = []) => {
+const getConfig = async (args, required = [], prompt = []) => {
   const { configFile, cwd, ...overrides } = args;
   const { loadContentfulConfig } = await import('@jungvonmatt/contentful-config');
   const result = await loadContentfulConfig('migrations', {
     configFile,
     cwd,
     overrides,
+    prompt,
     defaultConfig: {
       fieldId: 'migration',
       migrationContentTypeId: 'contentful-migrations',
@@ -61,11 +62,13 @@ const getPromts = (data) => {
       message: 'How should the migrations be managed',
       choices: [
         {
-          name: 'Content-model (recommended)',
+          message: 'Content-model (recommended)',
+          name: STORAGE_CONTENT,
           value: STORAGE_CONTENT,
         },
         {
-          name: 'Tag',
+          message: 'Tag',
+          name: STORAGE_TAG,
           value: STORAGE_TAG,
         },
       ],
@@ -75,7 +78,8 @@ const getPromts = (data) => {
       type: 'input',
       name: 'fieldId',
       message: 'Id of the tag where the the migration version is stored',
-      skip(answers) {
+      skip() {
+        const answers = this?.enquirer?.answers;
         return answers.storage === STORAGE_CONTENT;
       },
       initial: data.fieldId,
@@ -84,7 +88,8 @@ const getPromts = (data) => {
       type: 'input',
       name: 'migrationContentTypeId',
       message: 'Id of the content-type where the the migrations are stored',
-      skip(answers) {
+      skip() {
+        const answers = this?.enquirer?.answers;
         return answers.storage === STORAGE_TAG;
       },
       initial: data.migrationContentTypeId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jungvonmatt/contentful-migrations",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "Helper to handle migrations in contentful",
   "main": "index.js",
   "files": [
@@ -35,7 +35,7 @@
   ],
   "dependencies": {
     "@contentful/rich-text-plain-text-renderer": "^15.12.1",
-    "@jungvonmatt/contentful-config": "^3.0.1",
+    "@jungvonmatt/contentful-config": "^3.0.3",
     "array.prototype.flatmap": "^1.3.3",
     "ascii-tree": "^0.3.0",
     "cli-progress": "^3.11.2",
@@ -45,7 +45,6 @@
     "contentful-import": "^9.4.91",
     "contentful-management": "^11.48.0",
     "contentful-migration": "^4.28.1",
-    "cosmiconfig": "^8.0.0",
     "deep-diff": "^1.0.2",
     "diff": "^5.1.0",
     "dotenv": "^10.0.0",