@sanity/cli 5.1.1-next.5 → 6.0.0-alpha.3

package/dist/utils/migration/resolveMigrationScript.d.ts

@@ -0,0 +1,44 @@
+import { type Migration } from '@sanity/migrate';
+interface ResolvedMigrationScript {
+    /**
+     * Absolute path to the migration script
+     */
+    absolutePath: string;
+    /**
+     * Relative path from the working directory to the migration script
+     */
+    relativePath: string;
+    /**
+     * The migration module, if it could be resolved - otherwise `undefined`
+     */
+    mod?: {
+        default: Migration;
+        down?: unknown;
+        up?: unknown;
+    };
+}
+/**
+ * Resolves the potential paths to a migration script.
+ * Considers the following paths (where `<ext>` is 'mjs', 'js', 'ts' or 'cjs'):
+ *
+ * - `<migrationsDir>/<migrationName>.<ext>`
+ * - `<migrationsDir>/<migrationName>/index.<ext>`
+ *
+ * Note that all possible paths are returned, even if the files do not exist.
+ * Check the `mod` property to see if a module could actually be loaded.
+ *
+ * @param workDir - Working directory of the studio
+ * @param migrationName - The name of the migration directory to resolve
+ * @returns An array of potential migration scripts
+ * @internal
+ */
+export declare function resolveMigrationScript(workDir: string, migrationName: string): Promise<ResolvedMigrationScript[]>;
+/**
+ * Checks whether or not the passed resolved migration script is actually loadable (eg has a default export)
+ *
+ * @param script - The resolved migration script to check
+ * @returns `true` if the script is loadable, `false` otherwise
+ * @internal
+ */
+export declare function isLoadableMigrationScript(script: ResolvedMigrationScript): script is Required<ResolvedMigrationScript>;
+export {};

package/dist/utils/migration/resolveMigrationScript.js

@@ -0,0 +1,74 @@
+import path from 'node:path';
+import { fileExists } from '@sanity/cli-core';
+import { getTsconfig } from 'get-tsconfig';
+import { isPlainObject } from 'lodash-es';
+import { tsImport } from 'tsx/esm/api';
+import { MIGRATION_SCRIPT_EXTENSIONS, MIGRATIONS_DIRECTORY } from '../../util/migration/constants.js';
+/**
+ * Resolves the potential paths to a migration script.
+ * Considers the following paths (where `<ext>` is 'mjs', 'js', 'ts' or 'cjs'):
+ *
+ * - `<migrationsDir>/<migrationName>.<ext>`
+ * - `<migrationsDir>/<migrationName>/index.<ext>`
+ *
+ * Note that all possible paths are returned, even if the files do not exist.
+ * Check the `mod` property to see if a module could actually be loaded.
+ *
+ * @param workDir - Working directory of the studio
+ * @param migrationName - The name of the migration directory to resolve
+ * @returns An array of potential migration scripts
+ * @internal
+ */ export async function resolveMigrationScript(workDir, migrationName) {
+    const tsconfig = getTsconfig(workDir);
+    const locations = [
+        migrationName,
+        path.join(migrationName, 'index')
+    ];
+    const results = [];
+    for (const location of locations){
+        for (const ext of MIGRATION_SCRIPT_EXTENSIONS){
+            const relativePath = path.join(MIGRATIONS_DIRECTORY, `${location}.${ext}`);
+            const absolutePath = path.resolve(workDir, relativePath);
+            let mod;
+            // Check if the file exists before trying to import it
+            const exists = await fileExists(absolutePath);
+            if (!exists) {
+                continue;
+            }
+            try {
+                const imported = await tsImport(absolutePath, {
+                    parentURL: import.meta.url,
+                    tsconfig: tsconfig?.path
+                });
+                // Handle both ESM and CJS default exports
+                mod = imported;
+            } catch (err) {
+                // Ignore MODULE_NOT_FOUND errors, but throw others
+                if (err.code !== 'MODULE_NOT_FOUND' && err.code !== 'ERR_MODULE_NOT_FOUND') {
+                    throw new Error(`Error loading migration: ${err.message}`);
+                }
+            }
+            results.push({
+                absolutePath,
+                mod,
+                relativePath
+            });
+        }
+    }
+    return results;
+}
+/**
+ * Checks whether or not the passed resolved migration script is actually loadable (eg has a default export)
+ *
+ * @param script - The resolved migration script to check
+ * @returns `true` if the script is loadable, `false` otherwise
+ * @internal
+ */ export function isLoadableMigrationScript(script) {
+    if (script.mod === undefined || !isPlainObject(script.mod.default)) {
+        return false;
+    }
+    const mod = script.mod.default;
+    return typeof mod.title === 'string' && mod.migrate !== undefined;
+}
+
+//# sourceMappingURL=resolveMigrationScript.js.map

package/dist/utils/migration/resolveMigrationScript.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/migration/resolveMigrationScript.ts"],"sourcesContent":["import path from 'node:path'\n\nimport {fileExists} from '@sanity/cli-core'\nimport {type Migration} from '@sanity/migrate'\nimport {getTsconfig} from 'get-tsconfig'\nimport {isPlainObject} from 'lodash-es'\nimport {tsImport} from 'tsx/esm/api'\n\nimport {MIGRATION_SCRIPT_EXTENSIONS, MIGRATIONS_DIRECTORY} from '../../util/migration/constants.js'\n\ninterface ResolvedMigrationScript {\n  /**\n   * Absolute path to the migration script\n   */\n  absolutePath: string\n\n  /**\n   * Relative path from the working directory to the migration script\n   */\n  relativePath: string\n\n  /**\n   * The migration module, if it could be resolved - otherwise `undefined`\n   */\n  mod?: {default: Migration; down?: unknown; up?: unknown}\n}\n\n/**\n * Resolves the potential paths to a migration script.\n * Considers the following paths (where `<ext>` is 'mjs', 'js', 'ts' or 'cjs'):\n *\n * - `<migrationsDir>/<migrationName>.<ext>`\n * - `<migrationsDir>/<migrationName>/index.<ext>`\n *\n * Note that all possible paths are returned, even if the files do not exist.\n * Check the `mod` property to see if a module could actually be loaded.\n *\n * @param workDir - Working directory of the studio\n * @param migrationName - The name of the migration directory to resolve\n * @returns An array of potential migration scripts\n * @internal\n */\nexport async function resolveMigrationScript(\n  workDir: string,\n  migrationName: string,\n): Promise<ResolvedMigrationScript[]> {\n  const tsconfig = getTsconfig(workDir)\n  const locations = [migrationName, path.join(migrationName, 'index')]\n  const results: ResolvedMigrationScript[] = []\n\n  for (const location of locations) {\n    for (const ext of MIGRATION_SCRIPT_EXTENSIONS) {\n      const relativePath = path.join(MIGRATIONS_DIRECTORY, `${location}.${ext}`)\n      const absolutePath = path.resolve(workDir, relativePath)\n      let mod: {default: Migration; down?: unknown; up?: unknown} | undefined\n\n      // Check if the file exists before trying to import it\n      const exists = await fileExists(absolutePath)\n      if (!exists) {\n        continue\n      }\n\n      try {\n        const imported = await tsImport(absolutePath, {\n          parentURL: import.meta.url,\n          tsconfig: tsconfig?.path,\n        })\n        // Handle both ESM and CJS default exports\n        mod = imported as {default: Migration; down?: unknown; up?: unknown}\n      } catch (err) {\n        // Ignore MODULE_NOT_FOUND errors, but throw others\n        if (\n          (err as NodeJS.ErrnoException).code !== 'MODULE_NOT_FOUND' &&\n          (err as NodeJS.ErrnoException).code !== 'ERR_MODULE_NOT_FOUND'\n        ) {\n          throw new Error(`Error loading migration: ${(err as Error).message}`)\n        }\n      }\n\n      results.push({absolutePath, mod, relativePath})\n    }\n  }\n\n  return results\n}\n\n/**\n * Checks whether or not the passed resolved migration script is actually loadable (eg has a default export)\n *\n * @param script - The resolved migration script to check\n * @returns `true` if the script is loadable, `false` otherwise\n * @internal\n */\nexport function isLoadableMigrationScript(\n  script: ResolvedMigrationScript,\n): script is Required<ResolvedMigrationScript> {\n  if (script.mod === undefined || !isPlainObject(script.mod.default)) {\n    return false\n  }\n\n  const mod = script.mod.default\n  return typeof mod.title === 'string' && mod.migrate !== undefined\n}\n"],"names":["path","fileExists","getTsconfig","isPlainObject","tsImport","MIGRATION_SCRIPT_EXTENSIONS","MIGRATIONS_DIRECTORY","resolveMigrationScript","workDir","migrationName","tsconfig","locations","join","results","location","ext","relativePath","absolutePath","resolve","mod","exists","imported","parentURL","url","err","code","Error","message","push","isLoadableMigrationScript","script","undefined","default","title","migrate"],"mappings":"AAAA,OAAOA,UAAU,YAAW;AAE5B,SAAQC,UAAU,QAAO,mBAAkB;AAE3C,SAAQC,WAAW,QAAO,eAAc;AACxC,SAAQC,aAAa,QAAO,YAAW;AACvC,SAAQC,QAAQ,QAAO,cAAa;AAEpC,SAAQC,2BAA2B,EAAEC,oBAAoB,QAAO,oCAAmC;AAmBnG;;;;;;;;;;;;;;CAcC,GACD,OAAO,eAAeC,uBACpBC,OAAe,EACfC,aAAqB;IAErB,MAAMC,WAAWR,YAAYM;IAC7B,MAAMG,YAAY;QAACF;QAAeT,KAAKY,IAAI,CAACH,eAAe;KAAS;IACpE,MAAMI,UAAqC,EAAE;IAE7C,KAAK,MAAMC,YAAYH,UAAW;QAChC,KAAK,MAAMI,OAAOV,4BAA6B;YAC7C,MAAMW,eAAehB,KAAKY,IAAI,CAACN,sBAAsB,GAAGQ,SAAS,CAAC,EAAEC,KAAK;YACzE,MAAME,eAAejB,KAAKkB,OAAO,CAACV,SAASQ;YAC3C,IAAIG;YAEJ,sDAAsD;YACtD,MAAMC,SAAS,MAAMnB,WAAWgB;YAChC,IAAI,CAACG,QAAQ;gBACX;YACF;YAEA,IAAI;gBACF,MAAMC,WAAW,MAAMjB,SAASa,cAAc;oBAC5CK,WAAW,YAAYC,GAAG;oBAC1Bb,UAAUA,UAAUV;gBACtB;gBACA,0CAA0C;gBAC1CmB,MAAME;YACR,EAAE,OAAOG,KAAK;gBACZ,mDAAmD;gBACnD,IACE,AAACA,IAA8BC,IAAI,KAAK,sBACxC,AAACD,IAA8BC,IAAI,KAAK,wBACxC;oBACA,MAAM,IAAIC,MAAM,CAAC,yBAAyB,EAAE,AAACF,IAAcG,OAAO,EAAE;gBACtE;YACF;YAEAd,QAAQe,IAAI,CAAC;gBAACX;gBAAcE;gBAAKH;YAAY;QAC/C;IACF;IAEA,OAAOH;AACT;AAEA;;;;;;CAMC,GACD,OAAO,SAASgB,0BACdC,MAA+B;IAE/B,IAAIA,OAAOX,GAAG,KAAKY,aAAa,CAAC5B,cAAc2B,OAAOX,GAAG,CAACa,OAAO,GAAG;QAClE,OAAO;IACT;IAEA,MAAMb,MAAMW,OAAOX,GAAG,CAACa,OAAO;IAC9B,OAAO,OAAOb,IAAIc,KAAK,KAAK,YAAYd,IAAIe,OAAO,KAAKH;AAC1D"}

package/oclif.config.js

@@ -0,0 +1,11 @@
+export default {
+  bin: 'sanity',
+  commands: './dist/commands',
+  dirname: 'sanity',
+  helpClass: './dist/SanityHelp',
+  hooks: {
+    prerun: ['./dist/hooks/prerun/setupTelemetry.js'],
+  },
+  plugins: ['@oclif/plugin-help', '@oclif/plugin-not-found', '@sanity/runtime-cli'],
+  topicSeparator: ' ',
+}