@javalce/prettier-config 2.1.0 → 2.2.1

package/README.md

@@ -7,6 +7,7 @@ This is my personal Prettier configuration.
   - [Installation](#installation)
   - [Usage](#usage)
     - [Extending the shared configuration](#extending-the-shared-configuration)
+  - [TypeScript users:](#typescript-users)
 
 ## Features
 
@@ -27,7 +28,7 @@ The `prettier-plugin-packagejson` plugin is used to sort the keys of a `package.
 ## 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
 
@@ -40,36 +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
 
-This shared configuration is exported as a function that receives an optional object with the configuration to be merged with the shared configuration.
-
-The following example to configure Prettier with this shared configuration is using the `prettier.config.js` file using ES Modules, because recently, packages, like eslint, are moving its configuration files from `rc` files to `*.config.js` files.
+Since version 2.0.0, the configuration is implemented in TypeScript and the package exports both ESM and CommonJS formats.
 
-But you can still use the `.prettierrc.js` file if you prefer. Also, you can use CommonJS if you prefer.
+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 { defineConfig } from '@javalce/prettier-config';
+import prettierConfig from '@javalce/prettier-config';
 
-export default defineConfig();
+export default prettierConfig;
 ```
 
-### Extending the shared configuration
+You can also use `.prettierrc.js` or CommonJS if you prefer:
 
-If you want to extend the shared config or override some of its properties, you can pass an object to the `defineConfig` function.
+```js
+const prettierConfig = require('@javalce/prettier-config');
+module.exports = prettierConfig;
+```
 
-> [!IMPORTANT]
-> The `plugins` property is merged with the shared configuration, not replaced, so it will use the plugins from the shared configuration and the plugins you pass.
+### 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
-import { defineConfig } from '@javalce/prettier-config';
+import prettierConfig from '@javalce/prettier-config';
 
-export default defineConfig({
+export default {
+  ...prettierConfig,
   semi: false,
   plugins: [
-    // ...yourPlugins
+    ...prettierConfig.plugins,
+    // ...your plugins
   ],
-});
+};
+```
+
+## TypeScript users:
+
+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 {
+  // ...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
-});
+var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));let c=require(`prettier-plugin-packagejson`);c=s(c);var l={printWidth:100,tabWidth:2,useTabs:!1,endOfLine:`lf`,trailingComma:`all`,semi:!0,singleQuote:!0,jsxSingleQuote:!0,bracketSpacing:!0,arrowParens:`always`,plugins:[c.default]};module.exports=l;

package/dist/index.d.cts

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

package/dist/index.d.mts

@@ -0,0 +1,16 @@
+//#region src/index.d.ts
+declare const _default: {
+  printWidth: number;
+  tabWidth: number;
+  useTabs: false;
+  endOfLine: "lf";
+  trailingComma: "all";
+  semi: true;
+  singleQuote: true;
+  jsxSingleQuote: true;
+  bracketSpacing: true;
+  arrowParens: "always";
+  plugins: any[];
+};
+//#endregion
+export { _default as default };

package/dist/index.mjs

@@ -0,0 +1 @@
+import e from"prettier-plugin-packagejson";var t={printWidth:100,tabWidth:2,useTabs:!1,endOfLine:`lf`,trailingComma:`all`,semi:!0,singleQuote:!0,jsxSingleQuote:!0,bracketSpacing:!0,arrowParens:`always`,plugins:[e]};export{t as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@javalce/prettier-config",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Javier's Prettier configuration",
   "keywords": [
     "prettier"
@@ -20,8 +20,8 @@
     "./package.json": "./package.json",
     ".": {
       "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
       },
       "require": {
         "types": "./dist/index.d.cts",
@@ -36,19 +36,20 @@
     "*": "prettier -w --ignore-unknown"
   },
   "dependencies": {
-    "prettier-plugin-packagejson": "^2.5.7"
+    "prettier-plugin-packagejson": "^2.5.20"
   },
   "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.2",
+    "@commitlint/cli": "^20.3.1",
+    "@commitlint/config-conventional": "^20.3.1",
+    "@types/node": "^22.19.5",
+    "bumpp": "^10.3.2",
     "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.2.7",
+    "prettier": "^3.7.4",
+    "tsdown": "^0.19.0",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "prettier": ">=3.0.0 <4"
@@ -62,7 +63,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsup",
+    "build": "tsdown",
     "changelog": "conventional-changelog -i CHANGELOG.md -s -t v -p angular && git add CHANGELOG.md",
     "check-exports": "attw --pack .",
     "format": "prettier --write .",

package/dist/index.d.ts

@@ -1,5 +0,0 @@
-import { Config } from 'prettier';
-
-declare function defineConfig(config?: Config): Config;
-
-export { defineConfig };

package/dist/index.js

@@ -1,22 +0,0 @@
-// 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
-};