Micro-optimizations

README.md

@@ -65,8 +65,8 @@ so let us know if it doesn't work for your use case
 
 The BAM class constructor accepts arguments
 
-- `bamPath`/`bamUrl`/`bamFilehandle` - a string file path to a local file or a
-  class object with a read method
+- `bamPath`/`bamUrl`/`bamFilehandle` - a local file path, remote URL string, or
+  a class object with a read method
 - `csiPath`/`csiUrl`/`csiFilehandle` - a CSI index for the BAM file, required
   for long chromosomes greater than 2^29 in length
 - `baiPath`/`baiUrl`/`baiFilehandle` - a BAI index for the BAM file
@@ -112,8 +112,8 @@ density across 16kb windows in the genome
 - `refName` - a string for the chrom to fetch from
 
 Returns number of features on refName, uses special pseudo-bin from the BAI/CSI
-index (e.g. bin 37450 from bai, returning n_mapped from SAM spec pdf) or -1 if
-refName not exist in sample
+index (e.g. bin 37450 from bai, returning n_mapped from SAM spec pdf) or 0 if
+refName does not exist in the sample
 
 ### async hasRefSeq(refName: string)
 
@@ -201,3 +201,12 @@ console.log(records[0].getDoubleStart())
 ## License
 
 MIT © [Colin Diesh](https://github.com/cmdcolin)
+
+## Publishing
+
+[Trusted publishing](https://docs.npmjs.com/about-trusted-publishing) via GitHub
+Actions.
+
+```bash
+npm version patch  # or minor/major
+```

eslint.config.mjs

@@ -1,12 +1,13 @@
 import eslint from '@eslint/js'
 import { defineConfig } from 'eslint/config'
-import importPlugin from 'eslint-plugin-import'
+import importPlugin from 'eslint-plugin-import-x'
 import eslintPluginUnicorn from 'eslint-plugin-unicorn'
 import tseslint from 'typescript-eslint'
 
 export default defineConfig(
   {
     ignores: [
+      'scripts',
       'webpack.config.js',
       'benchmarks/*',
       'dist/*',
@@ -119,9 +120,9 @@ export default defineConfig(
         },
       ],
 
-      'import/extensions': ['error', 'ignorePackages'],
-      'import/no-unresolved': 'off',
-      'import/order': [
+      'import-x/extensions': ['error', 'ignorePackages'],
+      'import-x/no-unresolved': 'off',
+      'import-x/order': [
         'error',
         {
           named: true,

package.json

@@ -8,12 +8,10 @@
     "url": "https://github.com/GMOD/bam-js.git"
   },
   "type": "module",
-  "types": "./esm/index.d.ts",
+  "main": "dist/index.js",
   "exports": {
-    ".": {
-      "import": "./esm/index.js",
-      "require": "./dist/index.js"
-    }
+    "import": "./esm/index.js",
+    "require": "./dist/index.js"
   },
   "author": {
     "name": "Colin Diesh",
@@ -27,19 +25,19 @@
   ],
   "scripts": {
     "test": "vitest",
-    "benchonly": "vitest bench",
-    "bench": "./scripts/build-both-branches.sh \"$BRANCH1\" \"$BRANCH2\" && vitest bench",
-    "lint": "eslint --report-unused-disable-directives --max-warnings 0",
     "clean": "rimraf dist esm",
     "format": "prettier --write .",
+    "lint": "eslint --report-unused-disable-directives --max-warnings 0",
+    "prebuild": "pnpm clean",
     "build:esm": "tsc --outDir esm",
     "build:es5": "tsc --module commonjs --moduleResolution bundler --outDir dist",
-    "build": "pnpm build:esm && pnpm build:es5",
-    "prebuild": "pnpm clean",
     "postbuild:es5": "echo '{\"type\": \"commonjs\"}' > dist/package.json",
     "preversion": "pnpm lint && pnpm test --run && pnpm build",
-    "version": "standard-changelog && git add CHANGELOG.md",
-    "postversion": "git push --follow-tags"
+    "postversion": "git push --follow-tags",
+    "build": "pnpm build:esm && pnpm build:es5",
+    "benchonly": "vitest bench",
+    "bench": "./scripts/build-both-branches.sh \"$BRANCH1\" \"$BRANCH2\" && vitest bench",
+    "version": "standard-changelog && git add CHANGELOG.md"
   },
   "keywords": [
     "bionode",
@@ -58,7 +56,7 @@
     "@types/node": "^25.6.0",
     "@vitest/coverage-v8": "^4.1.5",
     "eslint": "^10.2.1",
-    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-import-x": "^4.16.2",
     "eslint-plugin-unicorn": "^64.0.0",
     "prettier": "^3.8.3",
     "rimraf": "^6.1.3",