strtok3 - npm Package Compare versions

Comparing version 7.0.0-alpha.9 to 7.0.0

lib/AbstractTokenizer.d.ts

@@ -61,3 +61,3 @@ import { ITokenizer, IFileInfo, IReadChunkOptions } from './types.js';
     /**
-     *  Ignore number of bytes, advances the pointer in under tokenizer-stream.
+     * Ignore number of bytes, advances the pointer in under tokenizer-stream.
      * @param length - Number of bytes to ignore
@@ -64,0 +64,0 @@ * @return resolves the number of bytes ignored, equals length if this available, otherwise the number of bytes available

lib/AbstractTokenizer.js

@@ -64,3 +64,3 @@ import { EndOfStreamError } from 'peek-readable';
     /**
-     *  Ignore number of bytes, advances the pointer in under tokenizer-stream.
+     * Ignore number of bytes, advances the pointer in under tokenizer-stream.
      * @param length - Number of bytes to ignore
@@ -67,0 +67,0 @@ * @return resolves the number of bytes ignored, equals length if this available, otherwise the number of bytes available

lib/core.d.ts

@@ -1,2 +0,2 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { ReadStreamTokenizer } from './ReadStreamTokenizer.js';
@@ -3,0 +3,0 @@ import { Readable } from 'node:stream';

lib/FsPromise.d.ts

 /**
  * Module convert fs functions to promise based functions
  */
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import fs from 'node:fs';
@@ -6,0 +7,0 @@ export interface IReadResult {

lib/index.d.ts

@@ -1,2 +0,2 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { Readable } from 'node:stream';
@@ -3,0 +3,0 @@ import { ReadStreamTokenizer } from './ReadStreamTokenizer.js';

lib/ReadStreamTokenizer.d.ts

@@ -1,2 +0,2 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { AbstractTokenizer } from './AbstractTokenizer.js';
@@ -3,0 +3,0 @@ import { Readable } from 'node:stream';

lib/types.d.ts

@@ -1,2 +0,2 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { IGetToken } from '@tokenizer/token';
@@ -3,0 +3,0 @@ export interface IFileInfo {

package.json

 {
   "name": "strtok3",
-  "version": "7.0.0-alpha.9",
+  "version": "7.0.0",
   "description": "A promise based streaming tokenizer",
@@ -25,3 +25,2 @@ "author": {
     "test-coverage": "c8 npm run test",
-    "send-coveralls": "c8 report | coveralls",
     "send-codacy": "c8 report --reporter=text-lcov | codacy-coverage",
@@ -31,3 +30,3 @@ "start": "npm run compile && npm run lint && npm run cover-test"
   "engines": {
-    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+    "node": ">=14.16"
   },
@@ -56,27 +55,28 @@ "repository": {
   "devDependencies": {
-    "@types/chai": "^4.3.0",
+    "@types/chai": "^4.3.1",
     "@types/debug": "^4.1.7",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^16.11.12",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
-    "@typescript-eslint/eslint-plugin-tslint": "^5.6.0",
-    "@typescript-eslint/parser": "^2.34.0",
-    "c8": "^7.10.0",
-    "chai": "^4.3.4",
-    "coveralls": "^3.1.1",
-    "del-cli": "^4.0.1",
-    "eslint": "^6.8.0",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "mocha": "^9.1.3",
-    "remark-cli": "^10.0.1",
+    "@types/mocha": "^9.1.0",
+    "@types/node": "^18.6.3",
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
+    "@typescript-eslint/parser": "^5.32.0",
+    "c8": "^7.12.0",
+    "chai": "^4.3.6",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.21.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^3.4.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsdoc": "^39.3.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-unicorn": "^43.0.2",
+    "mocha": "^10.0.0",
+    "remark-cli": "^11.0.0",
     "remark-preset-lint-recommended": "^6.1.2",
-    "token-types": "^4.1.1",
-    "ts-node": "^10.4.0",
-    "tslint": "^6.1.3",
-    "typescript": "^4.5.3"
+    "token-types": "^5.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
   },
   "dependencies": {
     "@tokenizer/token": "^0.3.0",
-    "peek-readable": "^5.0.0-alpha.5"
+    "peek-readable": "^5.0.0"
   },
@@ -83,0 +83,0 @@ "keywords": [

README.md

@@ -33,2 +33,8 @@ ![Node.js CI](https://github.com/Borewit/strtok3/workflows/Node.js%20CI/badge.svg)
 
+### Compatibility
+
+Module: version 7 migrated from [CommonJS](https://en.wikipedia.org/wiki/CommonJS) to [pure ECMAScript Module (ESM)](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+JavaScript is compliant with [ECMAScript 2019 (ES10)](https://en.wikipedia.org/wiki/ECMAScript#10th_Edition_%E2%80%93_ECMAScript_2019).
+Requires Node.js ≥ 14.16 engine.
+
 ## API
@@ -57,4 +63,4 @@
 ```js
-const strtok3 = require('strtok3');
-const Token = require('token-types');
+import * as strtok3 from 'strtok3';
+import * as Token from 'token-types';
     
@@ -86,4 +92,4 @@ (async () => {
 ```js
-const strtok3 = require('strtok3');
-const Token = require('token-types');
+import strtok3 from 'strtok3';
+import * as Token from 'token-types';
 
@@ -107,3 +113,3 @@ strtok3.fromStream(stream).then(tokenizer => {
 ```js
-const strtok3 = require('strtok3');
+import * as strtok3 from 'strtok3';
     
@@ -281,4 +287,4 @@ const tokenizer = strtok3.fromBuffer(buffer);
 ```js
-const strtok3core = require('strtok3/lib/core'); // Submodule-import to prevent Node.js specific dependencies
-const {ReadableWebToNodeStream} = require('readable-web-to-node-stream');
+import * as strtok3core from 'strtok3/core'; // Submodule-import to prevent Node.js specific dependencies
+import { ReadableWebToNodeStream } from 'readable-web-to-node-stream';
 
@@ -285,0 +291,0 @@ (async () => {

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

48974

increased by1.06%

Lines of code

714

increased by0.14%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

307

increased by1.99%

Worsened metrics

Dev dependency count

22

increased by4.76%

Dependency changes

• Updatedpeek-readable@^5.0.0