markov-strings - npm Package Compare versions

Comparing version 1.4.0 to 1.5.0

package.json

 {
   "name": "markov-strings",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "A Markov string generator",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
@@ -28,2 +29,3 @@ "test": "node node_modules/mocha/bin/_mocha --reporter spec",
   "devDependencies": {
+    "@types/node": "^9.6.6",
     "chai": "^3.5.0",
@@ -30,0 +32,0 @@ "coveralls": "^2.11.9",

README.md

@@ -12,29 +12,26 @@ [![Build Status](https://travis-ci.org/scambier/markov-strings.svg?branch=master)](https://travis-ci.org/scambier/markov-strings)
 
-<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
+<!-- TOC -->
 
-- [Prerequisites](#prerequisites)
-- [Installing](#installing)
-- [Usage](#usage)
-- [API](#api)
-	- [new Markov(data, [options])](#new-markovdata-options)
-		- [data](#data)
-		- [options](#options)
-			- [stateSize](#statesize)
-			- [maxLength](#maxlength)
-			- [minWords](#minwords)
-			- [maxWords](#maxwords)
-			- [minScore](#minscore)
-			- [minScorePerWord](#minscoreperword)
-			- [maxTries](#maxtries)
-			- [checker(sentence)](#checkersentence)
-			- [filter(result)](#filterresult)
-	- [markov.buildCorpus()](#markovbuildcorpus)
-	- [markov.generateSentence([options])](#markovgeneratesentenceoptions)
-		- [options](#options)
-- [Changelog](#changelog)
-	- [1.3.3](#133)
-	- [1.3.2](#132)
-	- [1.3.1](#131)
-	- [1.3.0](#130)
-- [Running the tests](#running-the-tests)
+- [Markov-strings](#markov-strings)
+  - [Prerequisites](#prerequisites)
+  - [Installing](#installing)
+  - [Usage](#usage)
+  - [API](#api)
+    - [new Markov(data, [options])](#new-markovdata-options)
+      - [data](#data)
+      - [options](#options)
+        - [stateSize](#statesize)
+        - [maxLength](#maxlength)
+        - [minWords](#minwords)
+        - [maxWords](#maxwords)
+        - [minScore](#minscore)
+        - [minScorePerWord](#minscoreperword)
+        - [maxTries](#maxtries)
+        - [checker(sentence)](#checkersentence)
+        - [filter(result)](#filterresult)
+    - [markov.buildCorpus()](#markovbuildcorpus)
+    - [markov.generateSentence([options])](#markovgeneratesentenceoptions)
+      - [options](#options-1)
+  - [Changelog](#changelog)
+  - [Running the tests](#running-the-tests)
 
@@ -51,5 +48,4 @@ <!-- /TOC -->
 ```javascript
-const Markov = require('markov-strings');
+const Markov = require('markov-strings'); // TypeScript: import Markov from 'markov-strings'
 
-
 // 1) Simple way
@@ -72,3 +68,2 @@
 
-
 // 2) More complete way with options and Promises
@@ -232,2 +227,5 @@
 
+**1.5.0**
+- Code rewritten in TypeScript. You can now `import MarkovGenerator from  'markov-strings'`
+
 **1.4.0**
@@ -234,0 +232,0 @@ - New `filter()` method, thanks @flpvsk

test/test.js

 'use strict';
 
-const expect = require('chai').expect,
-  _ = require('lodash');
+const expect = require('chai').expect;
+const _ = require('lodash');
+const Generator = require('../dist/index');
 
@@ -16,4 +17,2 @@ const data = [
 ];
-
-const Generator = require('../index');
 const generator = new Generator(data);
@@ -212,5 +211,5 @@
     generator.generateSentence({
-        maxTries: 100,
-        checker: result => false
-      })
+      maxTries: 100,
+      checker: result => false
+    })
       .catch(e => {
@@ -224,4 +223,4 @@ expect(e).to.be.an('error');
     generator.generateSentence({
-        checker: result => true
-      })
+      checker: result => true
+    })
       .then(result => {
@@ -235,4 +234,4 @@ expect(result).to.exist;
     generator.generateSentence({
-        checker: result => true
-      })
+      checker: result => true
+    })
       .then(result => {
@@ -239,0 +238,0 @@ expect(result.string).to.exist;

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

Improved metrics

Total package byte prevSize

41341

increased by77.15%

Number of package files

15

increased by114.29%

Lines of code

800

increased by105.13%

Worsened metrics

Dev dependency count

5

increased by25%

Number of lines in readme file

251

decreased by-0.79%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes