fuzzyset.js - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

package.json

 {
-   "name":"fuzzyset.js",
-   "description":"A fast fuzzy string set for JavaScript",
-   "version":"1.0.5",
-   "homepage":"http://Glench.github.com/fuzzyset.js",
-   "repository":"git://github.com/Glench/fuzzyset.js.git",
-   "author":"Glen Chiacchieri (http://glench.com/)",
+   "name": "fuzzyset.js",
+   "description": "A fast fuzzy string set for JavaScript",
+   "version": "1.0.6",
+   "homepage": "http://Glench.github.com/fuzzyset.js",
+   "repository": "git://github.com/Glench/fuzzyset.js.git",
+   "author": "Glen Chiacchieri (http://glench.com/)",
    "license": "see LICENSE.md",
    "funding": {
-       "type": "License Zero",
-       "url": "https://licensezero.com/offers/562c0ffe-df98-4348-87b7-e60e3c37c534"
+      "type": "License Zero",
+      "url": "https://licensezero.com/offers/562c0ffe-df98-4348-87b7-e60e3c37c534"
    },
-   "main":"./index.js",
-   "devDependencies":{
-      "should":"*"
+   "main": "./dist/fuzzyset.common.js",
+   "module": "./dist/fuzzyset.esm.js",
+   "unpkg": "./dist/fuzzyset.js",
+   "jsdelivr": "./dist/fuzzyset.js",
+   "files": [
+      "dist"
+   ],
+   "devDependencies": {
+      "rollup": "^2.34.2",
+      "should": "*"
    },
-   "scripts":{
-      "test":""
+   "scripts": {
+      "build": "rollup -c",
+      "dev": "rollup -c -w"
    },
-   "engines":{
-      "node":">= 0.4.0"
+   "engines": {
+      "node": ">= 0.4.0"
    }
 }

README.MD

 fuzzyset - A fuzzy string set for javascript.
 =============================================
 
+**Version 1.0.0 involves a license change but no API changes. See the bottom of this document for details.**
+
+**Version 1.0.6 December 12, 2020: involves a module restructuring but no API changes. Should now work with TypeScript, ESM, CommonJS, and web (IIFE).**
+
 fuzzyset is a data structure that performs something akin to fulltext search
@@ -21,2 +25,24 @@ against data to determine likely mispellings and approximate string matching.
 
+Install
+--------
+
+```bash
+npm install fuzzyset
+```
+(Used to be `fuzzyset.js`.) 
+
+Then:
+```javascript
+import FuzzySet from 'FuzzySet'
+
+// or, depending on your JavaScript environment...
+
+const FuzzySet = require('fuzzyset')
+```
+
+Or for use directly on the web:
+```html
+<script type="text/javascript" src="dist/fuzzyset.js"></script>
+```
+
 Construction Arguments
@@ -26,5 +52,5 @@ ----------------------
  - `array`: An array of strings to initialize the data structure with
- - `useLevenshtein`: Whether or not to use the levenshtein distance to determine the match scoring. Default: True
- - `gramSizeLower`: The lower bound of gram sizes to use, inclusive (see Theory of operation). Default: 2
- - `gramSizeUpper`: The upper bound of gram sizes to use, inclusive (see Theory of operation). Default: 3
+ - `useLevenshtein`: Whether or not to use the levenshtein distance to determine the match scoring. Default: `true`
+ - `gramSizeLower`: The lower bound of gram sizes to use, inclusive (see interactive documentation). Default: `2`
+ - `gramSizeUpper`: The upper bound of gram sizes to use, inclusive (see interactive documentation). Default: `3`
 
@@ -47,16 +73,9 @@ Methods
 
-Install
---------
-this:
 
-```html
-<script type="text/javascript" src="/path/to/fuzzyset.js"></script>
-```
-or:
 
-```bash
-npm install fuzzyset.js
-```
-(the `.js` is important). In a CommonJS environment, the `fuzzyset.js` module exports the `FuzzySet` function.
 
+Develop
+--------
+To contribute to the library, edit the `lib/fuzzyset.js` file then run `npm run build` to generate all the different file formats in the `dist/` directory. Or run `npm run dev` while developing to auto-build as you change files.
+
 License
@@ -71,2 +90,2 @@ -------
 
-Why this license scheme? Since I [quit tech to become a therapist](http://glench.com/WhyIQuitTechAndBecameATherapist/), my income is much lower (due to the unjust costs of mental health care in the US, but don't get me started). I'm asking for paid licenses for Fuzzyset.js to support all the free work I've done on this project over the past 8 years (!) and so I can live a sustainable life in service of my therapy clients. If you're a small operation that would like to use Fuzzyset.js but can't swing the license, please reach out to me and we can work something out.
+Why this license scheme? Since I [quit tech to become a therapist](http://glench.com/WhyIQuitTechAndBecameATherapist/), my income is much lower (due to the unjust costs of mental health care in the US, but don't get me started). I'm asking for paid licenses for Fuzzyset.js to support all the free work I've done on this project over the past 8 years (!) and so I can live a sustainable life in service of my therapy clients. If you're a small operation that would like to use Fuzzyset.js but can't swing the license cost, please reach out to me and we can work something out.

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

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

35313

increased by102.91%

Lines of code

742

increased by165.95%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

88

increased by27.54%

Worsened metrics

Dev dependency count

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes