minisearch - npm Package Compare versions

Comparing version 5.0.0-beta1 to 5.0.0-beta2

CHANGELOG.md

@@ -5,4 +5,11 @@ # Changelog
 
-# v5.0.0-beta1
+# v5.0.0-beta2
 
+This is a beta release of `v5.0.0`. The main change is an improved scoring
+algorithm. The beta is generally stable, but the improvements to the scoring
+algorithm will cause the sorting of search results to be different than in
+previous versions (generally better), and need less aggressive boosting. For
+feedback about this beta release, please use [this
+issue](https://github.com/lucaong/minisearch/issues/142).
+
   - [breaking change] Use the [BM25+
@@ -18,2 +25,5 @@ algorithm](https://en.wikipedia.org/wiki/Okapi_BM25) to score search
 
+  - Define `exports` entry points in `package.json`, to require MiniSearch as a
+    commonjs package or import it as a ES module.
+
 # v4.0.3
@@ -20,0 +30,0 @@

dist/es/SearchableMap.js

@@ -1,2 +0,2 @@
-/*! *****************************************************************************
+/******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -3,0 +3,0 @@

dist/es5m/SearchableMap.js

@@ -1,2 +0,2 @@
-/*! *****************************************************************************
+/******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -3,0 +3,0 @@

dist/umd/SearchableMap.js

@@ -7,3 +7,3 @@ (function (global, factory) {
 
-    /*! *****************************************************************************
+    /******************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -10,0 +10,0 @@

package.json

 {
   "name": "minisearch",
-  "version": "5.0.0-beta1",
+  "version": "5.0.0-beta2",
   "description": "Tiny but powerful full-text search engine for browser and Node",
@@ -8,2 +8,18 @@ "main": "dist/umd/index.js",
   "es2015": "dist/es/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/cjs/index.cjs",
+      "default": "./dist/es/index.js"
+    },
+    "./SearchableMap": {
+      "types": "./dist/types/SearchableMap.d.ts",
+      "require": "./dist/cjs/SearchableMap.cjs",
+      "default": "./dist/es/SearchableMap.js"
+    }
+  },
+  "unpkg": "./dist/umd/index.js",
+  "jsdelivr": "./dist/umd/index.js",
+  "types": "./dist/types/index.d.ts",
   "author": "Luca Ongaro",
@@ -29,14 +45,15 @@ "homepage": "https://lucaong.github.io/minisearch/",
     "@rollup/plugin-typescript": "^8.2.0",
-    "@typescript-eslint/eslint-plugin": "^4.1.1",
-    "@typescript-eslint/parser": "^4.1.1",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
     "benchmark": "^2.1.4",
     "core-js": "^3.1.4",
     "coveralls": "^3.0.2",
-    "eslint": "^7.6.0",
-    "eslint-config-standard": "^16.0.2",
+    "eslint": "^8.16.0",
+    "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-n": "^15.2.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "fast-check": "^2.1.0",
-    "jest": "^26.3.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "fast-check": "^3.0.0",
+    "jest": "^28.1.0",
     "regenerator-runtime": "^0.13.1",
@@ -47,3 +64,3 @@ "rollup": "^2.2.0",
     "snazzy": "^9.0.0",
-    "ts-jest": "^26.3.0",
+    "ts-jest": "^28.0.3",
     "tslib": "^2.0.1",
@@ -58,3 +75,5 @@ "typedoc": "^0.19.1",
   "jest": {
-    "testURL": "http://localhost:3000/",
+    "testEnvironmentOptions": {
+      "url": "http://localhost:3000/"
+    },
     "transform": {
@@ -87,4 +106,3 @@ "\\.(js|ts)$": "ts-jest"
   },
-  "sideEffects": false,
-  "types": "./dist/types/index.d.ts"
+  "sideEffects": false
 }

README.md

@@ -22,3 +22,7 @@ # MiniSearch
 
+`MiniSearch` follows [semantic versioning](https://semver.org/spec/v2.0.0.html),
+and documents releases and changes in the
+[changelog](https://github.com/lucaong/minisearch/blob/master/CHANGELOG.md).
 
+
 ## Use case
@@ -25,0 +29,0 @@

src/SearchableMap/SearchableMap.test.js

@@ -277,5 +277,5 @@ /* eslint-env jest */
     it('adds and removes entries', () => {
-      const arrayOfStrings = fc.array(fc.oneof(fc.unicodeString(), fc.string()), 70)
-      const string = fc.oneof(fc.unicodeString(0, 4), fc.string(0, 4))
-      const int = fc.integer(1, 4)
+      const arrayOfStrings = fc.array(fc.oneof(fc.unicodeString(), fc.string()), { maxLength: 70 })
+      const string = fc.oneof(fc.unicodeString({ minLength: 0, maxLength: 4 }), fc.string({ minLength: 0, maxLength: 4 }))
+      const int = fc.integer({ min: 1, max: 4 })
 
@@ -282,0 +282,0 @@ fc.assert(fc.property(arrayOfStrings, string, int, (terms, prefix, maxDist) => {

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

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

Total package byte prevSize

1008733

increased by33.57%

Number of package files

31

increased by19.23%

Lines of code

15023

increased by23.86%

Number of lines in readme file

347

increased by1.17%

Is type module

Yes

Worsened metrics

Dev dependency count

23

increased by4.55%

No dependency changes