Merge branch 'main' into feat/works/add-eslint-config

.github/actions/pnpm-install/action.yaml

@@ -6,25 +6,38 @@ description: Setup pnpm and install dependencies
 runs:
   using: 'composite'
   steps:
-    - id: pnpm-config
-      name: Expose pnpm config(s) through "$GITHUB_OUTPUT"
-      run: |
-        echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
-      shell: 'bash -Eeuo pipefail {0}'
+    - name: Setup pnpm
+      uses: pnpm/action-setup@ac5bf11548bf5e19b8aadb8182072616590fa4a6
+      with:
+        run_install: false
+
+    - name: Setup Node.js
+      uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+      with:
+        node-version-file: '.node-version'
 
-    - id: cache-rotation
-      name: Cache rotation keys
+    - id: cache-config
+      name: Configure cache
       run: |
-        echo "YEAR_MONTH=$(/bin/date -u "+%Y%m")" >> $GITHUB_OUTPUT
+        pnpm_store_path="$(pnpm store path --silent)"
+        if [ -z "pnpm_store_path" ]; then
+          echo "Failed to get pnpm store path"
+          exit 1
+        fi
+        mkdir -p "pnpm_store_path" || exit 1
+        echo "path=$pnpm_store_path" >> $GITHUB_OUTPUT
+        year_month=$(date -u '+%Y%m')
+        base_key="${{ runner.os }}-pnpm-cache-v${year_month}"
+        echo "key=${base_key}-${{ hashFiles('**/pnpm-lock.yaml') }}" >> $GITHUB_OUTPUT
+        echo "restore-keys=${base_key}-" >> $GITHUB_OUTPUT
       shell: 'bash -Eeuo pipefail {0}'
 
     - name: Setup pnpm cache
       uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
       with:
-        path: ${{ steps.pnpm-config.outputs.STORE_PATH }}
-        key: ${{ runner.os }}-pnpm-store-cache-${{ steps.cache-rotation.outputs.YEAR_MONTH }}-${{ hashFiles('**/pnpm-lock.yaml') }}
-        restore-keys: |
-          ${{ runner.os }}-pnpm-store-cache-${{ steps.cache-rotation.outputs.YEAR_MONTH }}-
+        key: ${{ steps.cache-config.outputs.key }}
+        path: ${{ steps.cache-config.outputs.path }}
+        restore-keys: ${{ steps.cache-config.outputs.restore-keys }}
 
     - name: Bootstrap monorepo
       env:

.github/workflows/cache-cleanup.yaml

@@ -11,10 +11,11 @@ name: Cache Cleanup
 
 jobs:
   cleanup:
+    name: Cleanup cache
     runs-on: ubuntu-latest
     steps:
-      - name: Check out code
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Checkout repository
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
 
       - id: cache-info
         name: Get branch name and cache keys
@@ -32,7 +33,7 @@ jobs:
           echo "branch=$BRANCH" >> $GITHUB_OUTPUT
           if [ -n "$BRANCH" ]; then
             # Get cache keys that don't include the branch's SHA (if not a PR)
-            gh actions-cache list -R ${{ github.repository }} -B $BRANCH --order asc --sort last-use | cut -f 1 > cache-keys.txt
+            gh actions-cache list -R ${{ github.repository }} -B $BRANCH --order asc --sort last-used | cut -f 1 > cache-keys.txt
             [ -z "${{ github.event.pull_request }}" ] && grep -v ${{ github.sha }} cache-keys.txt > cache-keys.txt.tmp && mv cache-keys.txt.tmp cache-keys.txt
             echo cache-keys="$(cat cache-keys.txt | tr '\n' ' ')" >> $GITHUB_OUTPUT
           fi

.github/workflows/main.yaml

@@ -25,10 +25,10 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
 
       - name: Prepare job
-        uses: ./.github/actions/prepare
+        uses: ./.github/actions/pnpm-install
 
       - name: Check formatting
         run: pnpm run check-format
@@ -64,13 +64,13 @@ jobs:
           git config --global user.name 'bfra-me[bot]'
 
       - name: Checkout repository
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
         with:
           fetch-depth: 0
           token: ${{ steps.get-workflow-access-token.outputs.token }}
 
       - name: Prepare job
-        uses: ./.github/actions/prepare
+        uses: ./.github/actions/pnpm-install
 
       - name: Perform a dry run of `pnpm publish`
         run: pnpm -r publish --dry-run

package.json

@@ -37,6 +37,7 @@
     "@changesets/cli": "2.27.7",
     "@eslint/config-inspector": "0.5.4",
     "@manypkg/cli": "0.21.4",
+    "@microsoft/api-extractor": "7.47.9",
     "@swisspost/design-system-changelog-github": "1.0.2",
     "@types/node": "20.16.1",
     "eslint": "9.11.0",

packages/prettier-config/.gitignore

@@ -1,2 +1 @@
-*.d.ts
-*.js
+test/_fixtures

packages/prettier-config/.prettierignore

@@ -1,3 +1 @@
-!*.d.ts
-!*.js
-test/fixtures/**
+test/fixtures/

packages/prettier-config/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @bfra.me/prettier-config
 
+## 0.7.3
+### Patch Changes
+
+
+
+- Refactor and add `languages` to the `package-json` plugin; improve types (by [@marcusrbrown](https://github.com/marcusrbrown) with [#407](https://github.com/bfra-me/works/pull/407))
+- Updated dependencies:
+  - @bfra.me/prettier-plugins@0.4.0
+
 ## 0.7.2
 ### Patch Changes
 

packages/prettier-config/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bfra.me/prettier-config",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "Shared Prettier configuration for bfra.me",
   "keywords": [
     "bfra.me",
@@ -22,27 +22,26 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./prettier.config.d.ts",
-      "import": "./prettier.config.js"
+      "types": "./lib/prettier.config.d.ts",
+      "import": "./lib/prettier.config.js"
     },
-    "./100-proof": "./prettier.config.js",
-    "./120-proof": "./120-proof.js",
-    "./semi/*": "./*.js?semi=true",
-    "./semi": "./prettier.config.js?semi=true",
-    "./*/semi": "./*.js?semi=true",
+    "./100-proof": "./lib/prettier.config.js",
+    "./120-proof": "./lib/120-proof.js",
+    "./semi/*": "./lib/*.js?semi=true",
+    "./semi": "./lib/prettier.config.js?semi=true",
+    "./*/semi": "./lib/*.js?semi=true",
     "./package.json": "./package.json"
   },
-  "main": "prettier.config.js",
-  "types": "prettier.config.d.ts",
+  "main": "./lib/prettier.config.js",
+  "types": "./lib/prettier.config.d.ts",
   "files": [
-    "*.js",
-    "*.ts",
+    "lib",
+    "src",
     "!**/*.map",
     "!tsup.config.ts"
   ],
   "scripts": {
-    "build": "tsup && pnpm run format",
-    "format": "prettier --ignore-path .prettierignore --log-level log --write .",
+    "build": "tsup",
     "test": "vitest"
   },
   "dependencies": {

packages/prettier-config/120-proof.ts → packages/prettier-config/src/120-proof.ts

@@ -1,4 +1,4 @@
-import prettierConfig from '@bfra.me/prettier-config'
+import prettierConfig from './prettier.config.js'
 import type {Config} from 'prettier'
 
 const {searchParams: params} = new URL(import.meta.url)

packages/prettier-config/src/plugins.ts

@@ -0,0 +1,17 @@
+import type {Plugin} from 'prettier'
+import * as PluginPackageJson from '@bfra.me/prettier-plugins/package-json'
+
+const resolvedPlugins: Record<string, Plugin> = {
+  '@bfra.me/prettier-plugins/package-json': PluginPackageJson,
+}
+
+export const resolve = (resolver: (id: string) => string, plugin: string): string | Plugin => {
+  try {
+    if (resolvedPlugins[plugin]) {
+      return resolvedPlugins[plugin]
+    }
+    return resolver(plugin)
+  } finally {
+    return plugin
+  }
+}

packages/prettier-config/prettier.config.ts → packages/prettier-config/src/prettier.config.ts

@@ -34,6 +34,7 @@ const config: Config = {
         '**/.next/**',
         '**/.nuxt/**',
         '**/.output/**',
+        '**/.tsup/**',
         '**/.vercel/**',
         '**/.vitepress/cache/**',
         '**/.vite-inspect/**',

packages/prettier-config/tsconfig.json

@@ -2,9 +2,8 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "outDir": ".",
-    "rootDir": ".",
-    "sourceMap": false
+    "outDir": "./lib",
+    "rootDir": "./src"
   },
-  "include": ["./*.ts"]
+  "include": ["./src/**/*.ts"]
 }

packages/prettier-config/tsup.config.ts

@@ -2,10 +2,12 @@ import {defineConfig} from 'tsup'
 
 export default defineConfig({
   bundle: false,
+  clean: true,
   dts: true,
-  entry: ['prettier.config.ts', '120-proof.ts', 'plugins.ts'],
+  entry: ['./src/*.ts'],
   format: ['esm'],
-  outDir: '.',
+  outDir: 'lib',
   sourcemap: true,
+  // Splitting can place code using `import.meta` into a separate chunk, which breaks the preset export mappings.
   splitting: false,
 })

packages/prettier-plugins/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @bfra.me/prettier-plugins
 
+## 0.4.0
+### Minor Changes
+
+
+
+- Refactor and add `languages` to the `package-json` plugin; improve types (by [@marcusrbrown](https://github.com/marcusrbrown) with [#407](https://github.com/bfra-me/works/pull/407))
+
 ## 0.3.1
 ### Patch Changes
 

packages/prettier-plugins/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bfra.me/prettier-plugins",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Plugins for Prettier used across bfra.me.",
   "keywords": [
     "bfra.me",

packages/prettier-plugins/src/index.ts

@@ -1 +1,3 @@
-export * from './package-json.js'
+import * as PluginPackageJson from './package-json.js'
+
+export {PluginPackageJson}

packages/prettier-plugins/src/package-json.ts

@@ -1,34 +1,45 @@
-import type {Parser, ParserOptions, Plugin, SupportOption} from 'prettier'
+import type {
+  ParserOptions as PrettierParserOptions,
+  SupportOption,
+  SupportOptions as PrettierSupportOptions,
+} from 'prettier'
 import prettier from 'prettier'
 import {parsers as babelParsers} from 'prettier/plugins/babel'
+import {languages as estreeLanguages} from 'prettier/plugins/estree'
 import {sortPackageJson} from 'sort-package-json'
 
-export type SortPackageJsonOptions = NonNullable<Parameters<typeof sortPackageJson>[1]>
+type SortPackageJsonOptions = NonNullable<Parameters<typeof sortPackageJson>[1]>
 
 export type PrettierPackageJsonOptions = {
   /** Custom ordering array or comparator function. */
   sortPackageJsonSortOrder?: SortPackageJsonOptions['sortOrder']
 }
 
-export type PrettierOptions = ParserOptions & PrettierPackageJsonOptions
+export type ParserOptions<T = any> = PrettierParserOptions<T> & PrettierPackageJsonOptions
 
-export const options = {
+const languages = estreeLanguages.filter(({name}) => name === 'JSON.stringify')
+
+export type SupportOptions = PrettierSupportOptions & {
+  [_ in keyof PrettierPackageJsonOptions]: SupportOption
+}
+
+const options: SupportOptions = {
   sortPackageJsonSortOrder: {
-    category: 'Format',
+    category: 'JavaScript',
     type: 'string',
     description: 'Custom ordering array.',
     default: [{value: [] as string[]}],
     array: true,
   },
-} satisfies Record<keyof PrettierPackageJsonOptions, SupportOption>
+}
 
 const parser = babelParsers['json-stringify']
 
-export const parsers = {
+const parsers: Partial<typeof babelParsers> = {
   'json-stringify': {
     ...parser,
 
-    async parse(text: string, options: PrettierOptions) {
+    async parse(text: string, options: ParserOptions) {
       const {filepath} = options
       if (/package.*json$/u.test(filepath)) {
         // Format the text with prettier to avoid any parsing errors
@@ -48,11 +59,6 @@ export const parsers = {
       return parser.parse(text, options)
     },
   },
-} satisfies Record<string, Parser>
-
-const PackageJsonPlugin: Plugin<string> = {
-  parsers,
-  options,
 }
 
-export default PackageJsonPlugin
+export {languages, options, parsers}

packages/prettier-plugins/tsconfig.json

@@ -3,7 +3,8 @@
   "extends": "../../tsconfig.json",
   "compilerOptions": {
     "outDir": "./lib",
-    "rootDir": "./src"
+    "rootDir": "./src",
+    "typeRoots": ["./types", "./node_modules/@types"]
   },
   "include": ["./src/**/*.ts"]
 }