@instructure/ui-codemods 11.7.6-snapshot-18 → 11.7.6-snapshot-22

package/lib/utils/formatSource.ts

@@ -22,17 +22,87 @@
  * SOFTWARE.
  */
 
-import prettier from 'prettier'
+type PrettierOptions = Record<string, unknown>
 
-export default function formatSource(source: string, sourcePath: string) {
-  let options = null
+/**
+ * The subset of the Prettier API this module uses. Both Prettier 2 and 3 are
+ * supported: in v2 `format` is synchronous and `resolveConfig` returns a
+ * promise, in v3 both are asynchronous. Awaiting covers both shapes.
+ */
+type PrettierModule = {
+  format: (
+    source: string,
+    options?: PrettierOptions
+  ) => string | Promise<string>
+  resolveConfig: (
+    path: string
+  ) => PrettierOptions | null | Promise<PrettierOptions | null>
+}
+
+const PRETTIER = 'prettier'
+
+let prettierPromise: Promise<PrettierModule | undefined> | undefined
+let warnedAboutMissingPrettier = false
+
+/**
+ * jscodeshift registers `@babel/register` for `.mjs` and `.cjs` files too and
+ * rewrites their modules to CommonJS. That breaks Prettier 3, whose `index.cjs`
+ * loads the ESM `index.mjs` at runtime. Hiding the dynamic import in a
+ * `new Function` keeps Babel from compiling it to a `require` call, so Node
+ * loads Prettier itself.
+ */
+const importModule = new Function('specifier', 'return import(specifier)') as (
+  specifier: string
+) => Promise<Record<string, unknown>>
+
+async function importPrettier(): Promise<Record<string, unknown>> {
+  try {
+    return await importModule(PRETTIER)
+  } catch {
+    // Test runners that evaluate modules in their own context (Vitest) give
+    // `new Function` no dynamic import callback, but do handle a plain import.
+    return await import(PRETTIER)
+  }
+}
+
+/**
+ * Prettier is an optional peer dependency, so it is resolved from the
+ * consumer's `node_modules` and its version is whatever they installed.
+ */
+function loadPrettier() {
+  if (!prettierPromise) {
+    prettierPromise = importPrettier()
+      .then((namespace) => {
+        const asDefault = namespace.default as PrettierModule | undefined
+        return typeof asDefault?.format === 'function'
+          ? asDefault
+          : (namespace as unknown as PrettierModule)
+      })
+      .catch(() => undefined)
+  }
+  return prettierPromise
+}
+
+export default async function formatSource(source: string, sourcePath: string) {
+  const prettier = await loadPrettier()
+  if (!prettier) {
+    if (!warnedAboutMissingPrettier) {
+      warnedAboutMissingPrettier = true
+      console.warn(
+        'Prettier is not installed, the codemod result is not formatted. ' +
+          'Install prettier (v2 or v3) or run the codemod with --usePrettier=false'
+      )
+    }
+    return source
+  }
+  let options: PrettierOptions | null = null
   const extension = sourcePath.split('.').pop()
   let parser = 'babel'
   if (extension === 'ts' || extension === 'tsx') {
     parser = 'typescript'
   }
   try {
-    options = prettier.resolveConfig.sync(sourcePath)
+    options = await prettier.resolveConfig(sourcePath)
     if (options) {
       // Set the parser argument if the consumer did not set one to avoid a console warning
       options = {
@@ -45,7 +115,7 @@ export default function formatSource(source: string, sourcePath: string) {
   }
   let result = source
   try {
-    result = prettier.format(
+    result = await prettier.format(
       source,
       options || {
         parser: parser,

package/lib/utils/instUICodemodExecutor.ts

@@ -49,10 +49,11 @@ export type InstUICodemod = (
  * written to this file.
  * @param options.usePrettier if `true` the transformed code will be run through
  * [Prettier](https://prettier.io/). You can customize this through a [Prettier
- * config file](https://prettier.io/docs/configuration.html)
- * @returns the modified file as `string` or `null`
+ * config file](https://prettier.io/docs/configuration.html). Prettier is an
+ * optional peer dependency; both Prettier 2 and 3 work.
+ * @returns a promise resolving to the modified file as `string` or to `null`
  */
-const instUICodemodExecutor = (
+const instUICodemodExecutor = async (
   instUICodemods: InstUICodemod[] | InstUICodemod,
   file: FileInfo,
   api: API,
@@ -61,7 +62,7 @@ const instUICodemodExecutor = (
     usePrettier?: boolean
     quote?: 'single' | 'double' | 'auto'
   }
-) => {
+): Promise<string | null> => {
   const j = api.jscodeshift.withParser('tsx')
   const root = j(file.source)
   let hasModifications = false
@@ -83,7 +84,7 @@ const instUICodemodExecutor = (
   if (hasModifications) {
     const shouldUsePrettier = options?.usePrettier !== false
     return shouldUsePrettier
-      ? formatSource(root.toSource(), file.path)
+      ? await formatSource(root.toSource(), file.path)
       : root.toSource({ quote: options?.quote ?? 'double' })
   } else {
     return null

package/lib/warnCodeEditorRemoved.ts

@@ -29,12 +29,17 @@ import type { InstUICodemod } from './utils/instUICodemodExecutor'
 /**
  * Prints a warning if a `CodeEditor` import is found
  */
-const warnCodeEditorRemoved: Transform = (
+const warnCodeEditorRemoved: Transform = async (
   file,
   api,
   options?: { fileName?: string; usePrettier?: boolean }
 ) => {
-  return instUICodemodExecutor(warnCodeEditorRemovedCodemod, file, api, options)
+  return await instUICodemodExecutor(
+    warnCodeEditorRemovedCodemod,
+    file,
+    api,
+    options
+  )
 }
 
 const warnCodeEditorRemovedCodemod: InstUICodemod = (

package/lib/warnTableCaptionMissing.ts

@@ -36,12 +36,12 @@ const TABLE_IMPORT_PATHS = ['@instructure/ui-table', '@instructure/ui']
 /**
  * Prints a warning if the `caption` prop is missing from a `<Table />`.
  */
-const warnTableCaptionMissing: Transform = (
+const warnTableCaptionMissing: Transform = async (
   file,
   api,
   options?: { fileName?: string; usePrettier?: boolean }
 ) => {
-  return instUICodemodExecutor(
+  return await instUICodemodExecutor(
     warnTableCaptionMissingCodemod,
     file,
     api,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-codemods",
-  "version": "11.7.6-snapshot-18",
+  "version": "11.7.6-snapshot-22",
   "description": "Codemod scripts to help upgrade Instructure UI libraries.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./lib/index.ts",
@@ -13,16 +13,23 @@
   "bugs": "https://github.com/instructure/instructure-ui/issues",
   "license": "MIT",
   "dependencies": {
-    "jscodeshift": "^17.3.0",
-    "prettier": "^2.8.8"
+    "jscodeshift": "^17.3.0"
+  },
+  "peerDependencies": {
+    "prettier": "^2.8.8 || ^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "prettier": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@types/jscodeshift": "^17.3.0",
     "@types/node": "24.1.0",
-    "@types/prettier": "^2.7.3",
     "ast-types": "^0.16.1",
+    "prettier": "3.8.1",
     "vitest": "^4.1.9",
-    "@instructure/ui-babel-preset": "11.7.6-snapshot-18"
+    "@instructure/ui-babel-preset": "11.7.6-snapshot-22"
   },
   "publishConfig": {
     "access": "public"
@@ -38,9 +45,6 @@
     "./package.json": "./package.json",
     "./src/*": "./src/*"
   },
-  "//dependency-comments": {
-    "prettier": "Prettier 3 is async, https://prettier.io/blog/2023/07/05/3.0.0.html#api-1"
-  },
   "type": "module",
   "scripts": {
     "test:vitest": "vitest --watch=false",