properties-file 3.7.0 → 4.0.0

package/README.md

@@ -6,7 +6,7 @@
 [![Package Size](https://deno.bundlejs.com/badge?q=properties-file@latest&treeshake=[*])](https://bundlejs.com/?q=properties-file@latest&treeshake=[*])
 ![Dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)
 
-`.properties` file parser, editor, formatter and Webpack loader.
+`.properties` file parser, editor, formatter and bundler integrations.
 
 ## Installation 💻
 
@@ -27,7 +27,7 @@ npm install properties-file
   - A `Properties` class provides insights into parsing data.
   - A `PropertiesEditor` class enables the addition, edition, and removal of entries.
   - `escapeKey` and `escapeValue` allow the conversion of any content to a `.properties` compatible format.
-  - The library also includes a Webpack loader to import `.properties` files directly into your application.
+  - Bundler integrations for Webpack, Rollup/Vite, esbuild, and Bun to import `.properties` files directly. See [BUNDLER.md](./BUNDLER.md).
 - [Tiny](https://bundlejs.com/?q=properties-file%40latest&treeshake=%5B*%5D) with 0 dependencies.
 - 100% test coverage based on the output from a Java implementation.
 - Active maintenance (many popular `.properties` packages have been inactive for years).
@@ -189,40 +189,11 @@ console.log(properties.format())
 
 For convenience, we also added an `upsert` method that allows updating a key if it exists or adding it at the end, when it doesn't. Make sure to check in your IDE for all available methods and options in our TSDoc.
 
-### Webpack File Loader
+### Bundler Integrations
 
-If you would like to import `.properties` directly using `import`, this package comes with its own Webpack file loader located under `properties-file/webpack-loader`. Here is an example of how to configure it:
+If you would like to import `.properties` directly using `import`, this package provides integrations for all major bundlers: **Webpack/Rspack**, **Rollup/Vite/Rolldown**, **esbuild**, and **Bun**.
 
-```js
-// webpack.config.js
-module.exports = {
-  module: {
-    rules: [
-      {
-        test: /\.properties$/i,
-        use: [
-          {
-            loader: 'properties-file/webpack-loader',
-          },
-        ],
-      },
-    ],
-  },
-}
-```
-
-As soon as you configure Webpack, the `.properties` type should be available in your IDE when using `import`. If you ever need to add it manually, you can add a `*.properties` type declaration file at the root of your application, like this:
-
-```ts
-declare module '*.properties' {
-  /** A key/value object representing the content of a `.properties` file. */
-  const properties: {
-    /** The value of a `.properties` file key. */
-    [key: string]: string
-  }
-  export { properties }
-}
-```
+See [BUNDLER.md](./BUNDLER.md) for setup instructions and examples.
 
 By adding these configurations you should now be able to import directly `.properties` files just like this:
 

package/dist/cjs/bundler/bun.d.ts

@@ -0,0 +1,10 @@
+import type { BunPlugin } from 'bun';
+/**
+ * Bun plugin for `.properties` files. Works with both `Bun.plugin` (runtime) and `Bun.build`
+ * (build-time).
+ */
+declare const bunPlugin: BunPlugin;
+export default bunPlugin;
+
+// Enables type recognition for direct `.properties` file imports.
+import '../properties-file.d.ts'

package/dist/cjs/bundler/bun.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var node_fs_1=require("node:fs"),__1=require(".."),bunPlugin={name:"properties-file",setup:function(e){e.onLoad({filter:/\.properties$/},function(e){var r=e.path;return{exports:{properties:(0,__1.getProperties)((0,node_fs_1.readFileSync)(r,"utf8"))},loader:"object"}})}};exports.default=bunPlugin;

package/dist/cjs/bundler/esbuild.d.ts

@@ -0,0 +1,11 @@
+import type { Plugin } from 'esbuild';
+/**
+ * esbuild plugin for `.properties` files.
+ *
+ * @returns An esbuild plugin that transforms `.properties` imports into JavaScript modules.
+ */
+declare const esbuildPlugin: () => Plugin;
+export default esbuildPlugin;
+
+// Enables type recognition for direct `.properties` file imports.
+import '../properties-file.d.ts'

package/dist/cjs/bundler/esbuild.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var node_fs_1=require("node:fs"),__1=require(".."),esbuildPlugin=function(){return{name:"properties-file",setup:function(e){e.onLoad({filter:/\.properties$/},function(e){var r=e.path;return{contents:"export const properties = ".concat(JSON.stringify((0,__1.getProperties)((0,node_fs_1.readFileSync)(r,"utf8"))),";"),loader:"js"}})}}};exports.default=esbuildPlugin;

package/dist/cjs/bundler/rollup.d.ts

@@ -0,0 +1,11 @@
+import type { Plugin } from 'rollup';
+/**
+ * Rollup plugin for `.properties` files. Also compatible with Vite and Rolldown.
+ *
+ * @returns A Rollup plugin that transforms `.properties` imports into JavaScript modules.
+ */
+declare const rollupPlugin: () => Plugin;
+export default rollupPlugin;
+
+// Enables type recognition for direct `.properties` file imports.
+import '../properties-file.d.ts'

package/dist/cjs/bundler/rollup.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var __1=require(".."),PROPERTIES_EXTENSION=".properties",rollupPlugin=function(){return{name:"properties-file",transform:function(e,r){return-1===r.indexOf(PROPERTIES_EXTENSION,r.length-PROPERTIES_EXTENSION.length)?null:{code:"export const properties = ".concat(JSON.stringify((0,__1.getProperties)(e)),";"),map:null}}}};exports.default=rollupPlugin;

package/dist/cjs/bundler/webpack.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Webpack file loader for `.properties` files. Also compatible with Rspack.
+ *
+ * @param content - The content of a `.properties` file.
+ *
+ * @returns A CommonJS module string exporting the parsed key-value pairs.
+ */
+declare const webpackLoader: (content: string) => string;
+export default webpackLoader;
+
+// Enables type recognition for direct `.properties` file imports.
+import '../properties-file.d.ts'

package/dist/esm/bundler/bun.d.ts

@@ -0,0 +1,10 @@
+import type { BunPlugin } from 'bun';
+/**
+ * Bun plugin for `.properties` files. Works with both `Bun.plugin` (runtime) and `Bun.build`
+ * (build-time).
+ */
+declare const bunPlugin: BunPlugin;
+export default bunPlugin;
+
+// Enables type recognition for direct `.properties` file imports.
+import '../properties-file.d.ts'

package/dist/esm/bundler/bun.js

@@ -0,0 +1 @@
+import{readFileSync}from"node:fs";import{getProperties}from"../index.js";var bunPlugin={name:"properties-file",setup:function(e){e.onLoad({filter:/\.properties$/},function(e){var r=e.path;return{exports:{properties:getProperties(readFileSync(r,"utf8"))},loader:"object"}})}};export default bunPlugin;

package/dist/esm/bundler/esbuild.d.ts

@@ -0,0 +1,11 @@
+import type { Plugin } from 'esbuild';
+/**
+ * esbuild plugin for `.properties` files.
+ *
+ * @returns An esbuild plugin that transforms `.properties` imports into JavaScript modules.
+ */
+declare const esbuildPlugin: () => Plugin;
+export default esbuildPlugin;
+
+// Enables type recognition for direct `.properties` file imports.
+import '../properties-file.d.ts'

package/dist/esm/bundler/esbuild.js

@@ -0,0 +1 @@
+import{readFileSync}from"node:fs";import{getProperties}from"../index.js";var esbuildPlugin=function(){return{name:"properties-file",setup:function(e){e.onLoad({filter:/\.properties$/},function(e){var r=e.path;return{contents:"export const properties = ".concat(JSON.stringify(getProperties(readFileSync(r,"utf8"))),";"),loader:"js"}})}}};export default esbuildPlugin;

package/dist/esm/bundler/rollup.d.ts

@@ -0,0 +1,11 @@
+import type { Plugin } from 'rollup';
+/**
+ * Rollup plugin for `.properties` files. Also compatible with Vite and Rolldown.
+ *
+ * @returns A Rollup plugin that transforms `.properties` imports into JavaScript modules.
+ */
+declare const rollupPlugin: () => Plugin;
+export default rollupPlugin;
+
+// Enables type recognition for direct `.properties` file imports.
+import '../properties-file.d.ts'

package/dist/esm/bundler/rollup.js

@@ -0,0 +1 @@
+import{getProperties}from"../index.js";var PROPERTIES_EXTENSION=".properties",rollupPlugin=function(){return{name:"properties-file",transform:function(e,r){return-1===r.indexOf(PROPERTIES_EXTENSION,r.length-PROPERTIES_EXTENSION.length)?null:{code:"export const properties = ".concat(JSON.stringify(getProperties(e)),";"),map:null}}}};export default rollupPlugin;

package/dist/esm/bundler/webpack.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Webpack file loader for `.properties` files. Also compatible with Rspack.
+ *
+ * @param content - The content of a `.properties` file.
+ *
+ * @returns A CommonJS module string exporting the parsed key-value pairs.
+ */
+declare const webpackLoader: (content: string) => string;
+export default webpackLoader;
+
+// Enables type recognition for direct `.properties` file imports.
+import '../properties-file.d.ts'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "properties-file",
-  "version": "3.7.0",
-  "description": ".properties file parser, editor, formatter and Webpack loader.",
+  "version": "4.0.0",
+  "description": ".properties file parser, editor, formatter and bundler integrations.",
   "keywords": [
     ".properties",
     "properties",
@@ -13,8 +13,11 @@
     "Java",
     "intl",
     "i18n",
-    "properties Webpack loader",
     "Webpack loader",
+    "Rollup plugin",
+    "Vite plugin",
+    "esbuild plugin",
+    "Bun plugin",
     "internationalization"
   ],
   "repository": {
@@ -36,6 +39,46 @@
         "default": "./dist/cjs/index.js"
       }
     },
+    "./bundler/bun": {
+      "import": {
+        "types": "./dist/esm/bundler/bun.d.ts",
+        "default": "./dist/esm/bundler/bun.js"
+      },
+      "require": {
+        "types": "./dist/cjs/bundler/bun.d.ts",
+        "default": "./dist/cjs/bundler/bun.js"
+      }
+    },
+    "./bundler/esbuild": {
+      "import": {
+        "types": "./dist/esm/bundler/esbuild.d.ts",
+        "default": "./dist/esm/bundler/esbuild.js"
+      },
+      "require": {
+        "types": "./dist/cjs/bundler/esbuild.d.ts",
+        "default": "./dist/cjs/bundler/esbuild.js"
+      }
+    },
+    "./bundler/rollup": {
+      "import": {
+        "types": "./dist/esm/bundler/rollup.d.ts",
+        "default": "./dist/esm/bundler/rollup.js"
+      },
+      "require": {
+        "types": "./dist/cjs/bundler/rollup.d.ts",
+        "default": "./dist/cjs/bundler/rollup.js"
+      }
+    },
+    "./bundler/webpack": {
+      "import": {
+        "types": "./dist/esm/bundler/webpack.d.ts",
+        "default": "./dist/esm/bundler/webpack.js"
+      },
+      "require": {
+        "types": "./dist/cjs/bundler/webpack.d.ts",
+        "default": "./dist/cjs/bundler/webpack.js"
+      }
+    },
     "./editor": {
       "import": {
         "types": "./dist/esm/editor/index.d.ts",
@@ -65,16 +108,6 @@
         "types": "./dist/cjs/unescape/index.d.ts",
         "default": "./dist/cjs/unescape/index.js"
       }
-    },
-    "./webpack-loader": {
-      "import": {
-        "types": "./dist/esm/loader/webpack.d.ts",
-        "default": "./dist/esm/loader/webpack.js"
-      },
-      "require": {
-        "types": "./dist/cjs/loader/webpack.d.ts",
-        "default": "./dist/cjs/loader/webpack.js"
-      }
     }
   },
   "main": "dist/cjs/index.js",
@@ -85,6 +118,8 @@
   ],
   "scripts": {
     "add-file-type-declaration": "node ./dist/esm/add-import-type.js && find ./dist -name 'add-import-type.*' -type f -delete",
+    "benchmark": "npx tsx benchmarks/run.ts",
+    "benchmark-compare": "npx tsx benchmarks/compare.ts",
     "build": "npm run check-nvm-node-version && npm run prettier-write && npm run eslint-fix && rm -Rf ./dist && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && echo '{ \"type\": \"commonjs\" }' > dist/cjs/package.json && tsc -p src/build-scripts/tsconfig.json && node dist/build-scripts/build.js && npm run test",
     "check-nvm-node-version": "check-node-version --node $(node -p \"'>='+require('fs').readFileSync('.nvmrc','utf-8').trim()\")",
     "depcheck": "depcheck",
@@ -98,15 +133,17 @@
   },
   "devDependencies": {
     "@release-it/conventional-changelog": "10.0.6",
+    "@types/bun": "1.3.11",
     "@types/jest": "30.0.0",
     "@types/node": "25.5.0",
     "check-node-version": "4.2.1",
     "depcheck": "1.4.7",
     "dotenv-cli": "11.0.0",
-    "eslint": "10.0.3",
+    "esbuild": "0.27.4",
+    "eslint": "10.1.0",
     "eslint-config-prettier": "10.1.8",
     "eslint-import-resolver-typescript": "4.4.4",
-    "eslint-plugin-es-x": "9.5.0",
+    "eslint-plugin-es-x": "9.6.0",
     "eslint-plugin-import-x": "4.16.2",
     "eslint-plugin-jest": "29.15.0",
     "eslint-plugin-package-json": "0.91.0",
@@ -118,14 +155,16 @@
     "jest": "30.3.0",
     "jiti": "2.6.1",
     "jsonc-eslint-parser": "3.1.0",
-    "npm-check-updates": "19.6.3",
+    "npm-check-updates": "19.6.5",
     "prettier": "3.8.1",
     "prettier-plugin-organize-imports": "4.3.0",
     "release-it": "19.2.4",
-    "terser": "5.46.0",
+    "rollup": "4.60.0",
+    "terser": "5.46.1",
+    "tinybench": "6.0.0",
     "ts-jest": "29.4.6",
     "typescript": "5.9.3",
-    "typescript-eslint": "8.57.0"
+    "typescript-eslint": "8.57.1"
   },
   "engines": {
     "node": "*"

package/dist/cjs/loader/webpack.d.ts

@@ -1,12 +0,0 @@
-/**
- * Webpack file loader for `.properties` files.
- *
- * @param content - the content of a `.properties` file.
- *
- * @returns A Webpack file loader string containing the content of  a `.properties` file.
- */
-declare const webpackLoader: (content: string) => string;
-export default webpackLoader;
-
-// Enables type recognition for direct `.properties` file imports.
-import '../properties-file.d.ts'

package/dist/esm/loader/webpack.d.ts

@@ -1,12 +0,0 @@
-/**
- * Webpack file loader for `.properties` files.
- *
- * @param content - the content of a `.properties` file.
- *
- * @returns A Webpack file loader string containing the content of  a `.properties` file.
- */
-declare const webpackLoader: (content: string) => string;
-export default webpackLoader;
-
-// Enables type recognition for direct `.properties` file imports.
-import '../properties-file.d.ts'