Fewer linting errors

javascript/.eslintrc

@@ -10,5 +10,17 @@
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
     "airbnb"
-  ]
+  ],
+  "rules": {
+    "max-len": ["error", { "code": 200 }],
+    "@typescript-eslint/no-inferrable-types": 0,
+    "no-unused-vars": 0,
+    "@typescript-eslint/no-unused-vars": 1,
+    "no-shadow": 0,
+    "@typescript-eslint/no-shadow": 2,
+    "object-curly-newline": ["error", {
+      "ObjectExpression": { "consistent": true },
+      "ObjectPattern": { "consistent": true }
+    }]
+  }
 }

javascript/devlog.md

@@ -134,3 +134,11 @@ Secondary to the `.eslintrc.*` file, we can also add a `.eslintignore` to preven
 I was temporarily confused as I also tried to run `eslint .` without `npx` as some sites offer in snippets, and it was not working. I was relying on the assumption that because my devDependency of TypeScript allows me to use `tsc` in the `scripts` that can be used with `npm run ...` I should be able to also use ESLint in a similar manner, but was only trying to do so in my terminal rather than adding it to my `scripts`. It took a while of googling around to stumble on [the simple answer](https://docs.npmjs.com/cli/v8/commands/npm-run-script?v=true) that `./node_modules/.bin`, which contains these invocable scripts, is added to the `PATH` when invoking `npm run ...`. Sure enough, `tsc` which has been working for while in my `npm run ...`'s also does not work as "just" `tsc` outside of `npm run ...`. So we can easily add an `npm run ...` that will use the version installed by the package lock. So we can now simply use an `npm run lint`.
 
 As we've followed the instructions up until here, we'll swap to the recommendations of [this blog](https://khalilstemmler.com/blogs/typescript/eslint-for-typescript/), as it uses json for the `.eslintrc`, and provides an explanation for adding "rules" to it. We can also use this to try and add [Airbnb's .eslintrc](https://www.npmjs.com/package/eslint-config-airbnb). We'll use `npx install-peerdeps --dev eslint-config-airbnb`, which generates the "peerDeps" installation command `npm install eslint-config-airbnb@19.0.4 eslint@^8.2.0 eslint-plugin-import@^2.25.3 eslint-plugin-jsx-a11y@^6.5.1 eslint-plugin-react@^7.28.0 eslint-plugin-react-hooks@^4.3.0 --save-dev`.
+
+Well, now we've got some linting set up, and using an extensive collection of recommended rules, it's time to run it and iteratively see what I've done differently from what the [Airbnb's .eslintrc](https://www.npmjs.com/package/eslint-config-airbnb) recommends. These differences can be added as modifications to the sets of rules that are extended in the `./.eslintrc` through a `"rules"` map. One that I will definitely allow is [`object-curly-newline`](https://eslint.org/docs/latest/rules/object-curly-newline). Although [`no-underscore-dangle`](https://eslint.org/docs/latest/rules/no-underscore-dangle) is something that I've avoided changing where possible, I have removed the "private" underscores from some previous implementations. One that is was a slight problem was a bunch of lines in my `./tests/index.spec.ts` popping up with;
+>   23:3   error  'it' is not defined                                    no-undef
+
+The [`no-undef`](https://eslint.org/docs/latest/rules/no-undef) error appears to be complaining that the `it` inside the function blocks of a `describe` (as well as the `describe` in other linter errors) are not declared and or defined. An answer on [this stackoverflow question](https://stackoverflow.com/a/38667441) provides the context and a link to some ESLint docs on [Specifying Environments](https://eslint.org/docs/latest/use/configure/language-options#specifying-environments) with the context being that there are _many_ environments, and;
+> An environment provides predefined global variables.
+
+Which means we can add a `/* eslint-env mocha */` comment at the top of our `./tests/index.spec.ts` and get rid of these errors.

javascript/lib/cjs/index.js

@@ -1,37 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Function = exports.__assert_sane_parameterisation = exports._CC = exports.FailedSaneParameterCheck = exports._ErrMsg = exports.__VERIFIED_MINIMUM = exports.__VERIFIED_MAXIMUM = exports._KNOWN_CYCLES = void 0;
+exports.Function = exports.assertSaneParameterisation = exports.SequenceState = exports.FailedSaneParameterCheck = exports.SaneParameterErrMsg = exports.VERIFIED_MINIMUM = exports.VERIFIED_MAXIMUM = exports.KNOWN_CYCLES = void 0;
 // The four known cycles (besides 0->0), for the default parameterisation.
-exports._KNOWN_CYCLES = [[1n, 4n, 2n], [-1n, -2n], [-5n, -14n, -7n, -20n, -10n],
+exports.KNOWN_CYCLES = [[1n, 4n, 2n], [-1n, -2n], [-5n, -14n, -7n, -20n, -10n],
     [-17n, -50n, -25n, -74n, -37n, -110n, -55n, -164n, -82n, -41n, -122n, -61n, -182n, -91n, -272n, -136n, -68n, -34n]];
 // The value up to which has been proven numerically, for the default parameterisation."
-exports.__VERIFIED_MAXIMUM = 295147905179352825856n;
+exports.VERIFIED_MAXIMUM = 295147905179352825856n;
 // The value down to which has been proven numerically, for the default parameterisation."
-exports.__VERIFIED_MINIMUM = -272n; // TODO: Check the actual lowest bound.
+exports.VERIFIED_MINIMUM = -272n; // TODO: Check the actual lowest bound.
 // Error message constant.
-var _ErrMsg;
-(function (_ErrMsg) {
-    _ErrMsg["SANE_PARAMS_P"] = "'P' should not be 0 ~ violates modulo being non-zero.";
-    _ErrMsg["SANE_PARAMS_A"] = "'a' should not be 0 ~ violates the reversability.";
-})(_ErrMsg = exports._ErrMsg || (exports._ErrMsg = {}));
+var SaneParameterErrMsg;
+(function (SaneParameterErrMsg) {
+    SaneParameterErrMsg["SANE_PARAMS_P"] = "'P' should not be 0 ~ violates modulo being non-zero.";
+    SaneParameterErrMsg["SANE_PARAMS_A"] = "'a' should not be 0 ~ violates the reversability.";
+})(SaneParameterErrMsg = exports.SaneParameterErrMsg || (exports.SaneParameterErrMsg = {}));
 class FailedSaneParameterCheck extends Error {
     constructor(message) {
         super(message);
-        this.name = "FailedSaneParameterCheck";
+        this.name = 'FailedSaneParameterCheck';
     }
 }
 exports.FailedSaneParameterCheck = FailedSaneParameterCheck;
 // Cycle Control: Descriptive flags to indicate when some event occurs in the
 // hailstone sequences, when set to verbose, or stopping time check.
-var _CC;
-(function (_CC) {
-    _CC["STOPPING_TIME"] = "STOPPING_TIME";
-    _CC["TOTAL_STOPPING_TIME"] = "TOTAL_STOPPING_TIME";
-    _CC["CYCLE_INIT"] = "CYCLE_INIT";
-    _CC["CYCLE_LENGTH"] = "CYCLE_LENGTH";
-    _CC["MAX_STOP_OUT_OF_BOUNDS"] = "MAX_STOP_OUT_OF_BOUNDS";
-    _CC["ZERO_STOP"] = "ZERO_STOP";
-})(_CC = exports._CC || (exports._CC = {}));
+var SequenceState;
+(function (SequenceState) {
+    SequenceState["STOPPING_TIME"] = "STOPPING_TIME";
+    SequenceState["TOTAL_STOPPING_TIME"] = "TOTAL_STOPPING_TIME";
+    SequenceState["CYCLE_INIT"] = "CYCLE_INIT";
+    SequenceState["CYCLE_LENGTH"] = "CYCLE_LENGTH";
+    SequenceState["MAX_STOP_OUT_OF_BOUNDS"] = "MAX_STOP_OUT_OF_BOUNDS";
+    SequenceState["ZERO_STOP"] = "ZERO_STOP";
+})(SequenceState = exports.SequenceState || (exports.SequenceState = {}));
 // """
 // Handles the sanity check for the parameterisation (P,a,b) required by both
 // the function and reverse function.
@@ -40,7 +40,7 @@ var _CC;
 //     a (bigint): Factor by which to multiply n.
 //     b (bigint): Value to add to the scaled value of n.
 // """
-function __assert_sane_parameterisation(P, a, b) {
+function assertSaneParameterisation(P, a, b) {
     // Sanity check (P,a,b) ~ P absolutely can't be 0. a "could" be zero
     // theoretically, although would violate the reversability (if ~a is 0 then a
     // value of "b" as the input to the reverse function would have a pre-emptive
@@ -55,13 +55,13 @@ function __assert_sane_parameterisation(P, a, b) {
     // function, but would not violate the reversability, so no check either.
     // " != 0" is redundant for python assertions.
     if (P === 0n) {
-        throw new FailedSaneParameterCheck(_ErrMsg.SANE_PARAMS_P);
+        throw new FailedSaneParameterCheck(SaneParameterErrMsg.SANE_PARAMS_P);
     }
     if (a === 0n) {
-        throw new FailedSaneParameterCheck(_ErrMsg.SANE_PARAMS_A);
+        throw new FailedSaneParameterCheck(SaneParameterErrMsg.SANE_PARAMS_A);
     }
 }
-exports.__assert_sane_parameterisation = __assert_sane_parameterisation;
+exports.assertSaneParameterisation = assertSaneParameterisation;
 // """
 // Returns the output of a single application of a Collatz-esque function.
 // Args:
@@ -73,7 +73,7 @@ exports.__assert_sane_parameterisation = __assert_sane_parameterisation;
 //     b (bigint): Value to add to the scaled value of n. Default is 1.
 // """
 function Function({ n, P = 2n, a = 3n, b = 1n }) {
-    __assert_sane_parameterisation(P, a, b);
+    assertSaneParameterisation(P, a, b);
     return n % P === 0n ? n / P : (a * n + b);
 }
 exports.Function = Function;

javascript/lib/cjs/types/index.d.ts

@@ -1,22 +1,22 @@
-export declare const _KNOWN_CYCLES: bigint[][];
-export declare const __VERIFIED_MAXIMUM: bigint;
-export declare const __VERIFIED_MINIMUM: bigint;
-export declare enum _ErrMsg {
+export declare const KNOWN_CYCLES: bigint[][];
+export declare const VERIFIED_MAXIMUM: bigint;
+export declare const VERIFIED_MINIMUM: bigint;
+export declare enum SaneParameterErrMsg {
     SANE_PARAMS_P = "'P' should not be 0 ~ violates modulo being non-zero.",
     SANE_PARAMS_A = "'a' should not be 0 ~ violates the reversability."
 }
 export declare class FailedSaneParameterCheck extends Error {
-    constructor(message: _ErrMsg);
+    constructor(message: SaneParameterErrMsg);
 }
-export declare enum _CC {
+export declare enum SequenceState {
     STOPPING_TIME = "STOPPING_TIME",
     TOTAL_STOPPING_TIME = "TOTAL_STOPPING_TIME",
     CYCLE_INIT = "CYCLE_INIT",
     CYCLE_LENGTH = "CYCLE_LENGTH",
     MAX_STOP_OUT_OF_BOUNDS = "MAX_STOP_OUT_OF_BOUNDS",
     ZERO_STOP = "ZERO_STOP"
 }
-export declare function __assert_sane_parameterisation(P: bigint, a: bigint, b: bigint): void;
+export declare function assertSaneParameterisation(P: bigint, a: bigint, b: bigint): void;
 export interface Parameterised {
     n: bigint;
     P?: bigint;

javascript/lib/esm/index.mjs

@@ -1,33 +1,33 @@
 // The four known cycles (besides 0->0), for the default parameterisation.
-export const _KNOWN_CYCLES = [[1n, 4n, 2n], [-1n, -2n], [-5n, -14n, -7n, -20n, -10n],
+export const KNOWN_CYCLES = [[1n, 4n, 2n], [-1n, -2n], [-5n, -14n, -7n, -20n, -10n],
     [-17n, -50n, -25n, -74n, -37n, -110n, -55n, -164n, -82n, -41n, -122n, -61n, -182n, -91n, -272n, -136n, -68n, -34n]];
 // The value up to which has been proven numerically, for the default parameterisation."
-export const __VERIFIED_MAXIMUM = 295147905179352825856n;
+export const VERIFIED_MAXIMUM = 295147905179352825856n;
 // The value down to which has been proven numerically, for the default parameterisation."
-export const __VERIFIED_MINIMUM = -272n; // TODO: Check the actual lowest bound.
+export const VERIFIED_MINIMUM = -272n; // TODO: Check the actual lowest bound.
 // Error message constant.
-export var _ErrMsg;
-(function (_ErrMsg) {
-    _ErrMsg["SANE_PARAMS_P"] = "'P' should not be 0 ~ violates modulo being non-zero.";
-    _ErrMsg["SANE_PARAMS_A"] = "'a' should not be 0 ~ violates the reversability.";
-})(_ErrMsg || (_ErrMsg = {}));
+export var SaneParameterErrMsg;
+(function (SaneParameterErrMsg) {
+    SaneParameterErrMsg["SANE_PARAMS_P"] = "'P' should not be 0 ~ violates modulo being non-zero.";
+    SaneParameterErrMsg["SANE_PARAMS_A"] = "'a' should not be 0 ~ violates the reversability.";
+})(SaneParameterErrMsg || (SaneParameterErrMsg = {}));
 export class FailedSaneParameterCheck extends Error {
     constructor(message) {
         super(message);
-        this.name = "FailedSaneParameterCheck";
+        this.name = 'FailedSaneParameterCheck';
     }
 }
 // Cycle Control: Descriptive flags to indicate when some event occurs in the
 // hailstone sequences, when set to verbose, or stopping time check.
-export var _CC;
-(function (_CC) {
-    _CC["STOPPING_TIME"] = "STOPPING_TIME";
-    _CC["TOTAL_STOPPING_TIME"] = "TOTAL_STOPPING_TIME";
-    _CC["CYCLE_INIT"] = "CYCLE_INIT";
-    _CC["CYCLE_LENGTH"] = "CYCLE_LENGTH";
-    _CC["MAX_STOP_OUT_OF_BOUNDS"] = "MAX_STOP_OUT_OF_BOUNDS";
-    _CC["ZERO_STOP"] = "ZERO_STOP";
-})(_CC || (_CC = {}));
+export var SequenceState;
+(function (SequenceState) {
+    SequenceState["STOPPING_TIME"] = "STOPPING_TIME";
+    SequenceState["TOTAL_STOPPING_TIME"] = "TOTAL_STOPPING_TIME";
+    SequenceState["CYCLE_INIT"] = "CYCLE_INIT";
+    SequenceState["CYCLE_LENGTH"] = "CYCLE_LENGTH";
+    SequenceState["MAX_STOP_OUT_OF_BOUNDS"] = "MAX_STOP_OUT_OF_BOUNDS";
+    SequenceState["ZERO_STOP"] = "ZERO_STOP";
+})(SequenceState || (SequenceState = {}));
 // """
 // Handles the sanity check for the parameterisation (P,a,b) required by both
 // the function and reverse function.
@@ -36,7 +36,7 @@ export var _CC;
 //     a (bigint): Factor by which to multiply n.
 //     b (bigint): Value to add to the scaled value of n.
 // """
-export function __assert_sane_parameterisation(P, a, b) {
+export function assertSaneParameterisation(P, a, b) {
     // Sanity check (P,a,b) ~ P absolutely can't be 0. a "could" be zero
     // theoretically, although would violate the reversability (if ~a is 0 then a
     // value of "b" as the input to the reverse function would have a pre-emptive
@@ -51,10 +51,10 @@ export function __assert_sane_parameterisation(P, a, b) {
     // function, but would not violate the reversability, so no check either.
     // " != 0" is redundant for python assertions.
     if (P === 0n) {
-        throw new FailedSaneParameterCheck(_ErrMsg.SANE_PARAMS_P);
+        throw new FailedSaneParameterCheck(SaneParameterErrMsg.SANE_PARAMS_P);
     }
     if (a === 0n) {
-        throw new FailedSaneParameterCheck(_ErrMsg.SANE_PARAMS_A);
+        throw new FailedSaneParameterCheck(SaneParameterErrMsg.SANE_PARAMS_A);
     }
 }
 // """
@@ -68,7 +68,7 @@ export function __assert_sane_parameterisation(P, a, b) {
 //     b (bigint): Value to add to the scaled value of n. Default is 1.
 // """
 export function Function({ n, P = 2n, a = 3n, b = 1n }) {
-    __assert_sane_parameterisation(P, a, b);
+    assertSaneParameterisation(P, a, b);
     return n % P === 0n ? n / P : (a * n + b);
 }
 export default {

javascript/lib/esm/types/index.d.ts

@@ -1,22 +1,22 @@
-export declare const _KNOWN_CYCLES: bigint[][];
-export declare const __VERIFIED_MAXIMUM: bigint;
-export declare const __VERIFIED_MINIMUM: bigint;
-export declare enum _ErrMsg {
+export declare const KNOWN_CYCLES: bigint[][];
+export declare const VERIFIED_MAXIMUM: bigint;
+export declare const VERIFIED_MINIMUM: bigint;
+export declare enum SaneParameterErrMsg {
     SANE_PARAMS_P = "'P' should not be 0 ~ violates modulo being non-zero.",
     SANE_PARAMS_A = "'a' should not be 0 ~ violates the reversability."
 }
 export declare class FailedSaneParameterCheck extends Error {
-    constructor(message: _ErrMsg);
+    constructor(message: SaneParameterErrMsg);
 }
-export declare enum _CC {
+export declare enum SequenceState {
     STOPPING_TIME = "STOPPING_TIME",
     TOTAL_STOPPING_TIME = "TOTAL_STOPPING_TIME",
     CYCLE_INIT = "CYCLE_INIT",
     CYCLE_LENGTH = "CYCLE_LENGTH",
     MAX_STOP_OUT_OF_BOUNDS = "MAX_STOP_OUT_OF_BOUNDS",
     ZERO_STOP = "ZERO_STOP"
 }
-export declare function __assert_sane_parameterisation(P: bigint, a: bigint, b: bigint): void;
+export declare function assertSaneParameterisation(P: bigint, a: bigint, b: bigint): void;
 export interface Parameterised {
     n: bigint;
     P?: bigint;