Add formatting check to CI and fix format script (#434)

- Update format script to target TypeScript files instead of JavaScript
- Remove deprecated --plugin-search-dir option
- Add "Check formatting" step to CI workflow
- Apply Prettier formatting to all source and test files

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

Author: Boshen

.github/workflows/ci.yml

@@ -41,6 +41,9 @@ jobs:
       - name: Install dependencies
         run: npm install --force
 
+      - name: Check formatting
+        run: npm run format -- --check
+
       - name: Build Prettier Plugin
         run: |
           npm run build

package.json

@@ -28,7 +28,7 @@
     "pretest": "node scripts/install-fixture-deps.js",
     "test": "vitest",
     "prepublishOnly": "npm run build && node scripts/copy-licenses.js",
-    "format": "prettier \"src/**/*.js\" \"scripts/**/*.js\" \"tests/test.js\" --write --print-width 100 --single-quote --no-semi --plugin-search-dir ./tests",
+    "format": "prettier \"src/**/*.ts\" \"scripts/**/*.js\" \"tests/*.ts\" --write --print-width 100 --single-quote --no-semi",
     "release-channel": "node ./scripts/release-channel.js",
     "release-notes": "node ./scripts/release-notes.js"
   },

scripts/install-fixture-deps.js

@@ -7,7 +7,11 @@ import glob from 'fast-glob'
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
 const fixtures = glob.sync(
-  ['tests/fixtures/*/package.json', 'tests/fixtures/v4/*/package.json', 'tests/fixtures/monorepo/*/package.json'],
+  [
+    'tests/fixtures/*/package.json',
+    'tests/fixtures/v4/*/package.json',
+    'tests/fixtures/monorepo/*/package.json',
+  ],
   {
     cwd: path.resolve(__dirname, '..'),
   },

scripts/release-notes.js

@@ -12,7 +12,10 @@ const pkg = JSON.parse(await fs.readFile(path.resolve(__dirname, '../package.jso
 let version = process.argv[2] || process.env.npm_package_version || pkg.version
 
 let changelog = await fs.readFile(path.resolve(__dirname, '..', 'CHANGELOG.md'), 'utf8')
-let match = new RegExp(`## \\[${version}\\] - (.*)\\n\\n([\\s\\S]*?)\\n(?:(?:##\\s)|(?:\\[))`, 'g').exec(changelog)
+let match = new RegExp(
+  `## \\[${version}\\] - (.*)\\n\\n([\\s\\S]*?)\\n(?:(?:##\\s)|(?:\\[))`,
+  'g',
+).exec(changelog)
 
 if (match) {
   let [, , notes] = match

src/config.ts

@@ -138,7 +138,10 @@ async function resolvePrettierConfigPath(filePath: string): Promise<[string, str
 
 let resolvedModCache = expiringMap<string, Promise<[any | null, string | null]>>(10_000)
 
-async function resolveTailwindPath(options: ParserOptions, baseDir: string): Promise<[any | null, string | null]> {
+async function resolveTailwindPath(
+  options: ParserOptions,
+  baseDir: string,
+): Promise<[any | null, string | null]> {
   let pkgName = options.tailwindPackageName ?? 'tailwindcss'
 
   return await resolvedModCache.remember(`${pkgName}:${baseDir}`, async () => {
@@ -187,7 +190,11 @@ function findClosestJsConfig(inputDir: string): string | null {
   return configPath
 }
 
-function resolveStylesheet(options: ParserOptions, baseDir: string, configPath: string | null): string | null {
+function resolveStylesheet(
+  options: ParserOptions,
+  baseDir: string,
+  configPath: string | null,
+): string | null {
   if (options.tailwindStylesheet) {
     if (
       options.tailwindStylesheet.endsWith('.js') ||

src/index.ts

@@ -1,5 +1,8 @@
 // @ts-ignore
-import type { AttrDoubleQuoted, AttrSingleQuoted } from '@shopify/prettier-plugin-liquid/dist/types.js'
+import type {
+  AttrDoubleQuoted,
+  AttrSingleQuoted,
+} from '@shopify/prettier-plugin-liquid/dist/types.js'
 import * as astTypes from 'ast-types'
 // @ts-ignore
 import jsesc from 'jsesc'
@@ -14,7 +17,13 @@ import { getTailwindConfig } from './config.js'
 import { createMatcher, type Matcher } from './options.js'
 import { loadPlugins } from './plugins.js'
 import { sortClasses, sortClassList } from './sorting.js'
-import type { Customizations, StringChange, TransformerContext, TransformerEnv, TransformerMetadata } from './types'
+import type {
+  Customizations,
+  StringChange,
+  TransformerContext,
+  TransformerEnv,
+  TransformerMetadata,
+} from './types'
 import { spliceChangesIntoString, visit, type Path } from './utils.js'
 
 let base = await loadPlugins()
@@ -339,7 +348,11 @@ function transformGlimmer(ast: any, { env }: TransformerContext) {
       }
 
       let concat = path.find((entry) => {
-        return entry.parent && entry.parent.type === 'SubExpression' && entry.parent.path.original === 'concat'
+        return (
+          entry.parent &&
+          entry.parent.type === 'SubExpression' &&
+          entry.parent.path.original === 'concat'
+        )
       })
 
       node.value = sortClasses(node.value, {
@@ -507,7 +520,9 @@ function sortStringLiteral(
 }
 
 function isStringLiteral(node: any) {
-  return node.type === 'StringLiteral' || (node.type === 'Literal' && typeof node.value === 'string')
+  return (
+    node.type === 'StringLiteral' || (node.type === 'Literal' && typeof node.value === 'string')
+  )
 }
 
 function sortTemplateLiteral(
@@ -568,7 +583,9 @@ function sortTemplateLiteral(
 }
 
 function isSortableTemplateExpression(
-  node: import('@babel/types').TaggedTemplateExpression | import('ast-types').namedTypes.TaggedTemplateExpression,
+  node:
+    | import('@babel/types').TaggedTemplateExpression
+    | import('ast-types').namedTypes.TaggedTemplateExpression,
   matcher: Matcher,
 ): boolean {
   return isSortableExpression(node.tag, matcher)
@@ -910,7 +927,8 @@ function transformTwig(ast: any, { env, changes }: TransformerContext) {
       const concat = path.find((entry) => {
         return (
           entry.parent &&
-          (entry.parent.type === 'BinaryConcatExpression' || entry.parent.type === 'BinaryAddExpression')
+          (entry.parent.type === 'BinaryConcatExpression' ||
+            entry.parent.type === 'BinaryAddExpression')
         )
       })
 
@@ -938,7 +956,11 @@ function transformPug(ast: any, { env }: TransformerContext) {
   // First sort the classes in attributes
   for (const token of ast.tokens) {
     if (token.type === 'attribute' && matcher.hasStaticAttr(token.name)) {
-      token.val = [token.val.slice(0, 1), sortClasses(token.val.slice(1, -1), { env }), token.val.slice(-1)].join('')
+      token.val = [
+        token.val.slice(0, 1),
+        sortClasses(token.val.slice(1, -1), { env }),
+        token.val.slice(-1),
+      ].join('')
     }
   }
 

src/options.ts

@@ -67,7 +67,11 @@ export interface Matcher {
   hasFunction(name: string): boolean
 }
 
-export function createMatcher(options: RequiredOptions, parser: string, defaults: Customizations): Matcher {
+export function createMatcher(
+  options: RequiredOptions,
+  parser: string,
+  defaults: Customizations,
+): Matcher {
   let staticAttrs = new Set<string>(defaults.staticAttrs)
   let dynamicAttrs = new Set<string>(defaults.dynamicAttrs)
   let functions = new Set<string>(defaults.functions)

src/utils.bench.ts

@@ -12,7 +12,9 @@ describe('spliceChangesIntoString', () => {
 
   function buildFixture(repeatCount: number, changeCount: number) {
     // A large set of changes across random places in the string
-    let indxes = new Set(Array.from({ length: changeCount }, (_, i) => Math.ceil(Math.random() * repeatCount)))
+    let indxes = new Set(
+      Array.from({ length: changeCount }, (_, i) => Math.ceil(Math.random() * repeatCount)),
+    )
 
     let changes: StringChange[] = Array.from(indxes).flatMap((idx) => {
       return changesTemplate.map((change) => ({

src/utils.test.ts

@@ -10,7 +10,9 @@ describe('spliceChangesIntoString', () => {
       { start: 10, end: 15, before: 'brown', after: 'purple' },
     ]
 
-    expect(spliceChangesIntoString(str, changes)).toBe('the quick purple fox jumps over the lazy dog')
+    expect(spliceChangesIntoString(str, changes)).toBe(
+      'the quick purple fox jumps over the lazy dog',
+    )
   })
 
   test('changes are applied in order', ({ expect }) => {
@@ -21,6 +23,8 @@ describe('spliceChangesIntoString', () => {
       { start: 4, end: 9, before: 'quick', after: 'slow' },
     ]
 
-    expect(spliceChangesIntoString(str, changes)).toBe('the slow purple fox jumps over the lazy dog')
+    expect(spliceChangesIntoString(str, changes)).toBe(
+      'the slow purple fox jumps over the lazy dog',
+    )
   })
 })

src/versions/v3.ts

@@ -72,13 +72,17 @@ export async function loadV3(pkgDir: string | null, jsConfig: string | null): Pr
     // that don't exist on their own. This will result in them "not existing" and
     // sorting could be weird since you still require them in order to make the
     // host utitlies work properly. (Thanks Biology)
-    let parasiteUtilities = new Set([prefixCandidate(context, 'group'), prefixCandidate(context, 'peer')])
+    let parasiteUtilities = new Set([
+      prefixCandidate(context, 'group'),
+      prefixCandidate(context, 'peer'),
+    ])
 
     let classNamesWithOrder: [string, bigint | null][] = []
 
     for (let className of classes) {
       let order: bigint | null =
-        generateRules(new Set([className]), context).sort(([a], [z]) => bigSign(z - a))[0]?.[0] ?? null
+        generateRules(new Set([className]), context).sort(([a], [z]) => bigSign(z - a))[0]?.[0] ??
+        null
 
       if (order === null && parasiteUtilities.has(className)) {
         // This will make sure that it is at the very beginning of the
@@ -97,7 +101,9 @@ export async function loadV3(pkgDir: string | null, jsConfig: string | null): Pr
 
   return {
     getClassOrder: (classList: string[]) => {
-      return context.getClassOrder ? context.getClassOrder(classList) : getClassOrderPolyfill(classList)
+      return context.getClassOrder
+        ? context.getClassOrder(classList)
+        : getClassOrderPolyfill(classList)
     },
   }
 }