Export types (#162)

* Export types

* Fix type linting errors

* refactor

* Tweak wording

* Update changelog

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Export types for Prettier config ([#162](https://github.com/tailwindlabs/prettier-plugin-tailwindcss/pull/162))
+
 ### Fixed
 
 - Don't move partial classes inside Liquid script attributes ([#164](https://github.com/tailwindlabs/prettier-plugin-tailwindcss/pull/164))

build.js

@@ -33,5 +33,16 @@ esbuild.build({
         })
       },
     },
+    {
+      name: 'copy-types',
+      setup(build) {
+        build.onEnd(() =>
+          fs.promises.copyFile(
+            path.resolve(__dirname, './src/index.d.ts'),
+            path.resolve(__dirname, './dist/index.d.ts'),
+          ),
+        )
+      },
+    },
   ],
 })

src/config.js

@@ -1,17 +1,19 @@
 // @ts-check
-import { expiringMap } from './expiring-map.js'
 import clearModule from 'clear-module'
 import escalade from 'escalade/sync'
 import * as path from 'path'
 import prettier from 'prettier'
 import resolveFrom from 'resolve-from'
+// @ts-ignore
 import { generateRules as generateRulesFallback } from 'tailwindcss/lib/lib/generateRules'
+// @ts-ignore
 import { createContext as createContextFallback } from 'tailwindcss/lib/lib/setupContextUtils'
 import loadConfigFallback from 'tailwindcss/loadConfig'
 import resolveConfigFallback from 'tailwindcss/resolveConfig'
+import { expiringMap } from './expiring-map.js'
 
+/** @typedef {import('prettier').ParserOptions} ParserOptions **/
 /** @typedef {import('./types').ContextContainer} ContextContainer **/
-/** @typedef {import('./types').PluginOptions} PluginOptions **/
 
 /**
  * @template K
@@ -29,7 +31,7 @@ let pathToContextMap = expiringMap(10_000)
 let prettierConfigCache = expiringMap(10_000)
 
 /**
- * @param {PluginOptions} options
+ * @param {ParserOptions} options
  * @returns {ContextContainer}
  */
 export function getTailwindConfig(options) {
@@ -59,7 +61,7 @@ export function getTailwindConfig(options) {
 
 /**
  *
- * @param {PluginOptions} options
+ * @param {ParserOptions} options
  * @returns {string | null}
  */
 function getPrettierConfigPath(options) {
@@ -76,7 +78,7 @@ function getPrettierConfigPath(options) {
 }
 
 /**
- * @param {PluginOptions} options
+ * @param {ParserOptions} options
  * @returns {string}
  */
 function getBaseDir(options) {
@@ -143,7 +145,7 @@ function loadTailwindConfig(baseDir, tailwindConfigPath) {
 }
 
 /**
- * @param {PluginOptions} options
+ * @param {ParserOptions} options
  * @param {string} baseDir
  * @returns {string | null}
  */

src/index.d.ts

@@ -0,0 +1,27 @@
+import { Parser, Printer, SupportOption } from 'prettier';
+
+export interface PluginOptions {
+  /**
+   * Path to the Tailwind config file.
+   */
+  tailwindConfig?: string
+
+  /**
+   * List of custom function and tag names that contain classes.
+   */
+  tailwindFunctions: string[]
+
+  /**
+   * List of custom attributes that contain classes.
+   */
+  tailwindAttributes: string[]
+}
+
+declare module 'prettier' {
+  interface RequiredOptions extends PluginOptions {}
+  interface ParserOptions extends PluginOptions {}
+}
+
+export const options: Record<keyof PluginOptions, SupportOption>
+export const parsers: Record<string, Parser>
+export const printers: Record<string, Printer>

src/index.js

@@ -53,7 +53,7 @@ function createParser(parserFormat, transform, meta = {}) {
      *
      * @param {string} text
      * @param {any} parsers
-     * @param {import('./types').PluginOptions} options
+     * @param {import('prettier').ParserOptions} options
      * @returns
      */
     parse(text, parsers, options = {}) {
@@ -446,12 +446,13 @@ function sortTemplateLiteral(node, { env }) {
 }
 
 /**
- * @param {any} ast
+ * @param {import('@babel/types').Node} ast
  * @param {TransformerContext} param1
  */
 function transformJavaScript(ast, { env }) {
   let { staticAttrs, functions } = env.customizations
 
+  /** @param {import('@babel/types').Node} ast */
   function sortInside(ast) {
     visit(ast, (node) => {
       if (isStringLiteral(node)) {
@@ -467,6 +468,7 @@ function transformJavaScript(ast, { env }) {
   }
 
   visit(ast, {
+    /** @param {import('@babel/types').JSXAttribute} node */
     JSXAttribute(node) {
       if (!node.value) {
         return
@@ -483,17 +485,26 @@ function transformJavaScript(ast, { env }) {
       }
     },
 
+    /** @param {import('@babel/types').CallExpression} node */
     CallExpression(node) {
-      if (!node.arguments?.length) return
-      if (!functions.has(node.callee?.name ?? '')) return
+      if (!node.arguments?.length) {
+        return
+      }
+
+      if (!functions.has(node.callee?.name ?? '')) {
+        return
+      }
 
       node.arguments.forEach((arg) => sortInside(arg))
     },
 
+    /** @param {import('@babel/types').TaggedTemplateExpression} node */
     TaggedTemplateExpression(node) {
-      if (node.tag.type === 'Identifier' && functions.has(node.tag.name)) {
-        sortTemplateLiteral(node.quasi, { env })
+      if (node.tag.type !== 'Identifier' || !functions.has(node.tag.name)) {
+        return
       }
+
+      sortTemplateLiteral(node.quasi, { env })
     },
   })
 }

src/options.js

@@ -26,11 +26,11 @@ export const options = {
   },
 }
 
-/** @typedef {import('./types').PluginOptions} PluginOptions */
+/** @typedef {import('prettier').RequiredOptions} RequiredOptions */
 /** @typedef {import('./types').Customizations} Customizations */
 
 /**
- * @param {PluginOptions} options
+ * @param {RequiredOptions} options
  * @param {string} parser
  * @param {Customizations} defaults
  * @returns {Customizations}

src/types.d.ts

@@ -26,20 +26,17 @@ export interface TransformerEnv {
   options: any
 }
 
-export interface RawOptions {
-  tailwindConfig?: string
-  tailwindFunctions?: string[]
-  tailwindAttributes?: string[]
+export interface ContextContainer {
+  context: any
+  generateRules: () => any
+  tailwindConfig: any
 }
 
 export interface InternalOptions {
   printer: Printer<any>
 }
 
-export interface ContextContainer {
-  context: any
-  generateRules: () => any
-  tailwindConfig: any
+declare module 'prettier' {
+  interface RequiredOptions extends InternalOptions {}
+  interface ParserOptions extends InternalOptions {}
 }
-
-export type PluginOptions = ParserOptions<any> & RawOptions & InternalOptions