@fun-foundry/prettier-config 1.0.0 → 1.1.0

package/README.md

@@ -1,24 +1,44 @@
-# @fun-foundry/eslint-config
+# @fun-foundry/prettier-config
 
 Opinionated Prettier configuration maintained by fun-foundry.
 
+This package provides a shared Prettier configuration for JavaScript / TypeScript projects.
+
 ## Installation
 
+Install both Prettier and this configuration package.
+
+```sh
+npm install --save-dev prettier @fun-foundry/prettier-config
+```
+
+or
+
 ```sh
-npm install --save-dev @fun-foundry/prettier-config
+yarn add -D prettier @fun-foundry/prettier-config
+```
+
+or
+
+```sh
+pnpm add -D prettier @fun-foundry/prettier-config
 ```
 
 ## Usage
 
-In your `package.json`:
+Create a Prettier configuration file and import this package.
 
-```json
-{
-  "prettier": "@fun-foundry/prettier-config"
-}
+Example: `prettier.config.mjs`
+
+```js
+import config from '@fun-foundry/prettier-config'
+
+export default config
 ```
 
-Or in `prettier.config.js` (or `.mjs`):
+If your project already uses ESM ("type": "module" in package.json), you can also use prettier.config.js.
+
+Example: `prettier.config.js`
 
 ```js
 import config from '@fun-foundry/prettier-config'
@@ -26,6 +46,29 @@ import config from '@fun-foundry/prettier-config'
 export default config
 ```
 
+## Customization
+
+You can extend this config and override individual options in your project.
+
+Example: `prettier.config.js`
+
+```js
+import config from '@fun-foundry/prettier-config'
+
+export default {
+  ...config,
+  printWidth: 100,
+  semi: true
+}
+```
+
+This is useful when you want to keep the base style from this package while adapting a few rules for a specific project.
+
+## Requirements
+
+- Node.js >= 18.18.0
+- Prettier >= 3 < 4
+
 ## License
 
 [MIT](LICENSE)

package/dist/src/index.d.ts

@@ -0,0 +1,14 @@
+declare const prettierConfig: {
+    arrowParens: "avoid";
+    bracketSameLine: false;
+    bracketSpacing: true;
+    jsxSingleQuote: true;
+    printWidth: number;
+    semi: false;
+    singleQuote: true;
+    tabWidth: number;
+    trailingComma: "none";
+    useTabs: false;
+};
+export default prettierConfig;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,cAAc;;;;;;;;;;;CAWF,CAAA;AAElB,eAAe,cAAc,CAAA"}

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,cAAc,GAAG;IACrB,WAAW,EAAE,OAAO;IACpB,eAAe,EAAE,KAAK;IACtB,cAAc,EAAE,IAAI;IACpB,cAAc,EAAE,IAAI;IACpB,UAAU,EAAE,GAAG;IACf,IAAI,EAAE,KAAK;IACX,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,CAAC;IACX,aAAa,EAAE,MAAM;IACrB,OAAO,EAAE,KAAK;CACE,CAAA;AAElB,eAAe,cAAc,CAAA"}

package/dist/test/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/test/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../test/index.test.ts"],"names":[],"mappings":""}

package/dist/test/index.test.js

@@ -0,0 +1,29 @@
+import test from 'node:test';
+import assert from 'node:assert/strict';
+import prettier from 'prettier';
+import config from '../src/index.js';
+test('exports expected prettier config', () => {
+    assert.deepEqual(config, {
+        arrowParens: 'avoid',
+        bracketSameLine: false,
+        bracketSpacing: true,
+        jsxSingleQuote: true,
+        printWidth: 120,
+        semi: false,
+        singleQuote: true,
+        tabWidth: 2,
+        trailingComma: 'none',
+        useTabs: false
+    });
+});
+test('can format code with exported config', async () => {
+    const formatted = await prettier.format("const hello = ( name ) => { return 'world' }\n", {
+        ...config,
+        parser: 'babel'
+    });
+    assert.equal(formatted, `const hello = name => {
+  return 'world'
+}
+`);
+});
+//# sourceMappingURL=index.test.js.map

package/dist/test/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../test/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,MAAM,MAAM,oBAAoB,CAAA;AACvC,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,MAAM,MAAM,iBAAiB,CAAA;AAEpC,IAAI,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAC5C,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE;QACvB,WAAW,EAAE,OAAO;QACpB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;QACpB,cAAc,EAAE,IAAI;QACpB,UAAU,EAAE,GAAG;QACf,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,IAAI;QACjB,QAAQ,EAAE,CAAC;QACX,aAAa,EAAE,MAAM;QACrB,OAAO,EAAE,KAAK;KACf,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEF,IAAI,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;IACtD,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,MAAM,CACrC,gDAAgD,EAChD;QACE,GAAG,MAAM;QACT,MAAM,EAAE,OAAO;KAChB,CACF,CAAA;IAED,MAAM,CAAC,KAAK,CACV,SAAS,EACb;;;CAGC,CAAC,CAAA;AACF,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,16 +1,26 @@
 {
   "name": "@fun-foundry/prettier-config",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
-  "main": "dist/index.js",
+  "main": "dist/src/index.js",
   "exports": {
-    ".": "./dist/index.js"
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
   },
-  "types": "dist/index.d.ts",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "description": "Opinionated Prettier configuration maintained by fun-foundry.",
   "license": "MIT",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test": "npm run build && npm run test:run",
+    "test:run": "node --test dist/test/*.test.js"
   },
   "engines": {
     "node": ">=18.18.0"
@@ -24,9 +34,11 @@
   },
   "homepage": "https://github.com/fun-foundry/prettier-config#readme",
   "peerDependencies": {
-    "prettier": "^3.6.0"
+    "prettier": ">=3 <4"
   },
   "devDependencies": {
+    "@types/node": "^25.5.0",
+    "prettier": "^3.8.1",
     "typescript": "^5.9.0"
   }
 }

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-import type { Config } from 'prettier';
-declare const prettierConfig: Config;
-export default prettierConfig;
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,QAAA,MAAM,cAAc,EAAE,MAWrB,CAAA;AAED,eAAe,cAAc,CAAA"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,cAAc,GAAW;IAC7B,WAAW,EAAE,OAAO;IACpB,eAAe,EAAE,KAAK;IACtB,cAAc,EAAE,IAAI;IACpB,cAAc,EAAE,IAAI;IACpB,UAAU,EAAE,GAAG;IACf,IAAI,EAAE,KAAK;IACX,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,CAAC;IACX,aAAa,EAAE,MAAM;IACrB,OAAO,EAAE,KAAK;CACf,CAAA;AAED,eAAe,cAAc,CAAA"}

package/src/index.ts

@@ -1,16 +0,0 @@
-import type { Config } from 'prettier'
-
-const prettierConfig: Config = {
-  arrowParens: 'avoid',
-  bracketSameLine: false,
-  bracketSpacing: true,
-  jsxSingleQuote: true,
-  printWidth: 120,
-  semi: false,
-  singleQuote: true,
-  tabWidth: 2,
-  trailingComma: 'none',
-  useTabs: false
-}
-
-export default prettierConfig

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ES2022",
-    "moduleResolution": "Bundler",
-    "outDir": "dist",
-    "rootDir": "src",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["dist", "node_modules"]
-}