@lqbach/prettier-config 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.6.0](https://github.com/lqbach/eslint-prettier-config/compare/prettier-config-v0.5.0...prettier-config-v0.6.0) (2024-08-26)
+
+
+### Features 🚀
+
+* add prettier tailwind configuration ([da88ac1](https://github.com/lqbach/eslint-prettier-config/commit/da88ac1a5c77d33d50f1530416d06d2b981e8f1e))
+
 ## [0.5.0](https://github.com/lqbach/eslint-prettier-config/compare/prettier-config-v0.4.0...prettier-config-v0.5.0) (2024-08-23)
 
 

package/dist/index.cjs

@@ -23,13 +23,18 @@ __export(src_exports, {
   default: () => config
 });
 module.exports = __toCommonJS(src_exports);
-function config() {
+function config(params) {
+  const tailwind = params?.tailwind;
+  const plugins = [...tailwind ? ["prettier-plugin-tailwindcss"] : []];
+  const tailwindOptions = typeof tailwind !== "boolean" ? tailwind : {};
   return {
     bracketSpacing: true,
+    plugins,
     printWidth: 80,
     semi: false,
     singleQuote: false,
     tabWidth: 2,
-    useTabs: false
+    useTabs: false,
+    ...tailwindOptions
   };
 }

package/dist/index.d.cts

@@ -1,5 +1,10 @@
 import { Config } from 'prettier';
+import { PluginOptions } from 'prettier-plugin-tailwindcss';
 
-declare function config(): Config;
+interface PrettierConfigParams {
+    tailwind?: PluginOptions | boolean;
+}
+
+declare function config(params?: PrettierConfigParams): Config;
 
 export { config as default };

package/dist/index.d.ts

@@ -1,5 +1,10 @@
 import { Config } from 'prettier';
+import { PluginOptions } from 'prettier-plugin-tailwindcss';
 
-declare function config(): Config;
+interface PrettierConfigParams {
+    tailwind?: PluginOptions | boolean;
+}
+
+declare function config(params?: PrettierConfigParams): Config;
 
 export { config as default };

package/dist/index.js

@@ -1,12 +1,17 @@
 // src/index.ts
-function config() {
+function config(params) {
+  const tailwind = params?.tailwind;
+  const plugins = [...tailwind ? ["prettier-plugin-tailwindcss"] : []];
+  const tailwindOptions = typeof tailwind !== "boolean" ? tailwind : {};
   return {
     bracketSpacing: true,
+    plugins,
     printWidth: 80,
     semi: false,
     singleQuote: false,
     tabWidth: 2,
-    useTabs: false
+    useTabs: false,
+    ...tailwindOptions
   };
 }
 export {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lqbach/prettier-config",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "private": false,
   "description": "lqbach's Personal Prettier Config",
   "license": "MIT",
@@ -18,7 +18,8 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "peerDependencies": {
-    "prettier": "^3.1.0"
+    "prettier": "^3.1.0",
+    "prettier-plugin-tailwindcss": "^0.6.6"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --clean --dts"

package/src/index.ts

@@ -1,12 +1,22 @@
 import { Config } from "prettier"
 
-export default function config(): Config {
+import { PrettierConfigParams } from "./types"
+
+export default function config(params?: PrettierConfigParams): Config {
+  const tailwind = params?.tailwind
+
+  const plugins = [...(tailwind ? ["prettier-plugin-tailwindcss"] : [])]
+
+  const tailwindOptions = typeof tailwind !== "boolean" ? tailwind : {}
+
   return {
     bracketSpacing: true,
+    plugins,
     printWidth: 80,
     semi: false,
     singleQuote: false,
     tabWidth: 2,
     useTabs: false,
+    ...tailwindOptions,
   }
 }

package/src/types.ts

@@ -1,5 +1,5 @@
+import type { PluginOptions as PrettierTailwindOptions } from "prettier-plugin-tailwindcss"
+
 export interface PrettierConfigParams {
-  importOrder?: Array<string>
-  react?: boolean
-  vue?: boolean
+  tailwind?: PrettierTailwindOptions | boolean
 }

package/test/tailwind.spec.ts

@@ -0,0 +1,61 @@
+import { describe, expect, test } from "vitest"
+
+import prettierConfig from "../src"
+
+// test tailwind configuration
+describe("test tailwind plugin configuration", () => {
+  describe("if tailwind option not given", () => {
+    const config = prettierConfig()
+
+    test("should not have anything in `plugin` options", () => {
+      expect(config.plugins).toHaveLength(0)
+    })
+
+    test("should not add extra options", () => {
+      expect(config).not.toHaveProperty("tailwindConfig")
+      expect(config).not.toHaveProperty("tailwindEntryPoint")
+      expect(config).not.toHaveProperty("tailwindAttributes")
+      expect(config).not.toHaveProperty("tailwindFunctions")
+      expect(config).not.toHaveProperty("tailwindPreserveWhitespace")
+      expect(config).not.toHaveProperty("tailwindPreserveDuplicates")
+    })
+  })
+
+  describe("if tailwind option is true", () => {
+    const config = prettierConfig({ tailwind: true })
+
+    test("should have `plugin` options", () => {
+      expect(config.plugins).toHaveLength(1)
+      expect(config.plugins).toContain("prettier-plugin-tailwindcss")
+    })
+
+    test("should not add extra options", () => {
+      expect(config).not.toHaveProperty("tailwindConfig")
+      expect(config).not.toHaveProperty("tailwindEntryPoint")
+      expect(config).not.toHaveProperty("tailwindAttributes")
+      expect(config).not.toHaveProperty("tailwindFunctions")
+      expect(config).not.toHaveProperty("tailwindPreserveWhitespace")
+      expect(config).not.toHaveProperty("tailwindPreserveDuplicates")
+    })
+  })
+
+  describe("if tailwind option is an option object", () => {
+    const config = prettierConfig({
+      tailwind: { tailwindAttributes: ["myClassList"] },
+    })
+
+    test("should have `plugin` options", () => {
+      expect(config.plugins).toHaveLength(1)
+      expect(config.plugins).toContain("prettier-plugin-tailwindcss")
+    })
+
+    test("should not add extra options", () => {
+      expect(config).not.toHaveProperty("tailwindConfig")
+      expect(config).not.toHaveProperty("tailwindEntryPoint")
+      expect(config).toHaveProperty("tailwindAttributes")
+      expect(config).not.toHaveProperty("tailwindFunctions")
+      expect(config).not.toHaveProperty("tailwindPreserveWhitespace")
+      expect(config).not.toHaveProperty("tailwindPreserveDuplicates")
+    })
+  })
+})