split-frames 2.4.3 → 2.4.5

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019, Sébastien Vidal
+Copyright (c) 2023, Sébastien Vidal
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/lib/checkers/initData.js

@@ -6,7 +6,11 @@
 
 // deps
 
-	const checkTagsValidity = require(require("path").join(__dirname, "checkTagsValidity.js"));
+	// natives
+	const { join } = require("node:path");
+
+	// locals
+	const checkTagsValidity = require(join(__dirname, "checkTagsValidity.js"));
 
 // consts
 

package/lib/index.d.ts

@@ -2,6 +2,8 @@
 
 declare module "split-frames" {
 
+	import { Transform } from "node:stream";
+
 	type ControlBits = "none" | "end+1" | "end+2";
 	type Tag = number | Buffer | Array<number>;
 
@@ -20,7 +22,7 @@ declare module "split-frames" {
 		"controlBits"?: ControlBits;
 	}
 
-	class Splitter extends require("stream").Transform {
+	class Splitter extends Transform {
 
 		protected _frame: Buffer;
 		protected _digesting: boolean;
@@ -45,7 +47,6 @@ declare module "split-frames" {
 		protected _searchTags(tag: Tag, beginWith?: number): number;
 		protected _digest(): void;
 		protected _digester(): void;
-		protected _transform(chunk: Buffer, enc?: string, cb?: () => void): void;
 
 	}
 

package/lib/main.js

@@ -6,7 +6,11 @@
 
 // deps
 
-	const { join } = require("path");
+	// natives
+	const { join } = require("node:path");
+	const { Transform } = require("node:stream");
+
+	// locals
 
 	const _initData = require(join(__dirname, "checkers", "initData.js"));
 
@@ -72,7 +76,7 @@
 
 // module
 
-module.exports = class SplitFrames extends require("stream").Transform {
+module.exports = class SplitFrames extends Transform {
 
 	constructor (options) {
 

package/package.json

@@ -1,26 +1,62 @@
 {
+
   "name": "split-frames",
-  "version": "2.4.3",
+  "version": "2.4.5",
   "description": "Split Buffer frames from streams",
+
+  "type": "commonjs",
   "main": "lib/main.js",
   "typings": "lib/index.d.ts",
+
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/main.js"
+      }
+    }
+  },
+
   "scripts": {
+
+    "build": "npx tsc --project \"./tsconfig.json\"",
+
     "lint": "npx eslint ./lib/**/*.js ./test/**/*.js",
+    "check-requires": "npx used-deps-analyzer \"./package.json\" \"./lib\" --no-dev --overkill \"fs-extra\" \"node-promfs\"",
     "check-updates": "npx check-version-modules",
     "unit-tests": "npx nyc --reporter=html --reporter=text mocha",
-    "tests": "npm run-script lint && npm run-script check-updates && npm run-script unit-tests",
+
+    "tests": "npm run-script lint && npm run check-requires && npm run-script check-updates && npm run-script unit-tests",
     "ci": "npm run-script tests && npx nyc report --reporter=text-lcov | coveralls"
+
+  },
+
+  "files": [
+    "/lib"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
+
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "20.5.0",
+    "check-version-modules": "1.4.1",
+    "coveralls": "3.1.1",
+    "eslint": "8.47.0",
+    "husky": "8.0.3",
+    "mocha": "10.2.0",
+    "nyc": "15.1.0",
+    "used-deps-analyzer": "0.1.6"
   },
+  "optionalDependencies": {},
+
   "husky": {
     "hooks": {
       "pre-commit": "npm run-script lint",
       "pre-push": "npm run-script tests"
     }
   },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/Psychopoulet/split-frames"
-  },
   "keywords": [
     "frame",
     "Buffer",
@@ -47,21 +83,14 @@
   ],
   "author": "Sébastien VIDAL",
   "license": "ISC",
+
+  "homepage": "https://github.com/Psychopoulet/split-frames#readme",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Psychopoulet/split-frames"
+  },
   "bugs": {
     "url": "https://github.com/Psychopoulet/split-frames/issues"
-  },
-  "dependencies": {},
-  "devDependencies": {
-    "@types/node": "18.11.9",
-    "check-version-modules": "1.3.5",
-    "coveralls": "3.1.1",
-    "eslint": "8.26.0",
-    "husky": "8.0.1",
-    "mocha": "10.1.0",
-    "nyc": "15.1.0"
-  },
-  "homepage": "https://github.com/Psychopoulet/split-frames#readme",
-  "engines": {
-    "node": ">=16.0.0"
   }
+
 }

package/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

package/.eslintrc.js

@@ -1,296 +0,0 @@
-module.exports = {
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": 2018
-    },
-    "env": {
-        "es6": true,
-        "mocha": true,
-        "node": true
-    },
-    "globals": {
-        "after": true,
-        "afterEach": true,
-        "angular": true,
-        "before": true,
-        "beforeEach": true,
-        "Buffer": true,
-        "console": true,
-        "clearInterval": true,
-        "clearTimeout": true,
-        "describe": true,
-        "it": true,
-        "jQuery": true,
-        "Promise": true,
-        "Map": true,
-        "module": true,
-        "os": true,
-        "process": true,
-        "require": true,
-        "setImmediate": true,
-        "setInterval": true,
-        "setTimeout": true,
-        "__dirname": true,
-        "__filename": true
-    },
-    "rules": {
-        "for-direction": "error",
-        "getter-return": "error",
-        "no-await-in-loop": "error",
-        "no-compare-neg-zero": "error",
-        "no-cond-assign": "error",
-        "no-console": "error",
-        "no-constant-condition": "error",
-        "no-control-regex": "error",
-        "no-debugger": "error",
-        "no-dupe-args": "error",
-        "no-dupe-keys": "error",
-        "no-duplicate-case": "error",
-        "no-empty": "error",
-        "no-empty-character-class": "error",
-        "no-ex-assign": "error",
-        "no-extra-boolean-cast": "error",
-        "no-extra-parens": "error",
-        "no-extra-semi": "error",
-        "no-func-assign": "error",
-        "no-inner-declarations": "error",
-        "no-invalid-regexp": "error",
-        "no-irregular-whitespace": "error",
-        "no-obj-calls": "error",
-        "no-prototype-builtins": "error",
-        "no-regex-spaces": "error",
-        "no-sparse-arrays": "error",
-        "no-template-curly-in-string": "error",
-        "no-unexpected-multiline": "error",
-        "no-unreachable": "error",
-        "no-unsafe-finally": "error",
-        "no-unsafe-negation": "error",
-        "use-isnan": "error",
-        "valid-jsdoc": "error",
-        "valid-typeof": "error",
-
-
-        "accessor-pairs": "error",
-        "array-callback-return": "error",
-        "block-scoped-var": "error",
-        "class-methods-use-this": "error",
-        "complexity": "error",
-        "consistent-return": "error",
-        "curly": "error",
-        "default-case": "error",
-        "dot-location": [ "error", "property" ],
-        "dot-notation": "error",
-        "eqeqeq": "error",
-        "guard-for-in": "error",
-        "no-alert": "error",
-        "no-caller": "error",
-        "no-case-declarations": "error",
-        "no-div-regex": "error",
-        "no-else-return": 0,
-        "no-empty-function": "error",
-        "no-empty-pattern": "error",
-        "no-eq-null": "error",
-        "no-eval": "error",
-        "no-extend-native": "error",
-        "no-extra-bind": "error",
-        "no-extra-label": "error",
-        "no-fallthrough": "error",
-        "no-floating-decimal": "error",
-        "no-global-assign": "error",
-        "no-implicit-coercion": "error",
-        "no-implicit-globals": "error",
-        "no-implied-eval": "error",
-        "no-invalid-this": "error",
-        "no-iterator": "error",
-        "no-labels": "error",
-        "no-lone-blocks": "error",
-        "no-loop-func": "error",
-        "no-magic-numbers": 0,
-        "no-multi-spaces": "error",
-        "no-multi-str": "error",
-        "no-new": "error",
-        "no-new-func": "error",
-        "no-new-wrappers": "error",
-        "no-octal": "error",
-        "no-octal-escape": "error",
-        "no-param-reassign": "error",
-        "no-proto": "error",
-        "no-redeclare": "error",
-        "no-restricted-properties": "error",
-        "no-return-assign": "error",
-        "no-return-await": "error",
-        "no-script-url": "error",
-        "no-self-assign": "error",
-        "no-self-compare": "error",
-        "no-sequences": "error",
-        "no-throw-literal": "error",
-        "no-unmodified-loop-condition": "error",
-        "no-unused-expressions": "error",
-        "no-unused-labels": "error",
-        "no-useless-call": "error",
-        "no-useless-concat": "error",
-        "no-useless-escape": "error",
-        "no-useless-return": "error",
-        "no-void": "error",
-        "no-warning-comments": "error",
-        "no-with": "error",
-        "prefer-promise-reject-errors": "error",
-        "radix": "error",
-        "require-await": "error",
-        "vars-on-top": "error",
-        "wrap-iife": "error",
-        "yoda": [ "error", "always" ],
-
-
-        "strict": [ "error", "global" ],
-
-
-        "init-declarations": "error",
-        "no-catch-shadow": "error",
-        "no-delete-var": "error",
-        "no-label-var": "error",
-        "no-restricted-globals": "error",
-        "no-shadow": "error",
-        "no-shadow-restricted-names": "error",
-        "no-undef": "error",
-        "no-undef-init": "error",
-        "no-undefined": "error",
-        "no-unused-vars": "error",
-        "no-use-before-define": "error",
-
-
-        "callback-return": "error",
-        "global-require": 0,
-        "handle-callback-err": "error",
-        "no-buffer-constructor": "error",
-        "no-mixed-requires": "error",
-        "no-new-require": "error",
-        "no-path-concat": "error",
-        "no-process-env": "error",
-        "no-process-exit": "error",
-        "no-restricted-modules": "error",
-        "no-sync": "error",
-
-
-        "array-bracket-newline": "error",
-        "array-bracket-spacing": [ "error", "always" ],
-        "array-element-newline": [ "error", "consistent" ],
-        "block-spacing": "error",
-        "brace-style": [ "error", "stroustrup" ],
-        "camelcase": "error",
-        "capitalized-comments": 0,
-        "comma-dangle": [ "error", "never" ],
-        "comma-spacing": [ "error", { "before": false, "after": true } ],
-        "comma-style": [ "error", "last" ],
-        "computed-property-spacing": [ "error", "never" ],
-        "consistent-this": "error",
-        "eol-last": "error",
-        "func-call-spacing": "error",
-        "func-name-matching": "error",
-        "func-names": "error",
-        "func-style": [ "error", "declaration" ],
-        "id-blacklist": 0,
-        "id-length": 0,
-        "id-match": 0,
-        "indent": 0,
-        "jsx-quotes": [ "error", "prefer-double" ],
-        "key-spacing": [ "error", { "beforeColon": false, "afterColon": true } ],
-        "keyword-spacing": [ "error", { "after": true, "before": true } ],
-        "line-comment-position": [ "error", { "position": "above" } ],
-        "linebreak-style": 0,
-        "lines-around-comment": "error",
-        "max-depth": [ "error", 4 ],
-        "max-len": [ "error", 150 ],
-        "max-lines": [ "error", { "max": 500, "skipComments": true } ],
-        "max-nested-callbacks": [ "error", 5 ],
-        "max-params": [ "error", 4 ],
-        "max-statements": [ "error", 25 ],
-        "max-statements-per-line": [ "error", { "max": 2 } ],
-        "multiline-ternary": 0,
-        "new-cap": "error",
-        "new-parens": "error",
-        "newline-per-chained-call": 0,
-        "no-array-constructor": "error",
-        "no-bitwise": "error",
-        "no-continue": "error",
-        "no-inline-comments": "error",
-        "no-lonely-if": "error",
-        "no-mixed-operators": "error",
-        "no-mixed-spaces-and-tabs": "error",
-        "no-multi-assign": "error",
-        "no-multiple-empty-lines": "error",
-        "no-negated-condition": 0,
-        "no-nested-ternary": "error",
-        "no-new-object": "error",
-        "no-plusplus": 0,
-        "no-restricted-syntax": "error",
-        "no-tabs": [ "error", { "allowIndentationTabs": true } ],
-        "no-ternary": 0,
-        "no-trailing-spaces": "error",
-        "no-underscore-dangle": 0,
-        "no-unneeded-ternary": "error",
-        "no-whitespace-before-property": "error",
-        "nonblock-statement-body-position": [ "error", "below" ],
-        "object-curly-newline": [ "error", { "consistent": true } ],
-        "object-curly-spacing": [ "error", "always" ],
-        "object-property-newline": "error",
-        "one-var": [ "error", "never" ],
-        "one-var-declaration-per-line": "error",
-        "operator-assignment": [ "error", "always" ],
-        "operator-linebreak": [ "error", "after" ],
-        "padded-blocks": ["error", { "classes": "always", "switches": "always" } ],
-        "padding-line-between-statements": "error",
-        "quote-props": [ "error", "always" ],
-        "quotes": [ "error", "double" ],
-        "require-jsdoc": "error",
-        "semi": [ "error", "always" ],
-        "semi-spacing": [ "error", { "before": false, "after": true } ],
-        "semi-style": [ "error", "last" ],
-        "sort-keys": 0,
-        "sort-vars": "error",
-        "space-before-blocks": [ "error", "always" ],
-        "space-before-function-paren": [ "error", "always" ],
-        "space-in-parens": [ "error", "never" ],
-        "space-infix-ops": "error",
-        "space-unary-ops": "error",
-        "spaced-comment": [ "error", "always" ],
-        "switch-colon-spacing": [ "error", { "after": true, "before": false } ],
-        "template-tag-spacing": [ "error", "always" ],
-        "unicode-bom": 0,
-        "wrap-regex": "error",
-
-
-        "arrow-body-style": [ "error", "always" ],
-        "arrow-parens": [ "error", "always" ],
-        "arrow-spacing": ["error", { "before": true, "after": true } ],
-        "constructor-super": "error",
-        "generator-star-spacing": [ "error", { "before": true, "after": false } ],
-        "no-class-assign": "error",
-        "no-confusing-arrow": "error",
-        "no-const-assign": "error",
-        "no-dupe-class-members": "error",
-        "no-duplicate-imports": "error",
-        "no-new-symbol": "error",
-        "no-restricted-imports": 0,
-        "no-this-before-super": "error",
-        "no-useless-computed-key": "error",
-        "no-useless-constructor": "error",
-        "no-useless-rename": "error",
-        "no-var": "error",
-        "object-shorthand": "error",
-        "prefer-arrow-callback": "error",
-        "prefer-const": "error",
-        "prefer-destructuring": "error",
-        "prefer-numeric-literals": "error",
-        "prefer-rest-params": "error",
-        "prefer-spread": "error",
-        "prefer-template": 0,
-        "require-yield": "error",
-        "rest-spread-spacing": [ "error", "never" ],
-        "sort-imports": "error",
-        "symbol-description": "error",
-        "template-curly-spacing": "error",
-        "yield-star-spacing": [ "error", { "before": true, "after": false } ]
-
-    }
-};

package/.travis.yml

@@ -1,8 +0,0 @@
-language: node_js
-node_js:
-  - "8"
-  - "10"
-install:
-  - "npm install -g typescript"
-  - "npm install"
-script: "npm run-script ci"

package/test/0_compilation_typescript.js

@@ -1,37 +0,0 @@
-
-"use strict";
-
-// deps
-
-	const { exec } = require("child_process");
-	const { join } = require("path");
-	const { unlink } = require("fs");
-
-// consts
-
-	const MAX_TIMEOUT = 10000;
-
-// tests
-
-describe("compilation typescript", () => {
-
-	after((done) => {
-
-		unlink(join(__dirname, "typescript", "compilation.js"), (err) => {
-			return err ? done(err) : done();
-		});
-
-	});
-
-	it("should compile typescript file", (done) => {
-
-		exec("tsc " + join(__dirname, "typescript", "compilation.ts"), {
-			"cwd": join(__dirname, ".."),
-			"windowsHide": true
-		}, (err) => {
-			return err ? done(err) : done();
-		});
-
-	}).timeout(MAX_TIMEOUT);
-
-});