Skip to content

Commit c798ed8

Browse files
cmdcolincmdcolin
committed
Fix tests
Updates
1 parent cfc09a0 commit c798ed8

9 files changed

Lines changed: 5721 additions & 4878 deletions

‎.prettierignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
test/data
2+
pnpm-lock.yaml

‎README.md‎

Lines changed: 56 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Read legacy JBrowse 1 nested containment list JSON.
66

77
[![Build Status](https://img.shields.io/github/actions/workflow/status/GMOD/nclist-js/push.yml?branch=master)](https://github.com/GMOD/nclist-js/actions)
88
[![Coverage Status](https://img.shields.io/codecov/c/github/GMOD/nclist-js/master.svg?style=flat-square)](https://codecov.io/gh/GMOD/nclist-js/branch/master)
9-
[![NPM version](https://img.shields.io/npm/v/@gmod/nclist.svg?logo=npm\&style=flat-square)](https://npmjs.org/package/@gmod/nclist)
9+
[![NPM version](https://img.shields.io/npm/v/@gmod/nclist.svg?logo=npm&style=flat-square)](https://npmjs.org/package/@gmod/nclist)
1010

1111
## Usage
1212

@@ -40,45 +40,63 @@ import NCList from '@gmod/nclist'
4040

4141
#### Table of Contents
4242

43-
* [NCListStore](#ncliststore)
44-
* [Parameters](#parameters)
45-
* [getRegionFeatureDensities](#getregionfeaturedensities)
46-
* [Parameters](#parameters-1)
47-
* [getFeatures](#getfeatures)
48-
* [Parameters](#parameters-2)
43+
- [NCListStore](#ncliststore)
44+
- [Parameters](#parameters)
45+
- [getRegionFeatureDensities](#getregionfeaturedensities)
46+
- [Parameters](#parameters-1)
47+
- [getFeatures](#getfeatures)
48+
- [Parameters](#parameters-2)
4949

5050
### NCListStore
5151

52-
Sequence feature store using nested containment
53-
lists held in JSON files that are lazily read.
52+
Sequence feature store using nested containment lists held in JSON files that
53+
are lazily read.
5454

5555
#### Parameters
5656

57-
* `args` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** constructor args
58-
59-
* `args.baseUrl` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base URL for resolving relative URLs
60-
* `args.urlTemplate` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Template string for
61-
the root file of each reference sequence. The reference sequence
62-
name will be interpolated into this string where `{refseq}` appears.
63-
* `args.readFile` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** function to use for reading remote from URLs.
64-
* `args.cacheSize` (optional, default `10`)
57+
- `args`
58+
**[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
59+
constructor args
60+
- `args.baseUrl`
61+
**[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
62+
base URL for resolving relative URLs
63+
- `args.urlTemplate`
64+
**[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
65+
Template string for the root file of each reference sequence. The reference
66+
sequence name will be interpolated into this string where `{refseq}`
67+
appears.
68+
- `args.readFile`
69+
**[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**
70+
function to use for reading remote from URLs.
71+
- `args.cacheSize` (optional, default `10`)
6572

6673
#### getRegionFeatureDensities
6774

6875
fetch binned counts of feature coverage in the given region.
6976

7077
##### Parameters
7178

72-
* `query` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
73-
74-
* `query.refName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** reference sequence name
75-
* `query.start` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** region start
76-
* `query.end` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** region end
77-
* `query.numBins` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** number of bins desired in the feature counts
78-
* `query.basesPerBin` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** number of bp desired in each feature counting bin
79-
80-
Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** as:
81-
`{ bins: hist, stats: statEntry }`
79+
- `query`
80+
**[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
81+
- `query.refName`
82+
**[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
83+
reference sequence name
84+
- `query.start`
85+
**[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
86+
region start
87+
- `query.end`
88+
**[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
89+
region end
90+
- `query.numBins`
91+
**[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
92+
number of bins desired in the feature counts
93+
- `query.basesPerBin`
94+
**[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
95+
number of bp desired in each feature counting bin
96+
97+
Returns
98+
**[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
99+
as: `{ bins: hist, stats: statEntry }`
82100

83101
#### getFeatures
84102

@@ -87,8 +105,14 @@ yielding feature objects.
87105

88106
##### Parameters
89107

90-
* `args` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
91-
92-
* `args.refName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** reference sequence name
93-
* `args.start` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** start of region. 0-based half-open.
94-
* `args.end` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** end of region. 0-based half-open.
108+
- `args`
109+
**[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
110+
- `args.refName`
111+
**[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
112+
reference sequence name
113+
- `args.start`
114+
**[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
115+
start of region. 0-based half-open.
116+
- `args.end`
117+
**[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
118+
end of region. 0-based half-open.

‎eslint.config.mjs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ export default defineConfig(
1212
'esm/*',
1313
'example/*',
1414
'eslint.config.mjs',
15+
'vitest.config.ts',
1516
],
1617
},
1718
{

‎package.json‎

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@
1212
"require": "./dist/index.js"
1313
}
1414
},
15-
"repository": "github:GMOD/nclist-js",
15+
"repository": {
16+
"type": "git",
17+
"url": "https://github.com/GMOD/nclist-js.git"
18+
},
1619
"author": {
1720
"name": "Robert Buels",
1821
"email": "rbuels@gmail.com",
@@ -28,42 +31,41 @@
2831
"esm",
2932
"src"
3033
],
31-
"engines": {
32-
"node": ">=8"
33-
},
3434
"scripts": {
35+
"format": "prettier --write .",
3536
"test": "vitest",
3637
"coverage": "yarn test --coverage",
3738
"lint": "eslint --report-unused-disable-directives --max-warnings 0",
3839
"docs": "documentation readme --shallow src/feature_store.ts --section API",
3940
"clean": "rimraf dist esm",
4041
"prebuild": "yarn docs && yarn clean && yarn lint",
4142
"build:esm": "tsc --outDir esm",
42-
"build:es5": "tsc --module commonjs --outDir dist",
43+
"build:es5": "tsc --module commonjs --moduleResolution bundler --outDir dist",
4344
"postbuild:es5": "echo '{\"type\": \"commonjs\"}' > dist/package.json",
4445
"build": "yarn build:esm && yarn build:es5",
4546
"prepublishOnly": "yarn test --run && yarn build",
4647
"postversion": "git push --follow-tags"
4748
},
4849
"devDependencies": {
49-
"@types/express": "^5.0.5",
50-
"@vitest/coverage-v8": "^4.0.6",
50+
"@eslint/js": "^10.0.1",
51+
"@types/express": "^5.0.6",
52+
"@vitest/coverage-v8": "^4.1.2",
5153
"cross-fetch": "^4.1.0",
52-
"documentation": "^14.0.1",
53-
"eslint": "^9.5.0",
54-
"eslint-plugin-import": "^2.31.0",
55-
"eslint-plugin-unicorn": "^62.0.0",
56-
"express": "^5.1.0",
57-
"generic-filehandle2": "^2.0.1",
58-
"get-port": "^7.1.0",
59-
"prettier": "^3.5.3",
60-
"rimraf": "^6.0.1",
61-
"typescript": "^5.0.4",
62-
"typescript-eslint": "^8.18.0",
63-
"vitest": "^4.0.6"
54+
"documentation": "^14.0.3",
55+
"eslint": "^9.39.4",
56+
"eslint-plugin-import": "^2.32.0",
57+
"eslint-plugin-unicorn": "^64.0.0",
58+
"express": "^5.2.1",
59+
"generic-filehandle2": "^2.1.4",
60+
"get-port": "^7.2.0",
61+
"prettier": "^3.8.1",
62+
"rimraf": "^6.1.3",
63+
"typescript": "^6.0.2",
64+
"typescript-eslint": "^8.58.0",
65+
"vitest": "^4.1.2"
6466
},
6567
"dependencies": {
66-
"@gmod/abortable-promise-cache": "^3.0.1",
68+
"@gmod/abortable-promise-cache": "^3.0.4",
6769
"@jbrowse/quick-lru": "^7.3.5",
6870
"@jridgewell/resolve-uri": "^3.1.2"
6971
},

0 commit comments

Comments
 (0)