bruker-data-test - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

CHANGELOG.md

@@ -0,1 +1,14 @@
+# Changelog
+
+## [0.2.0](https://www.github.com/cheminfo/bruker-data-test/compare/v0.1.0...v0.2.0) (2022-02-26)
+
+
+### ⚠ BREAKING CHANGES
+
+* returns FileList
+
+### Code Refactoring
+
+* returns FileList ([bb94782](https://www.github.com/cheminfo/bruker-data-test/commit/bb9478262aa3513b64b661ddb2f2697ad86463e6))
+
 ## 0.1.0 (2021-03-18)
@@ -13,2 +26,1 @@
 * **index:** read files as base64 and add gitignore ([22b5180](https://github.com/cheminfo/bruker-data-test/commit/22b5180744f2d0ebff91dd996204039606efb657))
-

package.json

 {
   "name": "bruker-data-test",
-  "version": "0.1.0",
-  "description": "provides zipped bruker NMR data files for testing purposes",
-  "keywords": [
-    "magnetic resonance",
-    "nmr",
-    "bruker",
-    "dataset"
-  ],
-  "main": "index.js",
+  "version": "0.2.0",
+  "description": "Provides bruker NMR data files for testing purposes",
+  "main": "./lib/index.js",
+  "module": "./lib-esm/index.js",
+  "types": "./lib/index.d.ts",
+  "keywords": [],
+  "author": "Luc Patiny",
+  "license": "MIT",
   "files": [
-    "toc.json",
-    "data/*"
+    "src",
+    "lib",
+    "lib-esm",
+    "data"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 0"
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf lib lib-esm",
+    "eslint": "eslint src --cache",
+    "eslint-fix": "npm run eslint -- --fix",
+    "prepack": "npm run tsc",
+    "prettier": "prettier --check src",
+    "prettier-write": "prettier --write src",
+    "test": "npm run test-only && npm run eslint && npm run prettier && npm run check-types",
+    "test-only": "jest --coverage",
+    "tsc": "npm run clean && npm run tsc-cjs && npm run tsc-esm",
+    "tsc-cjs": "tsc --project tsconfig.cjs.json",
+    "tsc-esm": "tsc --project tsconfig.esm.json"
   },
-  "author": "jobo322",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cheminfo/bruker-data-test.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cheminfo/bruker-data-test/issues"
+  },
+  "homepage": "https://github.com/cheminfo/bruker-data-test#readme",
+  "devDependencies": {
+    "@types/jest": "^27.4.1",
+    "eslint": "^8.9.0",
+    "eslint-config-cheminfo-typescript": "^10.3.0",
+    "jest": "^27.5.1",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.1.3",
+    "typescript": "^4.5.5"
+  },
   "dependencies": {
-    "recursive-readdir-synchronous": "0.0.4"
+    "filelist-from": "^0.1.0"
   }
 }

README.md

 # bruker-data-test
 
-provides zipped Bruker NMR data files for testing purposes.
+[![NPM version][npm-image]][npm-url]
+[![build status][ci-image]][ci-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![npm download][download-image]][download-url]
 
-## usage
+.
 
+## Installation
+
+`$ npm i bruker-data-test`
+
+Provide FileList of bruker files zipped or unzipped
+
+## Usage
+
 ```js
-import { bruker } from 'bruker-data-test';
-console.log(Ohject.keys(bruker)); // to get a list
-console.log(bruker['aspirin-1h-zip']); // to get a string with proton data
+import { getZipped, getCoffee } from 'bruker-data-test';
+
+const zipped = getZipped();
+const aspirin = zipped.filter((entry) => entry.name.includes('aspirin'))[0];
+const data = await aspirin.arrayBuffer();
 ```
+
+## License
+
+[MIT](./LICENSE)
+
+[npm-image]: https://img.shields.io/npm/v/bruker-data-test.svg
+[npm-url]: https://www.npmjs.com/package/bruker-data-test
+[ci-image]: https://github.com/cheminfo/bruker-data-test/workflows/Node.js%20CI/badge.svg?branch=main
+[ci-url]: https://github.com/cheminfo/bruker-data-test/actions?query=workflow%3A%22Node.js+CI%22
+[codecov-image]: https://img.shields.io/codecov/c/github/cheminfo/bruker-data-test.svg
+[codecov-url]: https://codecov.io/gh/cheminfo/bruker-data-test
+[download-image]: https://img.shields.io/npm/dm/bruker-data-test.svg
+[download-url]: https://www.npmjs.com/package/bruker-data-test

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

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 26 instances 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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

74349230

increased by213.28%

Number of package files

216

increased by1700%

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

1

decreased by-66.67%

Number of lines in readme file

38

increased by216.67%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

8

increased byInfinity%

Lines of code

33

decreased by-8.33%

Number of medium supply chain risk alerts

27

increased byInfinity%

Dependency changes

• + Addedfilelist-from@^0.1.0

• + Addedcore-util-is@1.0.3(transitive)

• + Addedfilelist-from@0.1.0(transitive)

• + Addedimmediate@3.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedjszip@3.10.1(transitive)

• + Addedlie@3.3.0(transitive)

• + Addedpako@1.0.11(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedreadable-stream@2.3.8(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedsetimmediate@1.0.5(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• - Removedrecursive-readdir-synchronous@0.0.4

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedminimatch@3.0.4(transitive)

• - Removedrecursive-readdir-synchronous@0.0.4(transitive)