Remove top-level await from plugin (#420)

Author: thecrypticace

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Remove top-level await ([#420](https://github.com/tailwindlabs/prettier-plugin-tailwindcss/pull/420))
+- Improve load-time performance ([#420](https://github.com/tailwindlabs/prettier-plugin-tailwindcss/pull/420))
+
 ### Fixed
 
 - Collapse whitespace in template literals with adjacent quasis ([#427](https://github.com/tailwindlabs/prettier-plugin-tailwindcss/pull/427))

src/config.ts

@@ -48,7 +48,7 @@ function cacheForDirs<V>(
 
 let pathToApiMap = expiringMap<string | null, Promise<UnifiedApi>>(10_000)
 
-export async function getTailwindConfig(options: ParserOptions): Promise<any> {
+export async function getTailwindConfig(options: ParserOptions): Promise<UnifiedApi> {
   let cwd = process.cwd()
 
   // Locate the file being processed

src/create-plugin.ts

@@ -0,0 +1,270 @@
+import type { Parser, ParserOptions, Plugin, Printer } from 'prettier'
+import { getTailwindConfig } from './config'
+import { createMatcher } from './options'
+import { loadIfExists, maybeResolve } from './resolve'
+import type { TransformOptions } from './transform'
+import type { TransformerEnv } from './types'
+
+export function createPlugin(transforms: TransformOptions<any>[]) {
+  // Prettier parsers and printers may be async functions at definition time.
+  // They'll be awaited when the plugin is loaded but must also be swapped out
+  // with the resolved value before returning as later Prettier internals
+  // assume that parsers and printers are objects and not functions.
+  type Init<T> = (() => Promise<T | undefined>) | T | undefined
+
+  let parsers: Record<string, Init<Parser<any>>> = Object.create(null)
+  let printers: Record<string, Init<Printer<any>>> = Object.create(null)
+
+  for (let opts of transforms) {
+    for (let [name, meta] of Object.entries(opts.parsers)) {
+      parsers[name] = async () => {
+        let plugin = await loadPlugins(meta.load ?? opts.load ?? [])
+        let original = plugin.parsers?.[name]
+        if (!original) return
+
+        parsers[name] = await createParser({
+          name,
+          original,
+          opts,
+        })
+
+        return parsers[name]
+      }
+    }
+
+    for (let [name, meta] of Object.entries(opts.printers ?? {})) {
+      printers[name] = async () => {
+        let plugin = await loadPlugins(opts.load ?? [])
+        let original = plugin.printers?.[name]
+        if (!original) return
+
+        printers[name] = createPrinter({
+          original,
+          opts,
+        })
+
+        return printers[name]
+      }
+    }
+  }
+
+  return { parsers, printers }
+}
+
+async function createParser({
+  name,
+  original,
+  opts,
+}: {
+  name: string
+  original: Parser<any>
+  opts: TransformOptions<any>
+}) {
+  let parser: Parser<any> = { ...original }
+
+  let compatible: { pluginName: string; mod: unknown }[] = []
+
+  for (let pluginName of opts.compatible ?? []) {
+    let mod = await loadIfExistsESM(pluginName)
+    compatible.push({ pluginName, mod })
+  }
+
+  function load(options: ParserOptions<any>) {
+    let parser: Parser<any> = { ...original }
+
+    for (let { pluginName, mod } of compatible) {
+      let plugin = findEnabledPlugin(options, pluginName, mod)
+      if (plugin) Object.assign(parser, plugin.parsers[name])
+    }
+
+    return parser
+  }
+
+  parser.preprocess = (code: string, options: ParserOptions) => {
+    let parser = load(options)
+
+    return parser.preprocess ? parser.preprocess(code, options) : code
+  }
+
+  parser.parse = async (code, options) => {
+    let original = load(options)
+
+    // @ts-expect-error: `options` is passed twice for compat with older plugins that were written
+    // for Prettier v2 but still work with v3.
+    //
+    // Currently only the Twig plugin requires this.
+    let ast = await original.parse(code, options, options)
+
+    let env = await loadTailwindCSS({ opts, options })
+
+    transformAst({
+      ast,
+      env,
+      opts,
+      options,
+    })
+
+    options.__tailwindcss__ = env
+
+    return ast
+  }
+
+  return parser
+}
+
+function createPrinter({
+  original,
+  opts,
+}: {
+  original: Printer<any>
+  opts: TransformOptions<any>
+}) {
+  let printer: Printer<any> = { ...original }
+
+  let reprint = opts.reprint
+
+  // Hook into the preprocessing phase to load the config
+  if (reprint) {
+    printer.print = new Proxy(original.print, {
+      apply(target, thisArg, args) {
+        let [path, options] = args as Parameters<typeof original.print>
+        let env = options.__tailwindcss__ as TransformerEnv
+        reprint(path, { ...env, options: options })
+        return Reflect.apply(target, thisArg, args)
+      },
+    })
+
+    if (original.embed) {
+      printer.embed = new Proxy(original.embed, {
+        apply(target, thisArg, args) {
+          let [path, options] = args as Parameters<typeof original.embed>
+          let env = options.__tailwindcss__ as TransformerEnv
+          reprint(path, { ...env, options: options as any })
+          return Reflect.apply(target, thisArg, args)
+        },
+      })
+    }
+  }
+
+  return printer
+}
+
+async function loadPlugins<T>(fns: string[]) {
+  let plugin: Plugin<T> = {
+    parsers: Object.create(null),
+    printers: Object.create(null),
+    options: Object.create(null),
+    defaultOptions: Object.create(null),
+    languages: [],
+  }
+
+  for (let moduleName of fns) {
+    try {
+      let loaded = await loadIfExistsESM(moduleName)
+      Object.assign(plugin.parsers!, loaded.parsers ?? {})
+      Object.assign(plugin.printers!, loaded.printers ?? {})
+      Object.assign(plugin.options!, loaded.options ?? {})
+      Object.assign(plugin.defaultOptions!, loaded.defaultOptions ?? {})
+
+      plugin.languages = [...(plugin.languages ?? []), ...(loaded.languages ?? [])]
+    } catch (err) {
+      throw err
+    }
+  }
+
+  return plugin
+}
+
+async function loadIfExistsESM(name: string): Promise<Plugin<any>> {
+  let mod = await loadIfExists<Plugin<any>>(name)
+
+  return (
+    mod ?? {
+      parsers: {},
+      printers: {},
+      languages: [],
+      options: {},
+      defaultOptions: {},
+    }
+  )
+}
+
+function findEnabledPlugin(options: ParserOptions<any>, name: string, mod: any) {
+  let path = maybeResolve(name)
+
+  for (let plugin of options.plugins) {
+    if (plugin instanceof URL) {
+      if (plugin.protocol !== 'file:') continue
+      if (plugin.hostname !== '') continue
+
+      plugin = plugin.pathname
+    }
+
+    if (typeof plugin === 'string') {
+      if (plugin === name || plugin === path) {
+        return mod
+      }
+
+      continue
+    }
+
+    // options.plugins.*.name == name
+    if (plugin.name === name) {
+      return mod
+    }
+
+    // options.plugins.*.name == path
+    if (plugin.name === path) {
+      return mod
+    }
+
+    // basically options.plugins.* == mod
+    // But that can't work because prettier normalizes plugins which destroys top-level object identity
+    if (plugin.parsers && mod.parsers && plugin.parsers == mod.parsers) {
+      return mod
+    }
+  }
+}
+
+async function loadTailwindCSS<T = any>({
+  options,
+  opts,
+}: {
+  options: ParserOptions<T>
+  opts: TransformOptions<T>
+}): Promise<TransformerEnv> {
+  let parsers = opts.parsers
+  let parser = options.parser as string
+
+  let context = await getTailwindConfig(options)
+
+  let matcher = createMatcher(options, parser, {
+    staticAttrs: new Set(parsers[parser]?.staticAttrs ?? opts.staticAttrs ?? []),
+    dynamicAttrs: new Set(parsers[parser]?.dynamicAttrs ?? opts.dynamicAttrs ?? []),
+    functions: new Set(),
+    staticAttrsRegex: [],
+    dynamicAttrsRegex: [],
+    functionsRegex: [],
+  })
+
+  return {
+    context,
+    matcher,
+    options,
+    changes: [],
+  }
+}
+
+function transformAst<T = any>({
+  ast,
+  env,
+  opts,
+}: {
+  ast: T
+  env: TransformerEnv
+  options: ParserOptions<T>
+  opts: TransformOptions<T>
+}) {
+  let transform = opts.transform
+  if (transform) transform(ast, env)
+}