dicom-microscopy-viewer - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "dicom-microscopy-viewer",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Web-based viewer for DICOM Visible Light Whole Slide Microscopy Images",
   "main": "build/dicom-microscopy-viewer.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "mochify",
+    "webdriver": "mochify --wd",
     "build": "rollup -c",
@@ -28,2 +29,5 @@ "watch": "rollup -c -w"
   "devDependencies": {
+    "chai": "^4.1.2",
+    "mocha": "^5.2.0",
+    "mochify": "^5.8.0",
     "rollup": "^0.63.2",
@@ -33,4 +37,3 @@ "rollup-plugin-commonjs": "8.3.0",
     "rollup-plugin-node-builtins": "^2.1.2",
-    "rollup-plugin-node-resolve": "^3.3.0",
-    "tape": "^4.9.1"
+    "rollup-plugin-node-resolve": "^3.3.0"
   },
@@ -37,0 +40,0 @@ "dependencies": {

README.md

@@ -1,2 +0,4 @@
-# dicom-microscopy-viewer
+[![Build Status](https://travis-ci.com/dcmjs-org/dicom-microscopy-viewer.svg?branch=master)](https://travis-ci.com/dcmjs-org/dicom-microscopy-viewer)
+
+# DICOM Microscopy Viewer
 Web-based viewer for [DICOM Visible Light Whole Slide Microscopy Images](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_A.32.8.html).
@@ -7,3 +9,3 @@
 
-The `dicom-microscopy-viewer` package can be installed via [npm](https://www.npmjs.com/):
+The [dicom-microscopy-viewer](https://www.npmjs.com/package/dicom-microscopy-viewer) package can be installed via `npm` package manager:
 
@@ -25,2 +27,13 @@ ```None
 
+## Test
+
+The library can be tested locally with [mochify](https://github.com/mantoni/mochify.js) (using [mocha](https://mochajs.org/) and [chai](http://www.chaijs.com/)):
+
+```None
+git clone https://github.com/dcmjs-org/dicom-microscopy-viewer ~/dicom-microscopy-viewer
+cd ~/dicom-microscopy-viewer
+npm install
+npm test
+```
+
 ## Usage
@@ -33,3 +46,3 @@
 const seriesInstanceUID = '1.2.3.5';
-const viewer = new DICOMMicroscopyViewer.api.MicroscopyViewer({
+const viewer = new DICOMMicroscopyViewer.api.DICOMMicroscopyViewer({
   client,
@@ -47,3 +60,3 @@ studyInstanceUID,
 The viewer allows visualization of *VL Whole Slide Microscopy Image* datasets stored in a [DICOMweb](https://www.dicomstandard.org/dicomweb/) compatible archive.
-It leverages [dicomweb-client](https://github.com/dcmjs-org/dicomweb-client) to retrieve data from the archive.
+It leverages the [dicomweb-client](https://github.com/dcmjs-org/dicomweb-client) JavaScript library to retrieve data from the archive.
 
@@ -54,3 +67,3 @@ ### Limitations
 
-* baseline JPEG with transfer syntax "1.2.840.10008.1.2.4.50"
+* baseline JPEG compressed data (transfer syntax "1.2.840.10008.1.2.4.50")
 * brightfield illumination (no fluorescence)
@@ -57,0 +70,0 @@ * 2D images (no z-stacks)

rollup.config.js

@@ -12,3 +12,3 @@ import builtins from 'rollup-plugin-node-builtins';
       format: 'umd',
-      name: 'MicroscopyViewer',
+      name: 'DICOMMicroscopyViewer',
       sourceMap: true
@@ -15,0 +15,0 @@ },

src/api.js

@@ -18,3 +18,3 @@ import WebGLMap from 'ol/WebGLMap';
 
-class MicroscopyViewer {
+class DICOMMicroscopyViewer {
 
@@ -410,2 +410,2 @@ /*
 
-export { MicroscopyViewer };
+export { DICOMMicroscopyViewer };

src/dicom-microscopy-viewer.js

@@ -1,7 +0,7 @@
-import { MicroscopyViewer } from './api.js';
+import { DICOMMicroscopyViewer } from './api.js';
 
 let api = {
-  MicroscopyViewer,
+  DICOMMicroscopyViewer,
 };
 
 export { api };

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25086310

increased by1415%

Number of package files

14

increased by55.56%

Lines of code

44275

increased by0.07%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

77

increased by20.31%

Worsened metrics

Dev dependency count

8

increased by33.33%

No dependency changes