npm - @visulima/fmt - Versions diffs - 1.0.0 - Mend

@visulima/fmt 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,6 @@
+## @visulima/fmt 1.0.0 (2023-12-13)
+### Features
+* new fmt package ([#276](https://github.com/visulima/visulima/issues/276)) ([9fb141e](https://github.com/visulima/visulima/commit/9fb141e31236a3ef7b9e8bc5623dc40d8dd194db))

package/LICENSE.md ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2023 visulima
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,150 @@
+<div align="center">
+  <h3>Visulima fmt (util.format)</h3>
+  <p>
+  Util.format-like unescaped string formatting utility based on <a href="https://github.com/pinojs/quick-format-unescaped">quick-format-unescaped</a>.
+  </p>
+</div>
+<br />
+<div align="center">
+[![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]
+</div>
+---
+<div align="center">
+    <p>
+        <sup>
+            Daniel Bannert's open source work is supported by the community on <a href="https://github.com/sponsors/prisis">GitHub Sponsors</a>
+        </sup>
+    </p>
+</div>
+---
+## Install
+```sh
+npm install @visulima/fmt
+```
+```sh
+yarn add @visulima/fmt
+```
+```sh
+pnpm add @visulima/fmt
+```
+## Usage
+```typescript
+import { format } from "@visulima/fmt";
+const formatted = format("hello %s %j %d", ["world", [{ obj: true }, 4, { another: "obj" }]]);
+console.log(formatted); // hello world [{"obj":true},4,{"another":"obj"}] NaN
+```
+### format(fmt, parameters, [options])
+#### fmt
+A `printf`-like format string. Example: `'hello %s %j %d'`
+#### parameters
+Array of values to be inserted into the `format` string. Example: `['world', {obj:true}]`
+#### options.stringify
+Passing an options object as the third parameter with a `stringify` will mean
+any objects will be passed to the supplied function instead of an the
+internal `tryStringify` function. This can be useful when using augmented
+capability serializers such as [`fast-safe-stringify`](http://github.com/davidmarkclements/fast-safe-stringify) or [`fast-redact`](http://github.com/davidmarkclements/fast-redact).
+> uses `JSON.stringify` instead of `util.inspect`, this means functions _will not be serialized_.
+### build
+With the `build` function you can generate a `format` function that is optimized for your use case.
+```typescript
+import { build } from "@visulima/fmt";
+const format = build({
+    formatters: {
+        // Pass in whatever % interpolator you want, as long as it's a single character;
+        // in this case, it's `t`.
+        // The formatter should be a function that takes in a value and returns the formatted value.
+        t: (time) => new Date(time).toLocaleString(),
+    },
+});
+const formatted = format("hello %s at %t", ["world", Date.now()]);
+console.log(formatted); // hello world at 1/1/1970, 1:00:00 AM
+```
+## Format Specifiers
+Format specifiers are dependent on the type of data-elements that are to be added to the string.
+The most commonly used format specifiers supported are:
+| Specifier | Description                                                                                                                              |
+| --------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| %s        | Converts all values except for `BigInt`, `-0` and `Object` to a string.                                                                  |
+| %d        | Used to convert any value to `Number` of any type other than `BigInt` and `Symbol`.                                                      |
+| %i        | Used for all values except `BigInt` and `Symbol`.                                                                                        |
+| %f        | Used to convert a value to type `Float`. It does not support conversion of values of type `Symbol`.                                      |
+| %j        | Used to add JSON data. If a circular reference is present, the string ‘[Circular]’ is added instead.                                     |
+| %o        | Adds the string representation of an object. Note that it does not contain non-enumerable characteristics of the object.                 |
+| %O        | Adds the string representation of an object. Note that it will contain all characteristics of the object, including non-enumerable ones. |
+| %%        | Used to add the % sign.                                                                                                                  |
+## Benchmark
+```sh
+   ✓ format simple (3) 4209ms
+     name                              hz     min     max    mean     p75     p99    p995    p999     rme  samples
+   · util.format             2,443,716.24  0.0003  0.8279  0.0004  0.0004  0.0007  0.0008  0.0013  ±0.35%  1221859   fastest
+   · @visulima/fmt           2,425,903.43  0.0004  0.1525  0.0004  0.0004  0.0005  0.0006  0.0008  ±0.25%  1212952
+   · quick-format-unescaped  1,770,792.34  0.0005  0.3075  0.0006  0.0006  0.0006  0.0006  0.0009  ±0.30%   885397   slowest
+   ✓ format tail object (3) 4922ms
+     name                              hz     min     max    mean     p75     p99    p995    p999     rme  samples
+   · util.format             1,005,974.84  0.0009  0.1501  0.0010  0.0010  0.0013  0.0018  0.0022  ±0.28%   502988   slowest
+   · @visulima/fmt           3,082,590.54  0.0003  0.1489  0.0003  0.0003  0.0004  0.0005  0.0006  ±0.30%  1541296   fastest
+   · quick-format-unescaped  2,164,780.43  0.0004  0.1654  0.0005  0.0005  0.0005  0.0006  0.0008  ±0.25%  1082391
+```
+## Supported Node.js Versions
+Libraries in this ecosystem make the best effort to track [Node.js’ release schedule](https://github.com/nodejs/release#release-schedule).
+Here’s [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a).
+## Contributing
+If you would like to help take a look at the [list of issues](https://github.com/visulima/visulima/issues) and check our [Contributing](.github/CONTRIBUTING.md) guild.
+> **Note:** please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+## Credits
+-   [quick-format-unescaped](https://github.com/pinojs/quick-format-unescaped)
+-   [Daniel Bannert](https://github.com/prisis)
+-   [All Contributors](https://github.com/visulima/visulima/graphs/contributors)
+## License
+The visulima fmt is open-sourced software licensed under the [MIT][license-url]
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+[typescript-url]: "typescript"
+[license-image]: https://img.shields.io/npm/l/@visulima/fmt?color=blueviolet&style=for-the-badge
+[license-url]: LICENSE.md "license"
+[npm-image]: https://img.shields.io/npm/v/@visulima/fmt/latest.svg?style=for-the-badge&logo=npm
+[npm-url]: https://www.npmjs.com/package/@visulima/fmt/v/latest "npm"

package/dist/index.d.mts ADDED Viewed

@@ -0,0 +1,10 @@
+declare const format: (fmt: NonNullable<Record<string, any> | string>, arguments_?: any[], options?: Options) => string;
+declare const build: (options?: Options) => (f: NonNullable<Record<string, any> | string>, arguments_?: any[], formatOptions?: Omit<Options, "formatters">) => string;
+type FormatterFunction = (argument: any) => string;
+type FormatterMap = Record<number, FormatterFunction>;
+interface Options {
+    formatters?: Record<string, FormatterFunction>;
+    stringify?: (o: any) => string;
+}
+export { type FormatterFunction, type FormatterMap, type Options, build, format };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+declare const format: (fmt: NonNullable<Record<string, any> | string>, arguments_?: any[], options?: Options) => string;
+declare const build: (options?: Options) => (f: NonNullable<Record<string, any> | string>, arguments_?: any[], formatOptions?: Omit<Options, "formatters">) => string;
+type FormatterFunction = (argument: any) => string;
+type FormatterMap = Record<number, FormatterFunction>;
+interface Options {
+    formatters?: Record<string, FormatterFunction>;
+    stringify?: (o: any) => string;
+}
+export { type FormatterFunction, type FormatterMap, type Options, build, format };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,8 @@
+'use strict';
+var p=e=>{try{return JSON.stringify(e)}catch{return '"[Circular]"'}},u="%".codePointAt(0),g="s".codePointAt(0),d="d".codePointAt(0),h="f".codePointAt(0),b="i".codePointAt(0),A="O".codePointAt(0),k="o".codePointAt(0),F="j".codePointAt(0),P=(e,n=[],s={})=>{if(typeof e!="string"&&typeof e!="object"||e===null)throw new TypeError(`fmt must be a string or object, got ${e===null?"null":typeof e}`);let c=s.stringify??p,f=1;if(typeof e=="object"){let t=n.length+f;if(t===1)return "{}";let l=Array.from({length:t});l[0]=c(e);for(let a=1;a<t;a++)l[a]=c(n[a-f]);return l.join(" ")}if(n.length===0)return e;let i="",r=1-f,o=-1;for(let t=0;t<e.length;){if(e.codePointAt(t)===u&&t+1<e.length){o=o>-1?o:0;let l=e.codePointAt(t+1);if(l===void 0){++r;break}switch(l){case d:case h:{if(r>=n.length||n[r]==null)break;o<t&&(i+=e.slice(o,t)),i+=Number(n[r]).toString(),o=t+2,t++;break}case b:{if(r>=n.length||n[r]==null)break;o<t&&(i+=e.slice(o,t)),i+=Math.floor(Number(n[r])).toString(),o=t+2,t++;break}case A:case k:case F:{if(r>=n.length||n[r]===void 0)break;o<t&&(i+=e.slice(o,t));let a=n[r],y=typeof a;if(y==="string"){i+=`'${a}'`,o=t+2;break}if(y==="function"){i+=a.name?`[Function: ${a.name}]`:"[Function: <anonymous>]",o=t+2;break}i+=c(a),o=t+2,t++;break}case g:{if(r>=n.length)break;o<t&&(i+=e.slice(o,t)),i+=typeof n[r]=="object"?c(n[r]):String(n[r]),o=t+2,t++;break}case u:{o<t&&(i+=e.slice(o,t)),i+="%",o=t+2,t++,r--;break}}typeof s.formatters?.[l]=="function"&&(i+=s.formatters[l](n[r]),o=t+2),++r;}++t;}return o===-1?e:(o<e.length&&(i+=e.slice(o)),i)},O=(e={})=>{let n={};return typeof e.formatters=="object"&&Object.entries(e.formatters).forEach(([s,c])=>{if(s.length===0)throw new Error(`Formatter %${s} has no characters`);if(s.length>1)throw new Error(`Formatter %${s} has more than one character`);if(typeof c!="function")throw new TypeError(`Formatter for %${s} is not a function`);let f=s.codePointAt(0);if(f===void 0)throw new Error(`${s}.codePointAt(0) failed to return a value, please report this issue`);n[f]=c;}),(s,c=[],f={})=>P(s,c,{...f,formatters:n})};
+exports.build = O;
+exports.format = P;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../src/index.ts"],"names":["tryStringify","o","CHAR_PERCENT","CHAR_s","CHAR_d","CHAR_f","CHAR_i","CHAR_O","CHAR_o","CHAR_j","format","fmt","arguments_","options","stringify","offset","argumentsLength","objects","index","result","a","lastPosition","c","temporaryArgument","type","build","formatters","key","formatterFunction","f","formatOptions"],"mappings":"AACA,IAAMA,EAAgBC,GAAmB,CACrC,GAAI,CACA,OAAO,KAAK,UAAUA,CAAC,CAC3B,MAAQ,CACJ,MAAO,cACX,CACJ,EAEMC,EAAe,IAAI,YAAY,CAAC,EAEhCC,EAAS,IAAI,YAAY,CAAC,EAE1BC,EAAS,IAAI,YAAY,CAAC,EAE1BC,EAAS,IAAI,YAAY,CAAC,EAE1BC,EAAS,IAAI,YAAY,CAAC,EAC1BC,EAAS,IAAI,YAAY,CAAC,EAE1BC,EAAS,IAAI,YAAY,CAAC,EAE1BC,EAAS,IAAI,YAAY,CAAC,EAGnBC,EAAS,CAACC,EAAgDC,EAAoB,CAAC,EAAGC,EAAmB,CAAC,IAAc,CAE7H,GAAK,OAAOF,GAAQ,UAAY,OAAOA,GAAQ,UAAaA,IAAQ,KAEhE,MAAM,IAAI,UAAU,uCAAuCA,IAAQ,KAAO,OAAS,OAAOA,CAAG,EAAE,EAGnG,IAAMG,EAAYD,EAAQ,WAAab,EACjCe,EAAS,EAEf,GAAI,OAAOJ,GAAQ,SAAU,CACzB,IAAMK,EAAkBJ,EAAW,OAASG,EAE5C,GAAIC,IAAoB,EACpB,MAAO,KAGX,IAAMC,EAAU,MAAM,KAAK,CAAE,OAAQD,CAAgB,CAAC,EAEtDC,EAAQ,CAAC,EAAIH,EAAUH,CAAG,EAE1B,QAASO,EAAQ,EAAGA,EAAQF,EAAiBE,IAEzCD,EAAQC,CAAK,EAAIJ,EAAUF,EAAWM,EAAQH,CAAM,CAAC,EAGzD,OAAOE,EAAQ,KAAK,GAAG,CAC3B,CAEA,GAAIL,EAAW,SAAW,EACtB,OAAOD,EAGX,IAAIQ,EAAS,GACTC,EAAI,EAAIL,EACRM,EAAe,GAEnB,QAASH,EAAQ,EAAGA,EAAQP,EAAI,QAAU,CACtC,GAAIA,EAAI,YAAYO,CAAK,IAAMhB,GAAgBgB,EAAQ,EAAIP,EAAI,OAAQ,CACnEU,EAAeA,EAAe,GAAKA,EAAe,EAElD,IAAMC,EAAIX,EAAI,YAAYO,EAAQ,CAAC,EAEnC,GAAII,IAAM,OAAW,CACjB,EAAEF,EACF,KACJ,CAGA,OAAQE,EAAG,CACP,KAAKlB,EACL,KAAKC,EAAQ,CACT,GAAIe,GAAKR,EAAW,QAAUA,EAAWQ,CAA4B,GAAK,KACtE,MAGAC,EAAeH,IACfC,GAAUR,EAAI,MAAMU,EAAcH,CAAK,GAG3CC,GAAU,OAAOP,EAAWQ,CAA4B,CAAC,EAAE,SAAS,EACpEC,EAAeH,EAAQ,EAEvBA,IACA,KACJ,CACA,KAAKZ,EAAQ,CACT,GAAIc,GAAKR,EAAW,QAAUA,EAAWQ,CAA4B,GAAK,KACtE,MAGAC,EAAeH,IACfC,GAAUR,EAAI,MAAMU,EAAcH,CAAK,GAG3CC,GAAU,KAAK,MAAM,OAAOP,EAAWQ,CAA4B,CAAC,CAAC,EAAE,SAAS,EAChFC,EAAeH,EAAQ,EAEvBA,IACA,KACJ,CACA,KAAKX,EACL,KAAKC,EACL,KAAKC,EAAQ,CACT,GAAIW,GAAKR,EAAW,QAAUA,EAAWQ,CAA4B,IAAM,OACvE,MAGAC,EAAeH,IACfC,GAAUR,EAAI,MAAMU,EAAcH,CAAK,GAI3C,IAAMK,EAAoBX,EAAWQ,CAA4B,EAC3DI,EAAO,OAAOD,EAEpB,GAAIC,IAAS,SAAU,CACnBL,GAAU,IAAII,CAAiB,IAC/BF,EAAeH,EAAQ,EACvB,KACJ,CAEA,GAAIM,IAAS,WAAY,CAErBL,GAAWI,EAA+B,KAAO,cAAeA,EAA+B,IAAI,IAAM,0BACzGF,EAAeH,EAAQ,EACvB,KACJ,CAEAC,GAAUL,EAAUS,CAAiB,EACrCF,EAAeH,EAAQ,EAEvBA,IACA,KACJ,CACA,KAAKf,EAAQ,CACT,GAAIiB,GAAKR,EAAW,OAChB,MAGAS,EAAeH,IACfC,GAAUR,EAAI,MAAMU,EAAcH,CAAK,GAG3CC,GACI,OAAOP,EAAWQ,CAA4B,GAAM,SAC9CN,EAAUF,EAAWQ,CAA4B,CAAC,EAClD,OAAOR,EAAWQ,CAA4B,CAAC,EACzDC,EAAeH,EAAQ,EAEvBA,IACA,KACJ,CACA,KAAKhB,EAAc,CACXmB,EAAeH,IACfC,GAAUR,EAAI,MAAMU,EAAcH,CAAK,GAG3CC,GAAU,IACVE,EAAeH,EAAQ,EAEvBA,IACAE,IACA,KACJ,CACJ,CAGI,OAAOP,EAAQ,aAAaS,CAAC,GAAM,aAEnCH,GAAWN,EAAQ,WAAWS,CAAC,EAAwBV,EAAWQ,CAA4B,CAAC,EAC/FC,EAAeH,EAAQ,GAG3B,EAAEE,CACN,CAEA,EAAEF,CACN,CAEA,OAAIG,IAAiB,GACVV,GAGPU,EAAeV,EAAI,SACnBQ,GAAUR,EAAI,MAAMU,CAAY,GAG7BF,EACX,EAEaM,EAAQ,CACjBZ,EAAmB,CAAC,IAE0G,CAC9H,IAAMa,EAA2B,CAAC,EAElC,OAAI,OAAOb,EAAQ,YAAe,UAC9B,OAAO,QAAQA,EAAQ,UAAU,EAAE,QAAQ,CAAC,CAACc,EAAKC,CAAiB,IAAM,CACrE,GAAID,EAAI,SAAW,EACf,MAAM,IAAI,MAAM,cAAcA,CAAG,oBAAoB,EAGzD,GAAIA,EAAI,OAAS,EACb,MAAM,IAAI,MAAM,cAAcA,CAAG,8BAA8B,EAGnE,GAAI,OAAOC,GAAsB,WAC7B,MAAM,IAAI,UAAU,kBAAkBD,CAAG,oBAAoB,EAGjE,IAAML,EAAIK,EAAI,YAAY,CAAC,EAE3B,GAAIL,IAAM,OACN,MAAM,IAAI,MAAM,GAAGK,CAAG,oEAAoE,EAI9FD,EAAWJ,CAAC,EAAIM,CACpB,CAAC,EAIE,CAACC,EAA8CjB,EAAoB,CAAC,EAAGkB,EAA6C,CAAC,IACxHpB,EAAOmB,EAAGjB,EAAY,CAAE,GAAGkB,EAAe,WAAAJ,CAAW,CAAC,CAC9D","sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst tryStringify = (o: any): string => {\n try {\n return JSON.stringify(o);\n } catch {\n return '\"[Circular]\"';\n }\n};\n\nconst CHAR_PERCENT = \"%\".codePointAt(0);\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst CHAR_s = \"s\".codePointAt(0);\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst CHAR_d = \"d\".codePointAt(0);\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst CHAR_f = \"f\".codePointAt(0);\n// eslint-disable-next-line @typescript-eslint/naming-convention,unicorn/prevent-abbreviations\nconst CHAR_i = \"i\".codePointAt(0);\nconst CHAR_O = \"O\".codePointAt(0);\n// eslint-disable-next-line @typescript-eslint/naming-convention\nconst CHAR_o = \"o\".codePointAt(0);\n// eslint-disable-next-line @typescript-eslint/naming-convention,unicorn/prevent-abbreviations\nconst CHAR_j = \"j\".codePointAt(0);\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any,sonarjs/cognitive-complexity\nexport const format = (fmt: NonNullable<Record<string, any> | string>, arguments_: any[] = [], options: Options = {}): string => {\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if ((typeof fmt !== \"string\" && typeof fmt !== \"object\") || fmt === null) {\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n throw new TypeError(`fmt must be a string or object, got ${fmt === null ? \"null\" : typeof fmt}`);\n }\n\n const stringify = options.stringify ?? tryStringify;\n const offset = 1;\n\n if (typeof fmt === \"object\") {\n const argumentsLength = arguments_.length + offset;\n\n if (argumentsLength === 1) {\n return \"{}\";\n }\n\n const objects = Array.from({ length: argumentsLength });\n\n objects[0] = stringify(fmt);\n\n for (let index = 1; index < argumentsLength; index++) {\n // eslint-disable-next-line security/detect-object-injection\n objects[index] = stringify(arguments_[index - offset]);\n }\n\n return objects.join(\" \");\n }\n\n if (arguments_.length === 0) {\n return fmt;\n }\n\n let result = \"\";\n let a = 1 - offset;\n let lastPosition = -1;\n\n for (let index = 0; index < fmt.length; ) {\n if (fmt.codePointAt(index) === CHAR_PERCENT && index + 1 < fmt.length) {\n lastPosition = lastPosition > -1 ? lastPosition : 0;\n\n const c = fmt.codePointAt(index + 1);\n\n if (c === undefined) {\n ++a;\n break;\n }\n\n // eslint-disable-next-line default-case\n switch (c) {\n case CHAR_d:\n case CHAR_f: {\n if (a >= arguments_.length || arguments_[a as keyof typeof arguments_] == null) {\n break;\n }\n\n if (lastPosition < index) {\n result += fmt.slice(lastPosition, index);\n }\n\n result += Number(arguments_[a as keyof typeof arguments_]).toString();\n lastPosition = index + 2;\n\n index++;\n break;\n }\n case CHAR_i: {\n if (a >= arguments_.length || arguments_[a as keyof typeof arguments_] == null) {\n break;\n }\n\n if (lastPosition < index) {\n result += fmt.slice(lastPosition, index);\n }\n\n result += Math.floor(Number(arguments_[a as keyof typeof arguments_])).toString();\n lastPosition = index + 2;\n\n index++;\n break;\n }\n case CHAR_O:\n case CHAR_o:\n case CHAR_j: {\n if (a >= arguments_.length || arguments_[a as keyof typeof arguments_] === undefined) {\n break;\n }\n\n if (lastPosition < index) {\n result += fmt.slice(lastPosition, index);\n }\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n const temporaryArgument = arguments_[a as keyof typeof arguments_];\n const type = typeof temporaryArgument;\n\n if (type === \"string\") {\n result += `'${temporaryArgument}'`;\n lastPosition = index + 2;\n break;\n }\n\n if (type === \"function\") {\n // eslint-disable-next-line @typescript-eslint/ban-types\n result += (temporaryArgument as Function).name ? `[Function: ${(temporaryArgument as Function).name}]` : \"[Function: <anonymous>]\";\n lastPosition = index + 2;\n break;\n }\n\n result += stringify(temporaryArgument);\n lastPosition = index + 2;\n\n index++;\n break;\n }\n case CHAR_s: {\n if (a >= arguments_.length) {\n break;\n }\n\n if (lastPosition < index) {\n result += fmt.slice(lastPosition, index);\n }\n\n result +=\n typeof arguments_[a as keyof typeof arguments_] === \"object\"\n ? stringify(arguments_[a as keyof typeof arguments_])\n : String(arguments_[a as keyof typeof arguments_]);\n lastPosition = index + 2;\n\n index++;\n break;\n }\n case CHAR_PERCENT: {\n if (lastPosition < index) {\n result += fmt.slice(lastPosition, index);\n }\n\n result += \"%\";\n lastPosition = index + 2;\n\n index++;\n a--;\n break;\n }\n }\n\n // eslint-disable-next-line security/detect-object-injection\n if (typeof options.formatters?.[c] === \"function\") {\n // eslint-disable-next-line security/detect-object-injection\n result += (options.formatters[c] as FormatterFunction)(arguments_[a as keyof typeof arguments_]);\n lastPosition = index + 2;\n }\n\n ++a;\n }\n\n ++index;\n }\n\n if (lastPosition === -1) {\n return fmt;\n }\n\n if (lastPosition < fmt.length) {\n result += fmt.slice(lastPosition);\n }\n\n return result;\n};\n\nexport const build = (\n options: Options = {},\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): ((f: NonNullable<Record<string, any> | string>, arguments_?: any[], formatOptions?: Omit<Options, \"formatters\">) => string) => {\n const formatters: FormatterMap = {};\n\n if (typeof options.formatters === \"object\") {\n Object.entries(options.formatters).forEach(([key, formatterFunction]) => {\n if (key.length === 0) {\n throw new Error(`Formatter %${key} has no characters`);\n }\n\n if (key.length > 1) {\n throw new Error(`Formatter %${key} has more than one character`);\n }\n\n if (typeof formatterFunction !== \"function\") {\n throw new TypeError(`Formatter for %${key} is not a function`);\n }\n\n const c = key.codePointAt(0);\n\n if (c === undefined) {\n throw new Error(`${key}.codePointAt(0) failed to return a value, please report this issue`);\n }\n\n // eslint-disable-next-line security/detect-object-injection\n formatters[c] = formatterFunction;\n });\n }\n\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n return (f: NonNullable<Record<string, any> | string>, arguments_: any[] = [], formatOptions: Omit<Options, \"formatters\"> = {}) =>\n format(f, arguments_, { ...formatOptions, formatters });\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type FormatterFunction = (argument: any) => string;\nexport type FormatterMap = Record<number, FormatterFunction>;\n\nexport interface Options {\n formatters?: Record<string, FormatterFunction>;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n stringify?: (o: any) => string;\n}\n"]}

package/dist/index.mjs ADDED Viewed

@@ -0,0 +1,5 @@
+var p=e=>{try{return JSON.stringify(e)}catch{return '"[Circular]"'}},u="%".codePointAt(0),g="s".codePointAt(0),d="d".codePointAt(0),h="f".codePointAt(0),b="i".codePointAt(0),A="O".codePointAt(0),k="o".codePointAt(0),F="j".codePointAt(0),P=(e,n=[],s={})=>{if(typeof e!="string"&&typeof e!="object"||e===null)throw new TypeError(`fmt must be a string or object, got ${e===null?"null":typeof e}`);let c=s.stringify??p,f=1;if(typeof e=="object"){let t=n.length+f;if(t===1)return "{}";let l=Array.from({length:t});l[0]=c(e);for(let a=1;a<t;a++)l[a]=c(n[a-f]);return l.join(" ")}if(n.length===0)return e;let i="",r=1-f,o=-1;for(let t=0;t<e.length;){if(e.codePointAt(t)===u&&t+1<e.length){o=o>-1?o:0;let l=e.codePointAt(t+1);if(l===void 0){++r;break}switch(l){case d:case h:{if(r>=n.length||n[r]==null)break;o<t&&(i+=e.slice(o,t)),i+=Number(n[r]).toString(),o=t+2,t++;break}case b:{if(r>=n.length||n[r]==null)break;o<t&&(i+=e.slice(o,t)),i+=Math.floor(Number(n[r])).toString(),o=t+2,t++;break}case A:case k:case F:{if(r>=n.length||n[r]===void 0)break;o<t&&(i+=e.slice(o,t));let a=n[r],y=typeof a;if(y==="string"){i+=`'${a}'`,o=t+2;break}if(y==="function"){i+=a.name?`[Function: ${a.name}]`:"[Function: <anonymous>]",o=t+2;break}i+=c(a),o=t+2,t++;break}case g:{if(r>=n.length)break;o<t&&(i+=e.slice(o,t)),i+=typeof n[r]=="object"?c(n[r]):String(n[r]),o=t+2,t++;break}case u:{o<t&&(i+=e.slice(o,t)),i+="%",o=t+2,t++,r--;break}}typeof s.formatters?.[l]=="function"&&(i+=s.formatters[l](n[r]),o=t+2),++r;}++t;}return o===-1?e:(o<e.length&&(i+=e.slice(o)),i)},w=(e={})=>{let n={};return typeof e.formatters=="object"&&Object.entries(e.formatters).forEach(([s,c])=>{if(s.length===0)throw new Error(`Formatter %${s} has no characters`);if(s.length>1)throw new Error(`Formatter %${s} has more than one character`);if(typeof c!="function")throw new TypeError(`Formatter for %${s} is not a function`);let f=s.codePointAt(0);if(f===void 0)throw new Error(`${s}.codePointAt(0) failed to return a value, please report this issue`);n[f]=c;}),(s,c=[],f={})=>P(s,c,{...f,formatters:n})};
+export { w as build, P as format };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,124 @@
+{
+    "name": "@visulima/fmt",
+    "version": "1.0.0",
+    "description": "Util.format-like string formatting utility.",
+    "keywords": [
+        "visulima",
+        "anolilab",
+        "fmt",
+        "util",
+        "util.format",
+        "format",
+        "string",
+        "formatting",
+        "string-format",
+        "quick-format-unescaped"
+    ],
+    "homepage": "https://www.visulima.com/docs/package/fmt",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/visulima/visulima.git",
+        "directory": "packages/fmt"
+    },
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/prisis"
+        },
+        {
+            "type": "consulting",
+            "url": "https://anolilab.com/support"
+        }
+    ],
+    "license": "MIT",
+    "author": {
+        "name": "Daniel Bannert",
+        "email": "d.bannert@anolilab.de"
+    },
+    "sideEffects": false,
+    "exports": {
+        ".": {
+            "require": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            },
+            "import": {
+                "types": "./dist/index.d.mts",
+                "default": "./dist/index.mjs"
+            }
+        },
+        "./package.json": "./package.json"
+    },
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "source": "src/index.ts",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist/**",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE.md"
+    ],
+    "scripts": {
+        "build": "cross-env NODE_ENV=development tsup",
+        "build:prod": "cross-env NODE_ENV=production tsup",
+        "clean": "rimraf node_modules dist .eslintcache",
+        "dev": "pnpm run build --watch",
+        "lint:eslint": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.js",
+        "lint:eslint:fix": "eslint . --ext js,cjs,mjs,jsx,ts,tsx,json,yaml,yml,md,mdx --max-warnings=0 --config .eslintrc.js --fix",
+        "lint:packagejson": "publint --strict",
+        "lint:prettier": "prettier --config=.prettierrc.js --check .",
+        "lint:prettier:fix": "prettier --config=.prettierrc.js --write .",
+        "lint:types": "tsc --noEmit",
+        "test": "vitest run",
+        "test:bench": "vitest bench",
+        "test:coverage": "vitest run --coverage",
+        "test:ui": "vitest --ui --coverage.enabled=true",
+        "test:watch": "vitest"
+    },
+    "devDependencies": {
+        "@anolilab/eslint-config": "^15.0.2",
+        "@anolilab/prettier-config": "^5.0.13",
+        "@anolilab/semantic-release-preset": "^8.0.2",
+        "@babel/core": "^7.23.5",
+        "@rushstack/eslint-plugin-security": "^0.7.1",
+        "@types/node": "18.18.8",
+        "@vitest/coverage-v8": "^1.0.2",
+        "@vitest/ui": "^1.0.2",
+        "cross-env": "^7.0.3",
+        "eslint": "^8.55.0",
+        "eslint-plugin-deprecation": "^2.0.0",
+        "eslint-plugin-etc": "^2.0.3",
+        "eslint-plugin-import": "npm:eslint-plugin-i@^2.29.0",
+        "eslint-plugin-mdx": "^2.2.0",
+        "eslint-plugin-vitest": "^0.3.10",
+        "eslint-plugin-vitest-globals": "^1.4.0",
+        "prettier": "^3.1.0",
+        "quick-format-unescaped": "^4.0.4",
+        "rimraf": "^5.0.5",
+        "semantic-release": "^22.0.10",
+        "sort-package-json": "^2.6.0",
+        "tsup": "^8.0.1",
+        "typescript": "^5.3.3",
+        "vitest": "^1.0.2"
+    },
+    "engines": {
+        "node": ">=18.* <=21.*"
+    },
+    "publishConfig": {
+        "access": "public",
+        "provenance": true
+    },
+    "anolilab": {
+        "eslint-config": {
+            "plugin": {
+                "tsdoc": false
+            },
+            "warn_on_unsupported_typescript_version": false,
+            "info_on_disabling_jsx_react_rule": false,
+            "info_on_disabling_prettier_conflict_rule": false,
+            "info_on_disabling_jsonc_sort_keys_rule": false,
+            "info_on_disabling_etc_no_deprecated": false
+        }
+    }
+}