strtok3 7.0.0-alpha.9 → 7.0.0

package/README.md

@@ -30,6 +30,12 @@ It can read from:
 npm install strtok3
 ```
 
+### 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
 
 Use one of the methods to instantiate an [*abstract tokenizer*](#tokenizer):
@@ -53,8 +59,8 @@ All of the strtok3 methods return a [*tokenizer*](#tokenizer), either directly o
 Returns, via a promise, a [*tokenizer*](#tokenizer) which can be used to parse a file.
 
 ```js
-const strtok3 = require('strtok3');
-const Token = require('token-types');
+import * as strtok3 from 'strtok3';
+import * as Token from 'token-types';
     
 (async () => {
 
@@ -81,8 +87,8 @@ Create [*tokenizer*](#tokenizer) from a node.js [readable stream](https://nodejs
 Returns a [*tokenizer*](#tokenizer), via a Promise, which can be used to parse a buffer.
 
 ```js
-const strtok3 = require('strtok3');
-const Token = require('token-types');
+import strtok3 from 'strtok3';
+import * as Token from 'token-types';
 
 strtok3.fromStream(stream).then(tokenizer => {
   return tokenizer.readToken(Token.UINT8).then(myUint8Number => {
@@ -101,7 +107,7 @@ strtok3.fromStream(stream).then(tokenizer => {
 Returns a [*tokenizer*](#tokenizer) which can be used to parse the provided buffer.
 
 ```js
-const strtok3 = require('strtok3');
+import * as strtok3 from 'strtok3';
     
 const tokenizer = strtok3.fromBuffer(buffer);
 
@@ -274,8 +280,8 @@ To convert a [Web-API readable stream](https://developer.mozilla.org/en-US/docs/
 
 Example submodule-import:
 ```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';
 
 (async () => {
 

package/lib/AbstractTokenizer.d.ts

@@ -58,7 +58,7 @@ export declare abstract class AbstractTokenizer implements ITokenizer {
      */
     peekNumber(token: IToken<number>): Promise<number>;
     /**
-     *  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
      * @return resolves the number of bytes ignored, equals length if this available, otherwise the number of bytes available
      */

package/lib/AbstractTokenizer.js

@@ -61,7 +61,7 @@ export class AbstractTokenizer {
         return token.get(this.numBuffer, 0);
     }
     /**
-     *  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
      * @return resolves the number of bytes ignored, equals length if this available, otherwise the number of bytes available
      */

package/lib/FsPromise.d.ts

@@ -1,7 +1,8 @@
 /**
  * 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';
 export interface IReadResult {
     bytesRead: number;

package/lib/ReadStreamTokenizer.d.ts

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

package/lib/core.d.ts

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

package/lib/index.d.ts

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

package/lib/types.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strtok3",
-  "version": "7.0.0-alpha.9",
+  "version": "7.0.0",
   "description": "A promise based streaming tokenizer",
   "author": {
     "name": "Borewit",
@@ -22,12 +22,11 @@
     "fix": "eslint lib test --ext .ts --ignore-pattern *.d.ts --fix",
     "test": "mocha",
     "test-coverage": "c8 npm run test",
-    "send-coveralls": "c8 report | coveralls",
     "send-codacy": "c8 report --reporter=text-lcov | codacy-coverage",
     "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"
   },
   "repository": {
     "type": "git",
@@ -51,31 +50,32 @@
     "url": "https://github.com/Borewit/strtok3/issues"
   },
   "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"
   },
   "keywords": [
     "tokenizer",