refactor!: migrate to ESM (#23)

Author: targos

.github/workflows/typedoc.yml

@@ -0,0 +1,13 @@
+name: TypeDoc
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  typedoc:
+    # Documentation: https://github.com/zakodium/workflows#typedoc
+    uses: zakodium/workflows/.github/workflows/typedoc.yml@typedoc-v1
+    secrets:
+      github-token: ${{ secrets.BOT_TOKEN }}

.prettierignore

@@ -0,0 +1 @@
+CHANGELOG.md

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "arrowParens": "always",
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all"
+}

.prettierrc.json

@@ -1,28 +1,32 @@
-# fast-bmp
-
 <h3 align="center">
-
   <a href="https://www.zakodium.com">
     <img src="https://www.zakodium.com/brand/zakodium-logo-white.svg" width="50" alt="Zakodium logo" />
   </a>
-
   <p>
     Maintained by <a href="https://www.zakodium.com">Zakodium</a>
   </p>
+</h3>
 
-[![NPM version][npm-image]][npm-url]
-[![Test coverage][codecov-image]][codecov-url]
-[![npm download][download-image]][download-url]
+# fast-bmp
 
-</h3>
+[![NPM version](https://img.shields.io/npm/v/fast-bmp.svg)](https://www.npmjs.com/package/fast-bmp)
+[![npm download](https://img.shields.io/npm/dm/fast-bmp.svg)](https://www.npmjs.com/package/fast-bmp)
+[![test coverage](https://img.shields.io/codecov/c/github/image-js/fast-bmp.svg)](https://codecov.io/gh/image-js/fast-bmp)
+[![license](https://img.shields.io/npm/l/fast-bmp.svg)](https://github.com/image-js/fast-bmp/blob/main/LICENSE)
 
-A library for encoding and decoding bmp image file format.
-References:
+A BMP image decoder and encoder.
 
-- [Wikipedia BMP format page](https://en.wikipedia.org/wiki/BMP_file_format)
-- [Microsoft BMPV5 format page](https://learn.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapv5header)
+## Installation
 
-# Supported features
+```console
+npm install fast-bmp
+```
+
+## API
+
+### [Complete API documentation](https://image-js.github.io/fast-bmp/)
+
+### Supported features
 
 This library only supports V5 headers.
 
@@ -31,9 +35,7 @@ This library only supports V5 headers.
 - RGB (24-bits per pixel)
 - RGBA (32-bits per pixel)
 
-# Usage
-
-## Encoding
+### Encoding
 
 ```js
 import { encode } from 'fast-bmp';
@@ -59,7 +61,7 @@ const encoded = encode(imageData);
 fs.writeFileSync('image.bmp', encoded);
 ```
 
-## Decoding
+### Decoding
 
 ```ts
 import { decode } from 'fast-bmp';
@@ -93,9 +95,11 @@ yPixelsPerMeter: 2835,
 */
 ```
 
-[npm-image]: https://img.shields.io/npm/v/fast-bmp.svg?style=flat-square
-[npm-url]: https://www.npmjs.com/package/fast-bmp
-[codecov-image]: https://img.shields.io/codecov/c/github/image-js/fast-bmp.svg?style=flat-square
-[codecov-url]: https://codecov.io/gh/image-js/fast-bmp
-[download-image]: https://img.shields.io/npm/dm/fast-bmp.svg?style=flat-square
-[download-url]: https://www.npmjs.com/package/fast-bmp
+## References
+
+- [Wikipedia BMP format page](https://en.wikipedia.org/wiki/BMP_file_format)
+- [Microsoft BMPV5 format page](https://learn.microsoft.com/en-us/windows/win32/api/wingdi/ns-wingdi-bitmapv5header)
+
+## License
+
+[MIT](./LICENSE)

README.md

@@ -0,0 +1,4 @@
+import { defineConfig, globalIgnores } from 'eslint/config';
+import cheminfo from 'eslint-config-cheminfo-typescript';
+
+export default defineConfig(globalIgnores(['coverage', 'lib']), cheminfo);

babel.config.js

@@ -1,48 +1,49 @@
 {
   "name": "fast-bmp",
   "version": "3.0.0",
-  "description": "A bmp image encoder",
-  "main": "./lib/index.js",
-  "module": "./lib-esm/index.js",
-  "types": "./lib/index.d.ts",
-  "repository": "[email protected]:image-js/fast-bmp.git",
-  "author": "Daniel Kostro <[email protected]>",
   "license": "MIT",
+  "description": "A BMP image decoder and encoder",
+  "author": "Daniel Kostro",
+  "type": "module",
+  "exports": "./lib/index.js",
   "files": [
-    "src",
     "lib",
-    "lib-esm"
+    "src"
   ],
+  "scripts": {
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf coverage lib",
+    "eslint": "eslint .",
+    "eslint-fix": "eslint --fix .",
+    "prepack": "npm run tsc",
+    "prettier": "prettier --check .",
+    "prettier-write": "prettier --write .",
+    "test": "npm run test-only && npm run check-types && npm run eslint && npm run prettier",
+    "test-only": "vitest run --coverage",
+    "test-write": "FAST_BMP_WRITE_DATA_FILES=1 npm run test-only",
+    "tsc": "npm run clean && npm run tsc-build",
+    "tsc-build": "tsc --project tsconfig.build.json"
+  },
   "dependencies": {
-    "iobuffer": "^5.4.0"
+    "iobuffer": "^6.0.0"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "^7.26.3",
-    "@babel/preset-typescript": "^7.26.0",
-    "@types/jest": "^29.5.14",
-    "eslint": "^9.21.0",
-    "eslint-config-cheminfo-typescript": "^17.0.0",
-    "jest": "^29.1.1",
-    "prettier": "^2.7.1",
+    "@types/node": "^24.0.1",
+    "@vitest/coverage-v8": "^3.2.3",
+    "@zakodium/tsconfig": "^1.0.1",
+    "eslint": "^9.29.0",
+    "eslint-config-cheminfo-typescript": "^18.0.1",
+    "prettier": "^3.5.3",
     "rimraf": "^6.0.1",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.3"
   },
-  "scripts": {
-    "eslint": "eslint src",
-    "eslint-fix": "eslint --fix src",
-    "prettier": "prettier --check src",
-    "prettier-write": "prettier --write src",
-    "test": "npm run test-only && npm run eslint && npm run prettier && npm run check-types",
-    "test-only": "jest --coverage",
-    "test-write": "FAST_BMP_WRITE_DATA_FILES=1 npm run test-only",
-    "check-types": "tsc --noEmit",
-    "clean": "rimraf lib lib-esm",
-    "prepack": "npm run tsc",
-    "tsc": "npm run clean && npm run tsc-cjs && npm run tsc-esm",
-    "tsc-cjs": "tsc --project tsconfig.cjs.json",
-    "tsc-esm": "tsc --project tsconfig.esm.json"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/image-js/fast-bmp.git"
+  },
+  "bugs": {
+    "url": "https://github.com/image-js/fast-bmp/issues"
   },
-  "jest": {
-    "testEnvironment": "node"
-  }
+  "homepage": "https://image-js.github.io/fast-bmp/"
 }

eslint.config.js

@@ -0,0 +1,2 @@
+__tests__
+.npmignore