chalker 1.3.0 → 2.0.0

package/LICENSE

@@ -1,11 +1,201 @@
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
- http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Joel Chen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,4 @@
-[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
-[![Dependency Status][daviddm-image]][daviddm-url] [![devDependency Status][daviddm-dev-image]][daviddm-dev-url]
+[![NPM version][npm-image]][npm-url]
 
 # chalker
 
@@ -8,7 +7,7 @@ Set ansi colors in strings using `<>` markers and [chalk] or [ansi-colors].
 # Usage
 
 ```js
-const chalker = require("chalker");
+import chalker from "chalker";
 
 console.log(chalker("<red.bgGreen>Red on Green Text</>"));
 
@@ -110,7 +109,7 @@ chalker(str, [chalkInstance]);
 
 - `str` - String with chalker color markers
 - `chalkInstance` - Optional custom instance of [chalk].
-  - ie: created from `new chalk.constructor({level: 2})`
+  - ie: created from `new chalk.Instance({level: 2})`
 
 **Returns:** A string with terminal/ansi color codes
 
@@ -119,12 +118,21 @@ chalker(str, [chalkInstance]);
 ### `chalker.CHALK`
 
 ```js
-chalker.CHALK = require("ansi-colors");
+import ansiColors from "ansi-colors";
+chalker.CHALK = ansiColors;
 ```
 
 Set the default colors library. By default, `chalker` loads `chalk` first and falls back to
 [ansi-colors].
 
+> `chalker` is published as an ESM-only package (`"type": "module"`). It can still be loaded
+> from CommonJS with `require("chalker")` on Node >=22.12, but since `require()` of an ESM
+> module returns the module's namespace object, you need to access `.default`:
+>
+> ```js
+> const chalker = require("chalker").default;
+> ```
+
 ### `chalker.remove`
 
 ```js
@@ -160,11 +168,5 @@ Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses
 [ansi-colors]: https://www.npmjs.com/package/ansi-colors
 [chalk]: https://www.npmjs.com/package/chalk
 [chalk advanced colors]: https://github.com/chalk/chalk#256-and-truecolor-color-support
-[travis-image]: https://travis-ci.org/jchip/chalker.svg?branch=master
-[travis-url]: https://travis-ci.org/jchip/chalker
 [npm-image]: https://badge.fury.io/js/chalker.svg
 [npm-url]: https://npmjs.org/package/chalker
-[daviddm-image]: https://david-dm.org/jchip/chalker/status.svg
-[daviddm-url]: https://david-dm.org/jchip/chalker
-[daviddm-dev-image]: https://david-dm.org/jchip/chalker/dev-status.svg
-[daviddm-dev-url]: https://david-dm.org/jchip/chalker?type=dev

package/dist/ansi-colors.d.ts

@@ -0,0 +1,4 @@
+export type { ChalkerFn } from "./core.ts";
+export { makeChalker } from "./core.ts";
+declare const _default: import("./core.ts").ChalkerFn;
+export default _default;

package/dist/ansi-colors.js

@@ -0,0 +1,14 @@
+import colors from "ansi-colors";
+import { makeChalker } from "./core.js";
+export { makeChalker } from "./core.js";
+//
+// Static entry: colors come from a hard `import` of ansi-colors.
+//
+// The ansi-colors counterpart of `chalker/chalk` - same trade: no top-level await, no
+// runtime-computed specifier, so bundlers resolve it and CJS consumers are not blocked by an
+// async module. See `./chalk.ts` for the longer rationale.
+//
+// `ansi-colors` is a peer dependency. Importing this entry without it installed is a resolve
+// error at import time, which is the intended, explicit failure.
+//
+export default makeChalker(colors);

package/dist/chalk.d.ts

@@ -0,0 +1,4 @@
+export type { ChalkerFn } from "./core.ts";
+export { makeChalker } from "./core.ts";
+declare const _default: import("./core.ts").ChalkerFn;
+export default _default;

package/dist/chalk.js

@@ -0,0 +1,18 @@
+import chalk from "chalk";
+import { makeChalker } from "./core.js";
+export { makeChalker } from "./core.js";
+//
+// Static entry: colors come from a hard `import` of chalk.
+//
+// Use this when you know chalk is there. Compared to the default entry it has no top-level
+// await and no runtime-computed specifier, which means:
+//
+// - a bundler resolves chalk statically and inlines it, instead of leaving a dynamic
+//   `import()` that fails at runtime when nothing installed chalk next to the bundle
+// - a consumer that already imports chalk itself shares that exact module instance, so there
+//   is one chalk with one color-support state rather than two
+//
+// `chalk` is a peer dependency. Importing this entry without it installed is a resolve error
+// at import time, which is the intended, explicit failure.
+//
+export default makeChalker(chalk);

package/dist/core.d.ts

@@ -0,0 +1,18 @@
+type AnyColors = any;
+export type ChalkerFn = {
+    (s?: string | readonly string[] | null, ...args: unknown[]): string;
+    remove: (s: string, keepHtml?: boolean) => string;
+    decodeHtml: (s: string) => string;
+    CHALK: AnyColors;
+};
+/**
+ * Build a chalker bound to a specific colors module.
+ *
+ * Each entry point calls this with the colors it obtained, so no two entries share mutable
+ * state: `.CHALK` belongs to the returned instance and can be reassigned on it alone.
+ *
+ * @param colors - a chalk or ansi-colors module (namespace or default export, either works)
+ * @returns the chalker function
+ */
+export declare function makeChalker(colors: AnyColors): ChalkerFn;
+export {};

package/dist/core.js

@@ -0,0 +1,256 @@
+import assert from "node:assert";
+import colorConvert from "color-convert";
+function deQuote(str, marker) {
+    const q = str[0];
+    if (q === `'` || q === `"` || q === "`") {
+        // remove enclosing quotes ', ", or ` if they are present
+        assert(str.endsWith(q), `chalk ${marker} param must be enclosed with matching quote ${q}`);
+        str = str.substr(1, str.length - 2);
+    }
+    return str;
+}
+// https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
+// https://en.wikipedia.org/wiki/Universal_Coded_Character_Set
+const htmlEntities = {
+    [`"`]: `"`,
+    [`&`]: "&",
+    [`'`]: "'",
+    [`&lt;`]: "<",
+    [`&gt;`]: ">",
+    [`&nbsp;`]: "\xa0",
+    [`&copy;`]: "\xa9",
+    [`&reg;`]: "\xae"
+};
+function normalizeColors(colorsModule) {
+    const colors = colorsModule &&
+        colorsModule.default &&
+        (typeof colorsModule.default === "function" || typeof colorsModule.default === "object")
+        ? colorsModule.default
+        : colorsModule;
+    return addAnsiColorsCompat(colors);
+}
+function addAnsiColorsCompat(colors) {
+    if (!colors || typeof colors.alias !== "function" || typeof colors.rgb === "function") {
+        return colors;
+    }
+    colors.rgb = function (r, g, b) {
+        return this[defineAnsiColor(colors, "rgb", [r, g, b])];
+    };
+    colors.bgRgb = function (r, g, b) {
+        return this[defineAnsiColor(colors, "bgRgb", [r, g, b], true)];
+    };
+    colors.hex = function (value) {
+        return this.rgb.apply(this, colorConvert.hex.rgb(value));
+    };
+    colors.bgHex = function (value) {
+        return this.bgRgb.apply(this, colorConvert.hex.rgb(value));
+    };
+    return colors;
+}
+function defineAnsiColor(colors, name, values, bg) {
+    const styleName = `chalker_${name}_${values.join("_")}`;
+    if (!colors.styles[styleName]) {
+        const prefix = bg ? 48 : 38;
+        const close = bg ? 49 : 39;
+        colors.alias(styleName, (text) => `\u001b[${prefix};2;${values.join(";")}m${text}\u001b[${close}m`);
+    }
+    return styleName;
+}
+function convertColorModel(name, values) {
+    const bg = name.startsWith("bg");
+    const model = bg ? name[2].toLowerCase() + name.substring(3) : name;
+    const rgb = model === "keyword"
+        ? colorConvert.keyword.rgb(String(values[0]).toLowerCase())
+        : colorConvert[model] && colorConvert[model].rgb.apply(colorConvert[model], values);
+    assert(rgb, `unknown color ${values[0]}`);
+    return { name: bg ? "bgRgb" : "rgb", values: rgb };
+}
+function applyChalkMethod(chalkInstance, name, values) {
+    if (typeof chalkInstance[name] === "function") {
+        return chalkInstance[name].apply(chalkInstance, values);
+    }
+    if (name === "keyword" ||
+        name === "bgKeyword" ||
+        name === "hsl" ||
+        name === "bgHsl" ||
+        name === "hsv" ||
+        name === "bgHsv" ||
+        name === "hwb" ||
+        name === "bgHwb") {
+        const converted = convertColorModel(name, values);
+        return chalkInstance[converted.name].apply(chalkInstance, converted.values);
+    }
+    throw new TypeError(`${name} is not a chalk function`);
+}
+function decodeHtml(str) {
+    return str.replace(/&[\w#]+;/g, m => {
+        if (Object.prototype.hasOwnProperty.call(htmlEntities, m))
+            return htmlEntities[m];
+        if (m.startsWith("&#x")) {
+            const s = m.substring(3, m.length - 1);
+            const p = parseInt(s, 16);
+            return String.fromCodePoint(p);
+        }
+        if (m.startsWith("&#")) {
+            const s = m.substring(2, m.length - 1);
+            const p = parseInt(s, 10);
+            return String.fromCodePoint(p);
+        }
+        return m;
+    });
+}
+function applyChalkMarkers(markers, text, userChalk) {
+    const chalkify = markers
+        .trim()
+        .split(".")
+        .reduce((a, marker) => {
+        marker = marker.trim();
+        if (a[marker]) {
+            // a basic color found
+            return a[marker];
+        }
+        else if (marker.startsWith("#")) {
+            // a hex value
+            return a.hex(marker);
+        }
+        else if ((marker[2] === "#" || marker[3] === "#") && marker.startsWith("bg")) {
+            // a bgHex value, `bg#`, `bg-#`, `bg #`
+            // no need to extract only the #HHHHHH part since chalk seems to deal with
+            // the value in the form of text#HHHHHH
+            return a.bgHex(marker);
+        }
+        const openIx = marker.indexOf("(");
+        if (openIx >= 0) {
+            // apply other advanced colors when ( is found
+            const closeIx = marker.lastIndexOf(")");
+            assert(closeIx > openIx, `marker ${marker} missing matching ()`);
+            // extract name if there're something before (
+            let name = openIx > 0 && marker.substring(0, openIx).trim();
+            // extract values within ()
+            let values = marker.substring(openIx + 1, closeIx).trim();
+            if (values.indexOf(",") >= 0) {
+                // extract rgb/hsl/hsv/hwb values like (255, 10, 20)
+                values = values.split(",").map(x => parseInt(x.trim(), 10));
+                // default no name to rgb, and bg to bgRgb
+                if (!name)
+                    name = "rgb";
+                else if (name === "bg")
+                    name = "bgRgb";
+            }
+            else {
+                // extract a string (with or without quotes) to use for keyword
+                values = [deQuote(values.trim(), marker)];
+                // default no name to keyword, and bg to bgKeyword
+                if (!name)
+                    name = "keyword";
+                else if (name === "bg")
+                    name = "bgKeyword";
+            }
+            try {
+                a = applyChalkMethod(a, name, values);
+            }
+            catch (err) {
+                throw new Error(`marker ${marker} is invalid: calling chalk.${name} failed with: ${err.message}`);
+            }
+        }
+        else {
+            // if not found as a basic color, then try with chalk.keyword or chalk.bgKeyword
+            try {
+                const kw = deQuote(marker, marker);
+                if (kw.startsWith("bg-") || kw.startsWith("bg ")) {
+                    a = applyChalkMethod(a, "bgKeyword", [kw.substring(3)]);
+                }
+                else {
+                    a = applyChalkMethod(a, "keyword", [kw]);
+                }
+            }
+            catch (err) {
+                throw new Error(`marker ${marker} is not found and invalid as a keyword`);
+            }
+        }
+        assert(a, `marker ${marker} is invalid`);
+        return a;
+    }, userChalk);
+    assert(typeof chalkify === "function", `final chalk value is not a function after applying ${markers}`);
+    return chalkify(text);
+}
+// remove the color marker like <red>text</> from strings
+function remove(s, keepHtml) {
+    const r = s.replace(/<[^>]*>/g, "").trim();
+    return keepHtml ? r : decodeHtml(r);
+}
+function format(s, instance, userChalk) {
+    // read CHALK off the instance at call time - it is public and settable
+    userChalk = normalizeColors(userChalk || instance.CHALK);
+    // skip applying ansi colors if chalk says color support is off
+    if (userChalk.supportsColor === false) {
+        return remove(s);
+    }
+    const tks = s && s.match(/(<[^>]+>|[^<>]+)/g);
+    // empty string "" result in null from match
+    // but other strings w/o matches gets ['original-string']
+    if (!tks)
+        return s || "";
+    const colorized = tks.reduceRight((a, e, ix) => {
+        const lvl = a[a.length - 1];
+        // text
+        if (e[0] !== "<") {
+            lvl.s = e + lvl.s;
+            return a;
+        }
+        // close marker
+        if (e[1] === "/") {
+            a.push({ mk: e.substring(2, e.length - 1), ix, s: "" });
+            return a;
+        }
+        // open marker
+        // markers balance check
+        if (a.length === 1) {
+            const partial = tks.slice(0, ix).join("") + `[${tks[ix]}]` + (tks.length > ix + 1 ? "..." : "");
+            throw new Error(`unbalanced open/close markers: ${partial}`);
+        }
+        // markers match check
+        const mk = e.substring(1, e.length - 1);
+        if (lvl.mk && mk !== lvl.mk) {
+            const partial = tks.slice(0, ix).join("") +
+                `[** ${tks[ix]} **]` +
+                tks.slice(ix + 1, lvl.ix).join("") +
+                `[** ${tks[lvl.ix]} **]`;
+            throw new Error(`mismatch markers: ${partial}`);
+        }
+        // apply marker and update result at previous level
+        const t = applyChalkMarkers(mk, lvl.s, userChalk);
+        a.pop();
+        const nl = a.length - 1;
+        a[nl].s = t + a[nl].s;
+        return a;
+    }, [{ s: "" }]);
+    return decodeHtml(colorized[0].s);
+}
+/**
+ * Build a chalker bound to a specific colors module.
+ *
+ * Each entry point calls this with the colors it obtained, so no two entries share mutable
+ * state: `.CHALK` belongs to the returned instance and can be reassigned on it alone.
+ *
+ * @param colors - a chalk or ansi-colors module (namespace or default export, either works)
+ * @returns the chalker function
+ */
+export function makeChalker(colors) {
+    const chalker = ((s, ...args) => {
+        if (Array.isArray(s)) {
+            // template string tagging
+            let c = "";
+            let ix;
+            for (ix = 0; ix < args.length; ix++) {
+                c = c + s[ix] + String(args[ix]);
+            }
+            return format(c + s[ix], chalker);
+        }
+        return format(s, chalker, args[0]);
+    });
+    chalker.remove = remove;
+    chalker.decodeHtml = decodeHtml;
+    chalker.CHALK = normalizeColors(colors);
+    return chalker;
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export type { ChalkerFn } from "./core.ts";
+export { makeChalker } from "./core.ts";
+declare const _default: import("./core.ts").ChalkerFn;
+export default _default;

package/dist/index.js

@@ -0,0 +1,40 @@
+import { makeOptionalImport } from "optional-import";
+import { makeChalker } from "./core.js";
+export { makeChalker } from "./core.js";
+//
+// The auto-detecting entry: take whichever of chalk / ansi-colors is installed.
+//
+// This is the historical default and stays the default. It costs a top-level await, which is
+// what makes this entry unusable from `require()` (ERR_REQUIRE_ASYNC_MODULE) and what forces a
+// bundler to leave the color module external -- the specifier is only known at runtime.
+//
+// If you know which colors module you have, import a static entry instead and pay neither cost:
+//
+//   import ck from "chalker/chalk";
+//   import ck from "chalker/ansi-colors";
+//
+// optional import from this module's own context, used to optionally load
+// chalk/ansi-colors without failing the whole module load when neither is installed.
+//
+// `import()` reaches both CJS and ESM, so this covers ESM-only chalk 5/6 as well as
+// CJS-only ansi-colors -- `createRequire` could only ever load the latter.
+const optionalImport = makeOptionalImport(import.meta);
+async function loadColors() {
+    let colors = (await optionalImport("chalk")) || (await optionalImport("ansi-colors"));
+    if (!colors) {
+        // just go for chalk and let its module-not-found error propagate
+        colors = await optionalImport("chalk", {
+            notFound: err => {
+                throw err;
+            }
+        });
+    }
+    return colors;
+}
+// top-level await: consumers that statically import chalker have their own evaluation
+// deferred until this settles, so the very first format call already has colors loaded.
+//
+// This is what makes this entry unusable from `require()` -- ERR_REQUIRE_ASYNC_MODULE. That is
+// deliberate as of 2.0; loading ESM-only chalk cannot be done synchronously, so CJS consumers
+// must use `await import("chalker")` -- or one of the static entries, which have no await.
+export default makeChalker(await loadColors());

package/package.json

@@ -1,16 +1,48 @@
 {
   "name": "chalker",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Set ansi colors in strings using XML and chalk",
-  "main": "lib/index.js",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./chalk": {
+      "types": "./dist/chalk.d.ts",
+      "default": "./dist/chalk.js"
+    },
+    "./ansi-colors": {
+      "types": "./dist/ansi-colors.d.ts",
+      "default": "./dist/ansi-colors.js"
+    },
+    "./core": {
+      "types": "./dist/core.d.ts",
+      "default": "./dist/core.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "homepage": "https://github.com/jchip/fynjs/tree/main/packages/chalker",
+  "bugs": {
+    "url": "https://github.com/jchip/fynjs/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jchip/chalker.git"
+    "url": "git+https://github.com/jchip/fynjs.git",
+    "directory": "packages/chalker"
   },
   "scripts": {
-    "test": "xrun --serial test:unit test:demo",
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "test": "npm run test:unit && npm run test:demo",
+    "ci:check": "tsc --noEmit -p tsconfig.json && npm test",
     "test:unit": "vitest run",
-    "test:demo": "xrun --serial test:demo:legacy-cjs test:demo:ansi-colors-cjs test:demo:cjs-dynamic-import test:demo:esm-default test:demo:esm-namespace test:demo:esm-create-require test:demo:esm-named-export-probe",
+    "test:demo": "npm run test:demo:legacy-cjs && npm run test:demo:ansi-colors-cjs && npm run test:demo:cjs-dynamic-import && npm run test:demo:esm-default && npm run test:demo:esm-namespace && npm run test:demo:esm-create-require && npm run test:demo:esm-named-export-probe",
     "test:demo:legacy-cjs": "cd demo/legacy-cjs && fyn install && fyn test",
     "test:demo:ansi-colors-cjs": "cd demo/ansi-colors-cjs && fyn install && fyn test",
     "test:demo:cjs-dynamic-import": "cd demo/cjs-dynamic-import && fyn install && fyn test",
@@ -18,10 +50,12 @@
     "test:demo:esm-namespace": "cd demo/esm-namespace && fyn install && fyn test",
     "test:demo:esm-create-require": "cd demo/esm-create-require && fyn install && fyn test",
     "test:demo:esm-named-export-probe": "cd demo/esm-named-export-probe && fyn install && fyn test",
-    "coverage": "vitest run --coverage"
+    "coverage": "vitest run --coverage",
+    "prepublishOnly": "npm run build",
+    "postpack": "publish-util-postpack"
   },
   "files": [
-    "lib"
+    "dist"
   ],
   "keywords": [
     "string",
@@ -37,7 +71,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "color-convert": "^2.0.1",
-    "optional-require": "^1.1.8"
+    "optional-import": "^1.0.1"
   },
   "peerDependencies": {
     "ansi-colors": ">=4",
@@ -50,17 +84,5 @@
     "chalk": {
       "optional": true
     }
-  },
-  "devDependencies": {
-    "@vitest/coverage-v8": "4.1.5",
-    "@xarc/run": "^2.3.0",
-    "ansi-colors": "^4.1.3",
-    "chalk": "^4.1.2",
-    "prettier": "^2.0.2",
-    "vitest": "4.1.5"
-  },
-  "prettier": {
-    "printWidth": 100,
-    "trailingComma": "none"
   }
 }

package/lib/index.js

@@ -1,347 +0,0 @@
-"use strict";
-
-/* eslint-disable complexity, max-statements, no-magic-numbers, prefer-template, prefer-spread */
-
-const assert = require("assert");
-const optionalRequire = require("optional-require")(require);
-const colorConvert = require("color-convert");
-const chalk = loadColors();
-
-//
-// convert color markers in a string to terminal/ansi color codes with chalk
-// color marker format is "<red>red text</red><blue.bold>blue bold text</blue.bold>"
-// the end marker can simply be "</>" also
-// the marker is converted to chalk methods directly, for example:
-// - chalk.red is called for "<red>"
-// - chalk.blue.bold is called for "<blue.bold>"
-//
-// More advanced colors can be applied with:
-//
-// <(r,g,b)>, <rgb(255,10,20)>
-// <bg(r,g,b)>, <bgRgb(255,10,20)>
-// <#FF0000>, <bg#0000FF>, <hex(#FF0000)>, <bgHex(#0000FF)>
-// <(orange)>, <keyword(orange)>, <keyword('orange')>,
-//    <keyword("orange")>, <keyword(`orange`)>
-// <bg(orange)>, <bgKeyword(orange)>, <bgKeyword('orange')>,
-//    <bgKeyword("orange")>, <bgKeyword(`orange`)>
-// <hsl(32,100,50)>, <hsv(32,100,100)>, <hwb(32,0,50)>
-//
-// any thing that's not found as a basic color is tried using chalk.keyword
-//
-// <orange>, <'orange'>, <"orange">, <`orange`>
-//
-// If it's prefixed with `"bg-"` or `"bg "` then it's tried using chalk.bgKeyword
-//
-// <bg-orange>, <bg orange>
-//
-// These can be comined with . in any order as long as they work with chalk
-//
-// ie: <#FF0000.bg#0000FF.orange.keyword()>
-//
-
-function deQuote(str, marker) {
-  const q = str[0];
-  if (q === `'` || q === `"` || q === "`") {
-    // remove enclosing quotes ', ", or ` if they are present
-    assert(str.endsWith(q), `chalk ${marker} param must be enclosed with matching quote ${q}`);
-    str = str.substr(1, str.length - 2);
-  }
-
-  return str;
-}
-
-// https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references
-// https://en.wikipedia.org/wiki/Universal_Coded_Character_Set
-
-const htmlEntities = {
-  [`&quot;`]: `"`,
-  [`&amp;`]: "&",
-  [`&apos;`]: "'",
-  [`&lt;`]: "<",
-  [`&gt;`]: ">",
-  [`&nbsp;`]: "\xa0",
-  [`&copy;`]: "\xa9",
-  [`&reg;`]: "\xae"
-};
-
-function loadColors() {
-  const colors = optionalRequire("chalk") || optionalRequire("ansi-colors");
-
-  if (!colors) {
-    throw new Error("chalker requires either chalk or ansi-colors to be installed");
-  }
-
-  return normalizeColors(colors);
-}
-
-function normalizeColors(colorsModule) {
-  const colors =
-    colorsModule &&
-    colorsModule.default &&
-    (typeof colorsModule.default === "function" || typeof colorsModule.default === "object")
-      ? colorsModule.default
-      : colorsModule;
-
-  return addAnsiColorsCompat(colors);
-}
-
-function addAnsiColorsCompat(colors) {
-  if (!colors || typeof colors.alias !== "function" || typeof colors.rgb === "function") {
-    return colors;
-  }
-
-  colors.rgb = function (r, g, b) {
-    return this[defineAnsiColor(colors, "rgb", [r, g, b])];
-  };
-  colors.bgRgb = function (r, g, b) {
-    return this[defineAnsiColor(colors, "bgRgb", [r, g, b], true)];
-  };
-  colors.hex = function (value) {
-    return this.rgb.apply(this, colorConvert.hex.rgb(value));
-  };
-  colors.bgHex = function (value) {
-    return this.bgRgb.apply(this, colorConvert.hex.rgb(value));
-  };
-
-  return colors;
-}
-
-function defineAnsiColor(colors, name, values, bg) {
-  const styleName = `chalker_${name}_${values.join("_")}`;
-
-  if (!colors.styles[styleName]) {
-    const prefix = bg ? 48 : 38;
-    const close = bg ? 49 : 39;
-    colors.alias(
-      styleName,
-      (text) => `\u001b[${prefix};2;${values.join(";")}m${text}\u001b[${close}m`
-    );
-  }
-
-  return styleName;
-}
-
-function convertColorModel(name, values) {
-  const bg = name.startsWith("bg");
-  const model = bg ? name[2].toLowerCase() + name.substring(3) : name;
-  const rgb =
-    model === "keyword"
-      ? colorConvert.keyword.rgb(String(values[0]).toLowerCase())
-      : colorConvert[model] && colorConvert[model].rgb.apply(colorConvert[model], values);
-
-  assert(rgb, `unknown color ${values[0]}`);
-
-  return { name: bg ? "bgRgb" : "rgb", values: rgb };
-}
-
-function applyChalkMethod(chalkInstance, name, values) {
-  if (typeof chalkInstance[name] === "function") {
-    return chalkInstance[name].apply(chalkInstance, values);
-  }
-
-  if (
-    name === "keyword" ||
-    name === "bgKeyword" ||
-    name === "hsl" ||
-    name === "bgHsl" ||
-    name === "hsv" ||
-    name === "bgHsv" ||
-    name === "hwb" ||
-    name === "bgHwb"
-  ) {
-    const converted = convertColorModel(name, values);
-    return chalkInstance[converted.name].apply(chalkInstance, converted.values);
-  }
-
-  throw new TypeError(`${name} is not a chalk function`);
-}
-
-function decodeHtml(str) {
-  return str.replace(/&[\w#]+;/g, (m) => {
-    if (htmlEntities.hasOwnProperty(m)) return htmlEntities[m];
-    if (m.startsWith("&#x")) {
-      const s = m.substring(3, m.length - 1);
-      const p = parseInt(s, 16);
-      return String.fromCodePoint(p);
-    }
-    if (m.startsWith("&#")) {
-      const s = m.substring(2, m.length - 1);
-      const p = parseInt(s, 10);
-      return String.fromCodePoint(p);
-    }
-    return m;
-  });
-}
-
-function applyChalkMarkers(markers, text, userChalk) {
-  const chalkify = markers
-    .trim()
-    .split(".")
-    .reduce((a, marker) => {
-      marker = marker.trim();
-
-      if (a[marker]) {
-        // a basic color found
-        return a[marker];
-      } else if (marker.startsWith("#")) {
-        // a hex value
-        return a.hex(marker);
-      } else if ((marker[2] === "#" || marker[3] === "#") && marker.startsWith("bg")) {
-        // a bgHex value, `bg#`, `bg-#`, `bg #`
-        // no need to extract only the #HHHHHH part since chalk seems to deal with
-        // the value in the form of text#HHHHHH
-        return a.bgHex(marker);
-      }
-
-      const openIx = marker.indexOf("(");
-      if (openIx >= 0) {
-        // apply other advanced colors when ( is found
-        const closeIx = marker.lastIndexOf(")");
-        assert(closeIx > openIx, `marker ${marker} missing matching ()`);
-
-        // extract name if there're something before (
-        let name = openIx > 0 && marker.substring(0, openIx).trim();
-
-        // extract values within ()
-        let values = marker.substring(openIx + 1, closeIx).trim();
-        if (values.indexOf(",") >= 0) {
-          // extract rgb/hsl/hsv/hwb values like (255, 10, 20)
-          values = values.split(",").map((x) => parseInt(x.trim(), 10));
-
-          // default no name to rgb, and bg to bgRgb
-          if (!name) name = "rgb";
-          else if (name === "bg") name = "bgRgb";
-        } else {
-          // extract a string (with or without quotes) to use for keyword
-          values = [deQuote(values.trim(), marker)];
-
-          // default no name to keyword, and bg to bgKeyword
-          if (!name) name = "keyword";
-          else if (name === "bg") name = "bgKeyword";
-        }
-
-        try {
-          a = applyChalkMethod(a, name, values);
-        } catch (err) {
-          throw new Error(
-            `marker ${marker} is invalid: calling chalk.${name} failed with: ${err.message}`
-          );
-        }
-      } else {
-        // if not found as a basic color, then try with chalk.keyword or chalk.bgKeyword
-        try {
-          const kw = deQuote(marker, marker);
-          if (kw.startsWith("bg-") || kw.startsWith("bg ")) {
-            a = applyChalkMethod(a, "bgKeyword", [kw.substring(3)]);
-          } else {
-            a = applyChalkMethod(a, "keyword", [kw]);
-          }
-        } catch (err) {
-          throw new Error(`marker ${marker} is not found and invalid as a keyword`);
-        }
-      }
-
-      assert(a, `marker ${marker} is invalid`);
-
-      return a;
-    }, userChalk);
-
-  assert(
-    typeof chalkify === "function",
-    `final chalk value is not a function after applying ${markers}`
-  );
-
-  return chalkify(text);
-}
-
-// remove the color marker like <red>text</> from strings
-function remove(s, keepHtml) {
-  const r = s.replace(/<[^>]*>/g, "").trim();
-  return keepHtml ? r : decodeHtml(r);
-}
-
-function format(s, userChalk) {
-  userChalk = normalizeColors(userChalk || chalker.CHALK);
-
-  // skip applying ansi colors if chalk says color support is off
-  if (userChalk.supportsColor === false) {
-    return remove(s);
-  }
-
-  const tks = s && s.match(/(<[^>]+>|[^<>]+)/g);
-
-  // empty string "" result in null from match
-  // but other strings w/o matches gets ['original-string']
-  if (!tks) return s || "";
-
-  const colorized = tks.reduceRight(
-    (a, e, ix) => {
-      const lvl = a[a.length - 1];
-
-      // text
-      if (e[0] !== "<") {
-        lvl.s = e + lvl.s;
-        return a;
-      }
-
-      // close marker
-      if (e[1] === "/") {
-        a.push({ mk: e.substring(2, e.length - 1), ix, s: "" });
-        return a;
-      }
-
-      // open marker
-
-      // markers balance check
-      if (a.length === 1) {
-        const partial =
-          tks.slice(0, ix).join("") + `[${tks[ix]}]` + (tks.length > ix + 1 ? "..." : "");
-        throw new Error(`unbalanced open/close markers: ${partial}`);
-      }
-
-      // markers match check
-      const mk = e.substring(1, e.length - 1);
-      if (lvl.mk && mk !== lvl.mk) {
-        const partial =
-          tks.slice(0, ix).join("") +
-          `[** ${tks[ix]} **]` +
-          tks.slice(ix + 1, lvl.ix).join("") +
-          `[** ${tks[lvl.ix]} **]`;
-        throw new Error(`mismatch markers: ${partial}`);
-      }
-
-      // apply marker and update result at previous level
-      const t = applyChalkMarkers(mk, lvl.s, userChalk);
-      a.pop();
-      const nl = a.length - 1;
-      a[nl].s = t + a[nl].s;
-
-      return a;
-    },
-    [{ s: "" }]
-  );
-
-  return decodeHtml(colorized[0].s);
-}
-
-function chalker(s, ...args) {
-  if (Array.isArray(s)) {
-    // template string tagging
-    let c = "";
-    let ix;
-    for (ix = 0; ix < args.length; ix++) {
-      c = c + s[ix] + args[ix];
-    }
-    return format(c + s[ix]);
-  }
-
-  return format(s, ...args);
-}
-
-chalker.remove = remove;
-
-chalker.decodeHtml = decodeHtml;
-
-chalker.CHALK = chalk;
-
-module.exports = chalker;