@javalce/prettier-config 2.0.0 → 2.2.0

package/README.md

@@ -6,6 +6,8 @@ This is my personal Prettier configuration.
   - [Features](#features)
   - [Installation](#installation)
   - [Usage](#usage)
+    - [Extending the shared configuration](#extending-the-shared-configuration)
+  - [TypeScript users:](#typescript-users)
 
 ## Features
 
@@ -21,12 +23,12 @@ This is my personal Prettier configuration.
 - `arrowParens`: 'always'
 - `plugins`: ['prettier-plugin-packagejson']
 
-The `prettier-plugin-packagejson` plugin is used to sort the keys ofm a `package.json` file to keep them in a consistent order and make it easier to read.
+The `prettier-plugin-packagejson` plugin is used to sort the keys of a `package.json` file to keep them in a consistent order and make it easier to read.
 
 ## Installation
 
 > [!IMPORTANT]
-> Prettier is a peer-dependency of this package, and should be installed at the root of your project.
+> Prettier is a peer-dependency of this package and should be installed at the root of your project.
 >
 > See: https://prettier.io/docs/en/install.html
 
@@ -39,54 +41,54 @@ pnpm add --save-dev prettier @javalce/prettier-config
 
 # If you use yarn
 yarn add --dev prettier @javalce/prettier-config
+
+# If you use bun
+bun add --dev prettier @javalce/prettier-config
 ```
 
 ## Usage
 
-To use this config, set the following in `package.json`.
+Since version 2.0.0, the configuration is implemented in TypeScript and the package exports both ESM and CommonJS formats.
+
+It is recommended to use a `prettier.config.js` file with ESM syntax, as many tools (like ESLint) are moving from legacy `rc` files to `*.config.js` files for configuration. Example:
+
+```js
+import prettierConfig from '@javalce/prettier-config';
 
-```json
-{
-  "prettier": "@javalce/prettier-config"
-}
+export default prettierConfig;
 ```
 
-or create a `.prettierrc.cjs` file with the following content:
+You can also use `.prettierrc.js` or CommonJS if you prefer:
 
 ```js
 const prettierConfig = require('@javalce/prettier-config');
-
-module.exports = {
-  prettierConfig,
-};
+module.exports = prettierConfig;
 ```
 
-If you want to extend the shared config, you can do so by creating a `.prettierrc.cjs` file with the following content:
+### Extending the shared configuration
+
+If you want to extend the shared config or override some of its properties, you can import and modify the exported object:
 
 ```js
-const prettierConfig = require('@javalce/prettier-config');
+import prettierConfig from '@javalce/prettier-config';
 
-module.exports = {
+export default {
   ...prettierConfig,
-  // ...yourPrettierConfig
+  semi: false,
   plugins: [
     ...prettierConfig.plugins,
-    // ...yourPlugins
+    // ...your plugins
   ],
 };
 ```
 
-or by using ESM (`.prettierrc.mjs` or `prettierrc.js` if the `package.json` has `"type": "module"`):
+## TypeScript users:
 
-```js
-import prettierConfig from '@javalce/prettier-config';
+This package provides type definitions for the configuration. You can import the `Config` type from Prettier for full type safety in your custom config:
 
+```js
+/** @type {import('prettier').Config} */
 export default {
-  ...prettierConfig,
-  // ...yourPrettierConfig
-  plugins: [
-    ...prettierConfig.plugins,
-    // ...yourPlugins
-  ],
+  // ...your config
 };
 ```

package/dist/index.cjs

@@ -1,47 +1 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  defineConfig: () => defineConfig
-});
-module.exports = __toCommonJS(index_exports);
-function defineConfig(config) {
-  const { plugins = [], overrides = [], ...customConfig } = config ?? {};
-  return {
-    printWidth: 100,
-    tabWidth: 2,
-    useTabs: false,
-    endOfLine: "lf",
-    trailingComma: "all",
-    semi: true,
-    singleQuote: true,
-    jsxSingleQuote: true,
-    bracketSpacing: true,
-    arrowParens: "always",
-    ...customConfig,
-    plugins: ["prettier-plugin-packagejson", ...plugins],
-    overrides
-  };
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  defineConfig
-});
+"use strict";var a=Object.defineProperty;var s=Object.getOwnPropertyDescriptor;var l=Object.getOwnPropertyNames;var o=Object.prototype.hasOwnProperty;var p=(t,e)=>{for(var r in e)a(t,r,{get:e[r],enumerable:!0})},u=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of l(e))!o.call(t,i)&&i!==r&&a(t,i,{get:()=>e[i],enumerable:!(n=s(e,i))||n.enumerable});return t};var g=t=>u(a({},"__esModule",{value:!0}),t);var m={};p(m,{default:()=>f});module.exports=g(m);var f={printWidth:100,tabWidth:2,useTabs:!1,endOfLine:"lf",trailingComma:"all",semi:!0,singleQuote:!0,jsxSingleQuote:!0,bracketSpacing:!0,arrowParens:"always",plugins:["prettier-plugin-packagejson"]};

package/dist/index.d.cts

@@ -1,5 +1,15 @@
-import { Config } from 'prettier';
+declare const _default: {
+    printWidth: number;
+    tabWidth: number;
+    useTabs: false;
+    endOfLine: "lf";
+    trailingComma: "all";
+    semi: true;
+    singleQuote: true;
+    jsxSingleQuote: true;
+    bracketSpacing: true;
+    arrowParens: "always";
+    plugins: string[];
+};
 
-declare function defineConfig(config?: Config): Config;
-
-export { defineConfig };
+export = _default;

package/dist/index.d.ts

@@ -1,5 +1,15 @@
-import { Config } from 'prettier';
+declare const _default: {
+    printWidth: number;
+    tabWidth: number;
+    useTabs: false;
+    endOfLine: "lf";
+    trailingComma: "all";
+    semi: true;
+    singleQuote: true;
+    jsxSingleQuote: true;
+    bracketSpacing: true;
+    arrowParens: "always";
+    plugins: string[];
+};
 
-declare function defineConfig(config?: Config): Config;
-
-export { defineConfig };
+export { _default as default };

package/dist/index.js

@@ -1,22 +1 @@
-// src/index.ts
-function defineConfig(config) {
-  const { plugins = [], overrides = [], ...customConfig } = config ?? {};
-  return {
-    printWidth: 100,
-    tabWidth: 2,
-    useTabs: false,
-    endOfLine: "lf",
-    trailingComma: "all",
-    semi: true,
-    singleQuote: true,
-    jsxSingleQuote: true,
-    bracketSpacing: true,
-    arrowParens: "always",
-    ...customConfig,
-    plugins: ["prettier-plugin-packagejson", ...plugins],
-    overrides
-  };
-}
-export {
-  defineConfig
-};
+var i={printWidth:100,tabWidth:2,useTabs:!1,endOfLine:"lf",trailingComma:"all",semi:!0,singleQuote:!0,jsxSingleQuote:!0,bracketSpacing:!0,arrowParens:"always",plugins:["prettier-plugin-packagejson"]};export{i as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@javalce/prettier-config",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Javier's Prettier configuration",
   "keywords": [
     "prettier"
@@ -35,21 +35,20 @@
   "lint-staged": {
     "*": "prettier -w --ignore-unknown"
   },
-  "prettier": "./dist/index.js",
   "dependencies": {
-    "prettier-plugin-packagejson": "^2.5.7"
+    "prettier-plugin-packagejson": "^2.5.14"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.3",
-    "@commitlint/cli": "^19.6.1",
-    "@commitlint/config-conventional": "^19.6.0",
-    "bumpp": "^9.10.1",
+    "@arethetypeswrong/cli": "^0.18.1",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "bumpp": "^10.1.1",
     "conventional-changelog-cli": "^5.0.0",
     "husky": "^9.1.7",
-    "lint-staged": "^15.4.1",
-    "prettier": "^3.4.2",
-    "tsup": "^8.3.5",
-    "typescript": "^5.7.3"
+    "lint-staged": "^16.1.0",
+    "prettier": "^3.5.3",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "prettier": ">=3.0.0 <4"