ohif-core - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

package.json

 {
   "name": "ohif-core",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Useful functions and classes for building web-based medical imaging applications",
@@ -16,8 +16,10 @@ "author": "OHIF",
   "scripts": {
-    "test": "cross-env CI=1 react-scripts test --env=jsdom",
-    "test:watch": "react-scripts test --env=jsdom",
+    "cm": "npx git-cz",
     "build": "rollup -c",
-    "prepublishOnly": "npm run build",
+    "dev": "jest --watch",
     "start": "rollup -c -w",
-    "lint": "eslint -c .eslintrc --fix src && prettier --single-quote --write src/**/*.{js,jsx,json,css}"
+    "test": "jest",
+    "test:ci": "jest --ci --runInBand --collectCoverage --reporters=default --reporters=jest-junit && codecov",
+    "lint": "eslint -c .eslintrc --fix src && prettier --single-quote --write src/**/*.{js,jsx,json,css}",
+    "prepublishOnly": "npm run build"
   },
@@ -30,2 +32,12 @@ "peerDependencies": {
   },
+  "dependencies": {
+    "@babel/runtime": "^7.2.0",
+    "ajv": "^6.10.0",
+    "dicomweb-client": "^0.4.2",
+    "isomorphic-base64": "^1.0.2",
+    "jquery": "^3.3.1",
+    "lodash.clonedeep": "^4.5.0",
+    "lodash.merge": "^4.6.1",
+    "validate.js": "^0.12.0"
+  },
   "devDependencies": {
@@ -40,3 +52,7 @@ "@babel/core": "^7.2.0",
     "babel-eslint": "10.0.1",
+    "babel-jest": "^24.7.1",
+    "codecov": "^3.3.0",
+    "commitizen": "3.1.x",
     "cross-env": "^5.2.0",
+    "cz-conventional-changelog": "2.1.x",
     "eslint": "5.13.0",
@@ -47,2 +63,4 @@ "eslint-plugin-import": "^2.14.0",
     "husky": "^1.2.1",
+    "jest": "^24.7.1",
+    "jest-junit": "^6.3.0",
     "lint-staged": "^8.1.0",
@@ -58,2 +76,3 @@ "prettier": "^1.15.3",
     "rollup-plugin-url": "^2.1.0",
+    "semantic-release": "15.13.x",
     "stylelint": "^9.9.0",
@@ -83,13 +102,7 @@ "stylelint-config-recommended": "^2.1.0",
   ],
-  "dependencies": {
-    "@babel/runtime": "^7.2.0",
-    "ajv": "^6.10.0",
-    "dicomweb-client": "^0.4.2",
-    "isomorphic-base64": "^1.0.2",
-    "jquery": "^3.3.1",
-    "jquery.hotkeys": "^0.1.0",
-    "lodash.clonedeep": "^4.5.0",
-    "lodash.merge": "^4.6.1",
-    "validate.js": "^0.12.0"
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }

README.md

@@ -1,43 +0,166 @@
-# react-viewerbase
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<div align="center">
+  <h1>ohif-core</h1>
+  <p><strong>ohif-core</strong> is a collection of useful functions and classes for building web-based medical imaging applications. This library helps power OHIF's <a href="https://github.com/OHIF/Viewers">zero-footprint DICOM viewer</a>.</p>
+</div>
 
-> A set of React components for Medical Imaging Viewers.
+<hr />
 
-*Status: Under development*
+[![CircleCI][circleci-image]][circleci-url]
+[![codecov][codecov-image]][codecov-url]
+[![All Contributors][all-contributors-image]][contributing-url]
+[![code style: prettier][prettier-image]][prettier-url]
+[![semantic-release][semantic-image]][semantic-url]
 
-[![NPM](https://img.shields.io/npm/v/react-viewerbase.svg)](https://www.npmjs.com/package/react-viewerbase)
+[![NPM version][npm-version-image]][npm-url]
+[![NPM downloads][npm-downloads-image]][npm-url]
+[![MIT License][license-image]][license-url]
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
 
-## Install
+## Why?
 
-```bash
-npm install --save react-viewerbase
+This library offers pre-packaged solutions for features common to Web-based
+medical imaging viewers. For example:
+
+- Hotkeys
+- DICOM Web
+- Hanging Protocols
+- Managing a study's measurements
+- Managing a study's DICOM metadata
+- A flexible pattern for extensions
+- And many others
+
+It does this while remaining decoupled from any particular view library or
+rendering logic. While we use it to power our [React Viewer][react-viewer], it
+can be used with Vue, React, Vanilla JS, or any number of other frameworks.
+
+## Getting Started
+
+The documentation for this library is sparse. The best way to get started is to
+look at its
+[top level exports](https://github.com/OHIF/ohif-core/blob/master/src/index.js),
+and explore the source code of features that interest you. If you want to see
+how we use this library, you can check out [our viewer
+implementation][react-viewer].
+
+### Install
+
+> This library is pre- v1.0. All realeases until a v1.0 have the possibility of
+> introducing breaking changes. Please depend on an "exact" version in your
+> projects to prevent issues caused by loose versioning.
+
 ```
+// with npm
+npm i ohif-core --save-exact
 
-## Usage
+// with yarn
+yarn add ohif-core --exact
+```
 
-```jsx
-import React, { Component } from 'react'
+### Usage
 
-import CornerstoneViewport from 'react-viewerbase'
+Usage is dependent on the feature(s) you want to leverage. The bulk of
+`ohif-core`'s features are "pure" and can be imported and used in place.
 
-class Example extends Component {
-  render () {
-    return (
-      <CornerstoneViewport />
-    )
-  }
-}
+_Example: retrieving study metadata from a server_
+
+```js
+import { studies } from 'ohif-core'
+
+const studiesMetadata = await studies.retrieveStudiesMetadata(
+  server, // Object
+  studyInstanceUids, // Array
+  seriesInstanceUids // Array (optional)
+)
 ```
 
-## To run locally
+### Contributing
+
+It is notoriously difficult to setup multiple dependent repositories for
+end-to-end testing and development. That's why we recommend writing and running
+unit tests when adding and modifying features for this library. This allows us
+to program in isolation without a complex setup, and has the added benefit of
+producing well-tested business logic.
+
 1. Clone this repository
-1. `cd react-viewerbase`
-1. `yarn i`
-1. `yarn start`
-1. in new termainal
-1. `cd example`
-1. `yarn i`
-1. `yarn start`
+2. Navigate to the project directory, and `yarn install`
+3. To begin making changes, `yarn run dev`
+4. To commit changes, run `yarn run cm`
 
+When creating tests, place the test file "next to" the file you're testing.
+[For example](https://github.com/OHIF/ohif-core/blob/master/src/index.test.js):
+
+```js
+// File
+index.js
+
+// Test for file
+index.test.js
+```
+
+As you add and modify code, `jest` will watch for uncommitted changes and run
+your tests, reporting the results to your terminal. Make a pull request with
+your changes to `master`, and a core team member will review your work. If you
+have any questions, please don't hesitate to reach out via a GitHub issue.
+
+## Issues
+
+_Looking to contribute? Look for the [Good First Issue][good-first-issue]
+label._
+
+### 🐛 Bugs
+
+Please file an issue for bugs, missing documentation, or unexpected behavior.
+
+[**See Bugs**][bugs]
+
+### 💡 Feature Requests
+
+Please file an issue to suggest new features. Vote on feature requests by adding
+a 👍. This helps maintainers prioritize what to work on.
+
+[**See Feature Requests**][requests-feature]
+
+### ❓ Questions
+
+For questions related to using the library, please visit our support community,
+or file an issue on GitHub.
+
+[Google Group][google-group]
+
 ## License
 
 MIT © [OHIF](https://github.com/OHIF)
+
+<!--
+Links:
+-->
+
+<!-- prettier-ignore-start -->
+<!-- ROW -->
+[all-contributors-image]: https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square
+[contributing-url]: https://github.com/OHIF/ohif-core/blob/master/CONTRIBUTING.md
+[circleci-image]: https://circleci.com/gh/OHIF/ohif-core.svg?style=svg
+[circleci-url]: https://circleci.com/gh/OHIF/ohif-core
+[codecov-image]: https://codecov.io/gh/OHIF/ohif-core/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/OHIF/ohif-core
+[prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
+[prettier-url]: https://github.com/prettier/prettier
+[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+[semantic-url]: https://github.com/semantic-release/semantic-release
+<!-- ROW -->
+[npm-url]: https://npmjs.org/package/ohif-core
+[npm-downloads-image]: https://img.shields.io/npm/dm/ohif-core.svg?style=flat-square
+[npm-version-image]: https://img.shields.io/npm/v/ohif-core.svg?style=flat-square
+[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
+[license-url]: LICENSE
+<!-- Misc. -->
+[react-viewer]: https://github.com/OHIF/Viewers/tree/react
+<!-- Issue Boilerplate -->
+[bugs]: https://github.com/OHIF/ohif-core/labels/bug
+[requests-feature]: https://github.com/OHIF/ohif-core/labels/enhancement
+[good-first-issue]: https://github.com/OHIF/ohif-core/labels/good%20first%20issue
+[google-group]: https://groups.google.com/forum/#!forum/cornerstone-platform
+<!-- prettier-ignore-end -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dependency count

12

decreased by-7.69%

Number of lines in readme file

167

increased by279.55%

Worsened metrics

Total package byte prevSize

7314897

decreased by-25.4%

Dev dependency count

34

increased by25.93%

Number of package files

7

decreased by-22.22%

Lines of code

71738

decreased by-26.4%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removedjquery.hotkeys@^0.1.0

• - Removedjquery.hotkeys@0.1.0(transitive)