@smockle/contrast 8.0.1 → 9.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Clay Miller
+Copyright (c) 2017-2025 Clay Miller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,7 +1,6 @@
 # contrast
 
 [![npm](https://img.shields.io/npm/v/@smockle/contrast.svg)](https://www.npmjs.com/package/@smockle/contrast)
-[![Publish Workflow](https://github.com/smockle/contrast/workflows/Publish/badge.svg)](https://github.com/smockle/contrast/actions)
 [![codecov](https://codecov.io/gh/smockle/contrast/branch/main/graph/badge.svg)](https://codecov.io/gh/smockle/contrast)
 
 Analyse luminosity contrast ratio

package/dist/bin/index.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 import { Contrast } from "../lib/index.js";
-import { existsSync, readFileSync } from "fs";
-import { inspect } from "util";
-import url from "url";
+import { existsSync, readFileSync } from "node:fs";
+import { inspect } from "node:util";
+import url from "node:url";
 const { URL } = url;
 const foreground = process.argv.slice(2)[0];
 const background = process.argv.slice(2)[1];

package/dist/lib/contrast.d.ts

@@ -1,5 +1,4 @@
 import { HexColor } from "./hexcolor.js";
-declare const inspect: unique symbol;
 export declare class Contrast {
     /** The foreground color, e.g. "#FFFFFF". */
     foreground: HexColor;
@@ -10,7 +9,4 @@ export declare class Contrast {
     constructor(foreground: string, background: string);
     /** Returns the luminosity contrast ratio. */
     valueOf(): number;
-    /** Returns a formatted representation of the luminosity contrast ratio, e.g. "4.5:1". */
-    [inspect](): string;
 }
-export {};

package/dist/lib/contrast.js

@@ -1,5 +1,4 @@
 import { HexColor } from "./hexcolor.js";
-const inspect = Symbol.for("nodejs.util.inspect.custom");
 export class Contrast {
     /** The foreground color, e.g. "#FFFFFF". */
     foreground;
@@ -24,7 +23,7 @@ export class Contrast {
         return this.value;
     }
     /** Returns a formatted representation of the luminosity contrast ratio, e.g. "4.5:1". */
-    [inspect]() {
+    [Symbol.for("nodejs.util.inspect.custom")]() {
         return `${this.value}:1`;
     }
 }

package/dist/lib/eightbit.d.ts

@@ -1,16 +1,12 @@
 import { Hex } from "./hex.js";
-declare const inspect: unique symbol;
 export declare class EightBit implements EightBit {
     /** A number between 0 and 255. */
     value: number;
     constructor(value: EightBit | number | null);
     /** Returns the current value, e.g. 255. */
     valueOf(): number;
-    /** Returns a formatted representation of the current value, e.g. "EightBit(255)". */
-    [inspect](): string;
     /** Convert from sRGB to linear RGB. */
     linearize(): number;
     /** Returns a Hex with the current value, e.g. Hex("#FF"). */
     toHex(): Hex;
 }
-export {};

package/dist/lib/eightbit.js

@@ -1,5 +1,4 @@
 import { Hex } from "./hex.js";
-const inspect = Symbol.for("nodejs.util.inspect.custom");
 export class EightBit {
     /** A number between 0 and 255. */
     value;
@@ -11,7 +10,7 @@ export class EightBit {
         return this.value;
     }
     /** Returns a formatted representation of the current value, e.g. "EightBit(255)". */
-    [inspect]() {
+    [Symbol.for("nodejs.util.inspect.custom")]() {
         return `EightBit(${this.value})`;
     }
     /** Convert from sRGB to linear RGB. */

package/dist/lib/eightbitcolor.d.ts

@@ -1,6 +1,5 @@
 import { EightBit } from "./eightbit.js";
 import { HexColor } from "./hexcolor.js";
-declare const inspect: unique symbol;
 export declare class EightBitColor {
     /** The current red value, e.g. EightBit(255). */
     R: EightBit;
@@ -15,11 +14,8 @@ export declare class EightBitColor {
         G: number;
         B: number;
     };
-    /** Returns a formatted representation of the current rgb value, e.g. "rgb(255, 255, 255)". */
-    [inspect](): string;
     /** Returns the luminosity. */
     luminosity(): number;
     /** Returns a HexColor with the current value, e.g. Hex("#FFFFFF"). */
     toHexColor(): HexColor;
 }
-export {};

package/dist/lib/eightbitcolor.js

@@ -1,6 +1,5 @@
 import { EightBit } from "./eightbit.js";
 import { HexColor } from "./hexcolor.js";
-const inspect = Symbol.for("nodejs.util.inspect.custom");
 export class EightBitColor {
     /** The current red value, e.g. EightBit(255). */
     R;
@@ -21,7 +20,7 @@ export class EightBitColor {
         return { R, G, B };
     }
     /** Returns a formatted representation of the current rgb value, e.g. "rgb(255, 255, 255)". */
-    [inspect]() {
+    [Symbol.for("nodejs.util.inspect.custom")]() {
         const R = this.R.valueOf();
         const G = this.G.valueOf();
         const B = this.B.valueOf();

package/dist/lib/hex.d.ts

@@ -1,14 +1,10 @@
 import { EightBit } from "./eightbit.js";
-declare const inspect: unique symbol;
 export declare class Hex {
     /** The string representation of a hexadecimal value between 0 ("00") and 255 ("FF"). */
     value: string | null;
     constructor(value?: string | null);
     /** Returns the current value, e.g. "FF". */
     valueOf(): string | null;
-    /** Returns a formatted representation of the current value, e.g. "#FF". */
-    [inspect](): string;
     /** Returns an EightBit with the current value, e.g. EightBit(255). */
     toEightBit(): EightBit;
 }
-export {};

package/dist/lib/hex.js

@@ -1,5 +1,4 @@
 import { EightBit } from "./eightbit.js";
-const inspect = Symbol.for("nodejs.util.inspect.custom");
 /**
  * Pads the provided string with another string (repeated, if needed) so that the resulting string reaches the given length. The padding is applied from the start (left) of the provided string.
  * @param string The provided string.
@@ -25,7 +24,7 @@ export class Hex {
         return this.value;
     }
     /** Returns a formatted representation of the current value, e.g. "#FF". */
-    [inspect]() {
+    [Symbol.for("nodejs.util.inspect.custom")]() {
         return `#${this.value}`;
     }
     /** Returns an EightBit with the current value, e.g. EightBit(255). */

package/dist/lib/hexcolor.d.ts

@@ -1,6 +1,5 @@
 import { Hex } from "./hex.js";
 import { EightBitColor } from "./eightbitcolor.js";
-declare const inspect: unique symbol;
 export declare class HexColor {
     /** The string representation of a hexadecimal value between 0 ("00") and 255 ("FF"). */
     value: string | null;
@@ -13,9 +12,6 @@ export declare class HexColor {
     constructor(value?: string | null);
     /** Returns the current value, e.g. "FF". */
     valueOf(): string | null;
-    /** Returns a formatted representation of the current value, e.g. "#FF". */
-    [inspect](): string;
     /** Returns an EightBit with the current value, e.g. { R: 255, G: 255, B: 255 }. */
     toEightBitColor(): EightBitColor;
 }
-export {};

package/dist/lib/hexcolor.js

@@ -1,6 +1,5 @@
 import { Hex } from "./hex.js";
 import { EightBitColor } from "./eightbitcolor.js";
-const inspect = Symbol.for("nodejs.util.inspect.custom");
 export class HexColor {
     /** The string representation of a hexadecimal value between 0 ("00") and 255 ("FF"). */
     value;
@@ -47,7 +46,7 @@ export class HexColor {
         return this.value;
     }
     /** Returns a formatted representation of the current value, e.g. "#FF". */
-    [inspect]() {
+    [Symbol.for("nodejs.util.inspect.custom")]() {
         return `#${this.value}`;
     }
     /** Returns an EightBit with the current value, e.g. { R: 255, G: 255, B: 255 }. */

package/package.json

@@ -1,20 +1,16 @@
 {
   "name": "@smockle/contrast",
-  "version": "8.0.1",
+  "version": "9.0.0",
   "description": "Analyse luminosity contrast ratio",
-  "files": [
-    "dist"
-  ],
   "type": "module",
   "main": "dist/lib/index.js",
-  "types": "dist/lib/index.d.ts",
   "bin": {
     "contrast": "dist/bin/index.js"
   },
   "scripts": {
     "build": "tsc",
-    "test": "node node_modules/jest/bin/jest.js",
-    "start": "node dist/bin/index.js"
+    "test": "NODE_OPTIONS='--no-warnings=ExperimentalWarning --experimental-vm-modules' npx jest",
+    "start": "node --no-warnings=ExperimentalWarning --experimental-vm-modules dist/bin/index.js"
   },
   "repository": {
     "type": "git",
@@ -27,33 +23,23 @@
   },
   "homepage": "https://github.com/smockle/contrast#readme",
   "devDependencies": {
-    "@types/jest": "^27.0.0",
-    "@types/node": "^20.1.0",
-    "jest": "^27.0.1",
-    "ts-jest": "^27.0.0",
-    "typescript": "^4.1.3"
-  },
-  "engines": {
-    "node": ">= 20.0.0"
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
   },
   "jest": {
     "preset": "ts-jest/presets/default-esm",
     "collectCoverage": true,
-    "testRegex": "(\\.|/)(test|spec)\\.[jt]sx?$",
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "<rootDir>/dist/"
-    ],
     "extensionsToTreatAsEsm": [
       ".ts"
     ],
-    "globals": {
-      "ts-jest": {
-        "useESM": true
-      }
-    },
+    "roots": [
+      "<rootDir>/src"
+    ],
+    "testRegex": "\\.test\\.ts$",
     "moduleNameMapper": {
-      "^(\\.\\.?\\/.+)\\.jsx?$": "$1"
+      "^(\\.{1,2}/.*)\\.js$": "$1",
+      "^@/(.*)\\.js$": "<rootDir>/src/$1"
     }
   }
 }

package/dist/__tests__/contrast.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/contrast.spec.js

@@ -1,17 +0,0 @@
-import { Contrast } from "../lib/index.js";
-import { THRESHOLD } from "./util.js";
-import { inspect } from "util";
-describe("Contrast", () => {
-    test("constructor", () => {
-        expect(new Contrast("#0080FF", "#FFFFFF").foreground.valueOf()).toEqual("0080FF");
-    });
-    test("constructor, value", () => {
-        expect(Math.abs(new Contrast("#0080FF", "#FFFFFF").value - 3.796322871580839)).toBeLessThan(THRESHOLD);
-    });
-    test("valueOf", () => {
-        expect(Math.abs(new Contrast("#0080FF", "#FFFFFF").valueOf() - 3.796322871580839)).toBeLessThan(THRESHOLD);
-    });
-    test("inspect", () => {
-        expect(inspect(new Contrast("#0080FF", "#FFFFFF"))).toEqual("3.796322871580839:1");
-    });
-});

package/dist/__tests__/eightbit.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/eightbit.spec.js

@@ -1,20 +0,0 @@
-import { EightBit } from "../lib/index.js";
-import { THRESHOLD } from "./util.js";
-import { inspect } from "util";
-describe("EightBit", () => {
-    test("constructor", () => {
-        expect(new EightBit(128).value).toEqual(128);
-    });
-    test("valueOf", () => {
-        expect(new EightBit(128).valueOf()).toEqual(128);
-    });
-    test("inspect", () => {
-        expect(inspect(new EightBit(128))).toEqual("EightBit(128)");
-    });
-    test("linearize", () => {
-        expect(Math.abs(new EightBit(128).linearize() - 0.21586050011389926)).toBeLessThan(THRESHOLD);
-    });
-    test("toHex", () => {
-        expect(inspect(new EightBit(128).toHex())).toEqual("#80");
-    });
-});

package/dist/__tests__/eightbitcolor.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/eightbitcolor.spec.js

@@ -1,27 +0,0 @@
-import { EightBit, EightBitColor } from "../lib/index.js";
-import { THRESHOLD } from "./util.js";
-import { inspect } from "util";
-describe("EightBitColor", () => {
-    test("constructor, with Number", () => {
-        expect(new EightBitColor(0, 128, 255).G.valueOf()).toEqual(128);
-    });
-    test("constructor, with EightBit", () => {
-        expect(new EightBitColor(new EightBit(0), new EightBit(128), new EightBit(255)).G.valueOf()).toEqual(128);
-    });
-    test("valueOf", () => {
-        expect(new EightBitColor(0, 128, 255).valueOf()).toEqual({
-            R: 0,
-            G: 128,
-            B: 255,
-        });
-    });
-    test("inspect", () => {
-        expect(inspect(new EightBitColor(0, 128, 255))).toEqual("rgb(0, 128, 255)");
-    });
-    test("luminosity", () => {
-        expect(Math.abs(new EightBitColor(0, 128, 255).luminosity() - 0.22658342968146072)).toBeLessThan(THRESHOLD);
-    });
-    test("toHexColor", () => {
-        expect(inspect(new EightBitColor(0, 128, 255).toHexColor())).toEqual("#0080FF");
-    });
-});

package/dist/__tests__/hex.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/hex.spec.js

@@ -1,28 +0,0 @@
-import { Hex } from "../lib/index.js";
-import { inspect } from "util";
-describe("Hex", () => {
-    test("constructor, with #", () => {
-        expect(new Hex("#FF").value).toEqual("FF");
-    });
-    test("constructor, without #", () => {
-        expect(new Hex("FF").value).toEqual("FF");
-    });
-    test("constructor, lowercase", () => {
-        expect(new Hex("ff").value).toEqual("FF");
-    });
-    test("constructor, no args", () => {
-        expect(new Hex().value).toEqual(null);
-    });
-    test("valueOf", () => {
-        expect(new Hex("#80").valueOf()).toEqual("80");
-    });
-    test("inspect", () => {
-        expect(inspect(new Hex("#80"))).toEqual("#80");
-    });
-    test("toEightBit", () => {
-        expect(new Hex("#80").toEightBit().valueOf()).toEqual(128);
-    });
-    test("toEightBit", () => {
-        expect(new Hex(null).toEightBit().valueOf()).toEqual(0);
-    });
-});

package/dist/__tests__/hexcolor.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/hexcolor.spec.js

@@ -1,48 +0,0 @@
-import { HexColor } from "../lib/index.js";
-import { inspect } from "util";
-describe("HexColor", () => {
-    test("constructor", () => {
-        expect((new HexColor("#0080FF").G || {}).valueOf()).toEqual("80");
-    });
-    test("constructor, two-length", () => {
-        expect(new HexColor("#80").value).toEqual("808080");
-    });
-    test("constructor, three-length", () => {
-        expect(new HexColor("#FC0").value).toEqual("FFCC00");
-    });
-    test("constructor, six-length", () => {
-        expect(new HexColor("#0080FF").value).toEqual("0080FF");
-    });
-    test("constructor, black", () => {
-        expect(new HexColor("black").value).toEqual("000000");
-    });
-    test("constructor, white", () => {
-        expect(new HexColor("white").value).toEqual("FFFFFF");
-    });
-    test("constructor, no args", () => {
-        expect(new HexColor().value).toEqual(null);
-    });
-    test("valueOf, inherited", () => {
-        expect(new HexColor("#0080FF").valueOf()).toEqual("0080FF");
-    });
-    test("inspect, inherited", () => {
-        expect(inspect(new HexColor("#0080FF"))).toEqual("#0080FF");
-    });
-    test("toEightBit, removed", () => {
-        expect(Object.getPrototypeOf(new HexColor("#0080FF"))).not.toHaveProperty("toEightBit");
-    });
-    test("toEightBitColor", () => {
-        expect(new HexColor("#0080FF").toEightBitColor().valueOf()).toEqual({
-            R: 0,
-            G: 128,
-            B: 255,
-        });
-    });
-    test("toEightBitColor", () => {
-        expect(new HexColor(null).toEightBitColor().valueOf()).toEqual({
-            R: 0,
-            G: 0,
-            B: 0,
-        });
-    });
-});

package/dist/__tests__/util.d.ts

@@ -1,2 +0,0 @@
-/** Tolerance for comparing floating point numbers. */
-export declare const THRESHOLD: number;

package/dist/__tests__/util.js

@@ -1,2 +0,0 @@
-/** Tolerance for comparing floating point numbers. */
-export const THRESHOLD = 0.000001;