Setup bun and biome + bump dmv version (#227)

* Use bun

* CR Updates

* Bump version to 0.48.18

* Add biome and format code

* Fix build script

* Add lint and format

* Use bun latest

* Fix typo

Author: igoroctaviano

.github/workflows/publish.yml

@@ -8,11 +8,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: oven-sh/setup-bun@v2
         with:
-          node-version: "22.x"
-          registry-url: "https://registry.npmjs.org"
-      - run: yarn install --frozen-lockfile
+          bun-version: latest
+      - run: bun install --frozen-lockfile
       - run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_DMV_GRANULAR }}

.github/workflows/unit-tests.yml

@@ -10,23 +10,18 @@ jobs:
   build:
     name: Build and run tests
     runs-on: ubuntu-latest
-    
-    strategy:
-      matrix:
-        node-version: ["18.x", "24.x"]
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Node ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - name: Set up Bun (latest stable)
+        uses: oven-sh/setup-bun@v2
         with:
-          node-version: ${{ matrix.node-version }}
-          cache: "yarn"
+          bun-version: latest
       - name: Install dependencies
-        run: yarn
+        run: bun install --frozen-lockfile
       - name: Build package in production mode
-        run: yarn build
+        run: bun run build
       - name: Lint with standard
-        run: yarn lint
+        run: bun run lint
       - name: Test with jest
-        run: yarn test
+        run: bun run test

.gitignore

@@ -72,5 +72,4 @@ dist/
 .env.production.local
 *~
 *.swp
-bun.lock
 *workspace

.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+# Block commit if lint or format fails (biome check runs both)
+bun run lint

.travis.yml

@@ -4,7 +4,11 @@ node_js:
 
 sudo: false
 
+before_install:
+  - curl -fsSL https://bun.sh/install | bash
+  - export BUN_INSTALL="$HOME/.bun" && export PATH="$BUN_INSTALL/bin:$PATH"
+
 script:
-  - npm install
-  - npm run build
-  - npm test
+  - bun install --frozen-lockfile
+  - bun run build
+  - bun run test

CONTRIBUTING.md

@@ -14,11 +14,13 @@ Private functions shall be named with a leading underscore (e.g., `_myPrivateFun
 ## Coding style
 
 The library is implemented in JavaScript using the [6th Edition of the ECMAScript Language Specification (ES6)](https://262.ecma-international.org/6.0/) or later.
-Source code is linted using [standard](https://github.com/standard/standard) (based on [eslint](https://eslint.org/)).
+Source code is linted and formatted using [Biome](https://biomejs.dev/). Semicolons are not used at the end of statements (Biome uses `asNeeded`).
 
-Use the following command to identify potential coding style and type annotation violations:
+Use the following commands to check and fix style:
 
-    $ npm run lint
+    $ bun run lint        # check for issues
+    $ bun run lint:fix    # auto-fix issues
+    $ bun run fmt         # format code
 
 Docstrings are written in [JSDoc](https://jsdoc.app/) format:
 

README.md

@@ -113,10 +113,10 @@ Please cite the following article when using the viewer for scientific studies:
 
 ## Installation
 
-Install the [dicom-microscopy-viewer](https://www.npmjs.com/package/dicom-microscopy-viewer) package using the `npm` package manager:
+Install the [dicom-microscopy-viewer](https://www.npmjs.com/package/dicom-microscopy-viewer) package using the `bun` package manager:
 
 ```None
-npm install dicom-microscopy-viewer
+bun add dicom-microscopy-viewer
 ```
 
 ## Development & Testing
@@ -133,20 +133,20 @@ cd dicom-microscopy-viewer
 Install dependencies and build the package:
 
 ```None
-npm install
-npm run build
+bun install
+bun run build
 ```
 
 Run tests:
 
 ```None
-npm run test
+bun run test
 ```
 
 Build the API documentation:
 
 ```None
-npm run generateDocs
+bun run generateDocs
 ```
 
 ## Support

biome.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.3.13/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "includes": [
+      "src/**/*.js",
+      "config/**/*.js",
+      "!src/__mocks__",
+      "!src/annotations/_AnnotationManager.test.js",
+      "!src/annotations/markups/_MarkupManager.test.js",
+      "!src/dictionary.js",
+      "!src/**/*.test.js",
+      "!!dist",
+      "!!docs",
+      "!!build",
+      "!!test"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "javascript": {
+    "formatter": {
+      "semicolons": "asNeeded",
+      "quoteStyle": "single"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true
+    }
+  }
+}

bun.lock

@@ -3,13 +3,17 @@ const _ = require('lodash')
 // Merge two objects
 // Instead of merging array objects index by index (n-th source
 // item with n-th object item) it concatenates both arrays
-module.exports = function (object, source) {
+module.exports = (object, source) => {
   const clone = _.cloneDeep(object)
-  const merged = _.mergeWith(clone, source, function (objValue, srcValue, key, object, source, stack) {
-    if (objValue && srcValue && _.isArray(objValue) && _.isArray(srcValue)) {
-      return _.concat(objValue, srcValue)
-    }
-  })
+  const merged = _.mergeWith(
+    clone,
+    source,
+    (objValue, srcValue, _key, _object, _source, _stack) => {
+      if (objValue && srcValue && _.isArray(objValue) && _.isArray(srcValue)) {
+        return _.concat(objValue, srcValue)
+      }
+    },
+  )
 
   return merged
 }