@ix-xs/node-comfort 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -4,6 +4,155 @@ All notable changes to this project are documented here. The format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
 [Semantic Versioning](https://semver.org/).
 
+## [2.1.0] - 2026-10-12
+
+Every module was read again, line by line. The result: about sixty new functions and options, a hot path
+that is several times faster almost everywhere, a long list of edge cases fixed, and a new documentation
+website. Nothing has to change in a project that used 2.0 the documented way. The few behaviours that
+did change are listed under "Changed".
+
+### Added
+
+- **logger**: `redact` hides the keys you name in everything that is logged, `onLog` receives each entry
+  (`LogEntry`) to forward it to another service, and `DEBUG=db,http:*` chooses which scopes print their
+  debug lines.
+- **fs**: `fs.findUp()` (also `nc.findUp()`) walks up the folders to find a file, `writeFile()` and
+  `writeJSON()` take `fsync` to wait for the disk, and watchers emit `"error"`.
+- **checker**: `isHostname`, `isMACAddress`, `isIBAN`, `isE164`, `isObjectId`, `isULID`, `isDataURL`,
+  `isMimeType`, `isTimeZone`, `isLocale`, `isCron` and `isASCII`.
+- **env**: `env.example()` writes a `.env.example` from your specification, and `load({ cascade })` reads
+  `.env`, `.env.local`, `.env.{mode}` and `.env.{mode}.local` in the usual order.
+- **schema**: `pipe()`, `discriminatedUnion()`, `toJSONSchema()`, object `required()`, `merge()` and
+  `keyof()`, number `gt()`, `lt()` and `safe()`, string `date()`, `slug()`, `hex()`, `base64()`, `ulid()`,
+  `semver()` and `hostname()`. `safeParse()` gives the list of `issues` without building an error.
+- **http**: `params` fills a path such as `"users/:id"`, `schema` validates the response and gives
+  `data` its type,
+  `cookies` lists every `Set-Cookie`, headers can be a `Headers` object or pairs, and retries take `jitter`
+  and text delays (`"2s"`).
+- **SQLite**: filters and sorts on JSON paths (`"settings.theme"`), `paginate()`, `increment()`,
+  `onConflict` for `insert()` and `insertMany()`, `defaultExpression` for columns,
+  `transaction({ immediate })`, a `synchronous` option, and reads from views and temporary tables.
+- **time**: `time.parse()` reads a date from text with a pattern, `isSame()`, `range()`, `fromUnix()`, the
+  `Do` and `z` tokens, and `formatDuration()` accepts text such as `"90m"`.
+- **id**: `uuidv5()`, `objectId()` and `prefixed()`.
+- **crypto**: `verifyHmac()` for webhook signatures, `generateKeyPair()`, and JSON Web Tokens signed with
+  RSA, ECDSA or Ed25519 keys (`RS256`, `PS256`, `ES256`, `EdDSA`...).
+- **cli**: `cli.tree()`, `cli.spin()` runs a promise under a spinner, `args()` learns commands
+  (`commands`), `env` fallbacks, `examples` in the help and `choices` for numbers. Tables accept cells of
+  several lines. Menus understand Home, End, Page Up, Page Down and Escape.
+- **color**: `color.truncate()` cuts colored text to a width without breaking its colors.
+- **sys**: `shutdown()`, `freePort()` and `localIP()`.
+- **func**: `batch()` groups calls into one, `dedupe()` shares a call that is already running, and
+  `pipeAsync()`.
+- **async**: `parallel()`, `rateLimit()` and `abortable()`.
+- **Cache**: `getOrSet(..., { staleWhileRevalidate })` answers with the old value while the new one loads,
+  and `resetStats()`.
+- **Emitter**: `on()` and `once()` take `{ signal }`, and `listeners()`.
+- **str**: `upperFirst`, `lowerFirst`, `humanize` and `chunk`. **num**: `pad`, `percentChange` and
+  `product`. **arr**: `duplicates`, `xor`, `takeWhile`, `dropWhile` and `toSentence`. **obj**: `update`,
+  `sortKeys` and `paths`.
+- **Durations are text everywhere.** The last options that only took milliseconds (`debounce`, `throttle`,
+  `memoize`, `retry`, `timeout`, `delay`, `waitFor`...) accept `"5m"` or `"1.5s"` like the rest of the
+  package.
+- Errors serialize with `JSON.stringify()` (name, code, message, fields and cause), and `instanceof` works
+  across two copies of the package.
+
+### Faster
+
+Measured on the same machine, before and after, with Node 24.
+
+| Operation | Speedup |
+| --- | --- |
+| `nc.info()` | 124x |
+| `time.parseDuration("5m")` | 68x |
+| `str.plural()` | 57x |
+| `time.format()` with month and day names | 39x |
+| `id.code()` | 39x |
+| `id.uuidv7()` | 28x |
+| `num.format()` | 23x |
+| `checker.isIP()` | 19x |
+| `obj.get()` with a dot path | 14x |
+| `emitter.emit()` | 10x |
+| `schema.is()` on invalid data | 9x |
+| `schema.safeParse()` on invalid data | 5x |
+| `db.get()` and `db.getAll()` | 3x to 4x |
+
+`sys.which("node")` went from 23 ms to 0.13 ms on Windows. What is slow in JavaScript (`Intl` objects,
+random bytes, stack traces, prepared statements) is now created once and reused.
+
+### Changed
+
+Behaviours that differ from 2.0. Each one fixes something that was wrong or unsafe.
+
+- **logger**: `DEBUG=name` only turns on the debug lines of the scopes it names (it used to turn on all
+  of them). `DEBUG=*`, `DEBUG=1` and `LOG_LEVEL=debug` show everything.
+- **time**: `startOf()`, `endOf()`, `add()` and `diff()` follow `setTimezone()` instead of the system zone.
+  Adding whole days or weeks keeps the time of day when the clocks change in between (it added 24 hours
+  per day); `"24h"` stays exact. `add(date, "soon")` throws a `TypeError` (unreadable text used to add
+  nothing), and so does a unit that does not exist (it was read as milliseconds).
+- **crypto**: `decrypt()` always fails with a `NodeComfortError` whose code is `ERR_DECRYPT` (malformed
+  input used to throw a `TypeError`), and refuses shortened authentication tags. `hash()` and `hmac()`
+  throw a `TypeError` for `null`, `undefined`, plain objects and empty secrets. `safeEqual()` returns
+  `false` when a value is missing. A wrong key type for a token is a `TypeError`, and the algorithms a
+  token may use follow from the key that verifies it.
+- **cli**: leaving a menu or a password prompt with Ctrl+C or Escape rejects with an `AbortError`.
+  `cli.table([])` returns `""`. The
+  `LineReader` type is gone from the public types.
+- **http**: the query and headers of a call are added to those of the client instead of replacing them.
+  A request whose body is a stream is never retried. With `responseType: "stream"` the timeout stops when
+  the headers arrive. `download()` writes to a temporary file first, so a failed download never destroys
+  the file that was there.
+- **schema**: `pick()`, `omit()`, `partial()` and `extend()` keep `strict()`. Names inherited from
+  `Object.prototype` (`toString`, `constructor`) are never read from the input.
+- **SQLite**: a column whose default is `CURRENT_TIMESTAMP` gets the time of the insert (it used to store
+  that text), and with `dates: true` the dates SQLite writes itself are read as UTC. Columns of joins and renamed columns are converted like the others, with Node 22.16 or later.
+- **env**: in `load()`, the first file that defines a variable wins, whatever `override` says. `override`
+  only decides whether files may replace what was already in the environment. A file you load yourself
+  wins over the `.env` loaded at startup, so `.env.local` and `cascade` work without turning anything off.
+  A reference such as `${HOST}` takes the value `HOST` really ends up with.
+- **sys**: `run()` rejects on a timeout it cannot read (it used to mean no timeout), and on Windows a
+  timeout or an abort stops the whole process tree.
+- **fs**: an atomic write keeps the permissions of the file it replaces.
+- **func**: `retry()` stops as soon as the function is aborted. `memoize()` no longer confuses
+  `f(undefined)` with `f(null)`, and accepts `bigint` arguments.
+- **num**: `min()` and `max()` return `NaN` when one value is `NaN`, like `Math.min()`. `sum([0.1, 0.2, 0.3])`
+  is `0.6`.
+- **obj**: `isEmpty()` looks inside a `Map` and a `Set`, and is `false` for a `Date`, a `RegExp` and an
+  `Error`. `unset()` on an array index removes the item instead of leaving a hole. `clone()` keeps class
+  instances and copies buffers. `merge()` never shares a nested object with its inputs.
+- **checker**: `isEmpty()` is `false` for a `Date`, a `RegExp` and an `Error`.
+- **utils**: `JSONString()` never throws, and writes an error with its name, message and stack.
+
+### Fixed
+
+- Timers longer than 24.8 days (`wait("30d")`, cache expiry, `timeout()`) no longer fire at once.
+- Object helpers (`pick`, `omit`, `filter`, `mapValues`, `flatten`, `groupBy`, `keyBy`, `countBy`, `props`,
+  `env.parse`...) are safe with keys named `__proto__`, `constructor` or `toString`.
+- `safeEqual()` no longer reveals the length of the secret.
+- `str.stripTags()` leaves `a < b and c > d` alone, `unescapeHTML()` accepts invalid code points,
+  `capitalize()` handles letters outside the basic plane, and padding counts what you see.
+- `num.formatBytes()` and `num.abbreviate()` change unit when rounding reaches the next one (`"1 MB"`,
+  not `"1024 KB"`).
+- `isYesterday()` and `isTomorrow()` are right on the days the clocks change.
+- `cache.getOrSet()` respects a `delete()`, a `clear()` or a `set()` made while the value was loading.
+- A shutdown handler that never finishes can no longer let the process end with a success code.
+- `sys.run()` and `sys.exec()` settle after a timeout or an abort even when something the command started
+  keeps its output open. They used to wait for it.
+- An async `onLog` hook that fails no longer stops the process.
+- Deleting a watched folder on Windows sent events without end. The watcher now reports it once and stops.
+- `http.download()` reports a connection cut in the middle as an `HttpError` with the code `ERR_NETWORK`.
+- `str.truncate()` never returns more than the length asked for, even when the omission is longer.
+- `emitter.off()` removes a listener added with `once()`.
+- `http` keeps every `Set-Cookie` header and reads the status of an error response in all cases.
+- Tables no longer fail on very large inputs, and progress bars print labels that contain `$`.
+
+### Documentation
+
+- A new website, in English and in French, with a search, a page for every namespace generated from the
+  types, and a landing page whose examples are real files, run at every build.
+- The old addresses (`/guide/logger.html`, `/api/str.html`) redirect to the new pages.
+- `docs/API.md` is gone: the reference lives on the website, and in your editor.
+
 ## [2.0.0] - 2026-09-12
 
 node-comfort becomes a complete, zero-dependency standard library for Node.js: 23 namespaces and classes,
@@ -186,5 +335,6 @@ Each item explains what to change. Most projects only need the SQLite and Node.j
 
 - SQLite: the folder of the database was created in one place and the file opened in another.
 
+[2.1.0]: https://github.com/ix-xs/node-comfort/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/ix-xs/node-comfort/compare/v1.2.0...v2.0.0
 [1.2.0]: https://github.com/ix-xs/node-comfort/releases/tag/v1.2.0

package/README.md

@@ -15,9 +15,9 @@ One package, zero dependencies, documented right in your editor.
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 
 [Documentation](https://ix-xs.github.io/node-comfort/) •
-[Getting started](https://ix-xs.github.io/node-comfort/guide/getting-started.html) •
-[API reference](https://ix-xs.github.io/node-comfort/api/index.html) •
-[Recipes](https://ix-xs.github.io/node-comfort/guide/recipes.html) •
+[Getting started](https://ix-xs.github.io/node-comfort/start/getting-started/) •
+[API reference](https://ix-xs.github.io/node-comfort/reference/) •
+[Recipes](https://ix-xs.github.io/node-comfort/recipes/) •
 [Changelog](./CHANGELOG.md)
 
 </div>
@@ -57,7 +57,7 @@ Node.js 22.13 or newer. That's the first version where `node:sqlite` works witho
 
 - **Zero dependencies.** Built only on Node's own modules. No install scripts, nothing else to audit or keep up to date.
 - **Your editor already knows it.** Every function, parameter and option is typed and documented, with examples. Type `nc.` and look around. It works in plain JavaScript too.
-- **Fast to load.** Namespaces load the first time you use them. Requiring the package takes about 3 ms, and a script that only logs never loads the database or the HTTP client.
+- **Fast to load.** Namespaces load the first time you use them. Requiring the package takes about 4 ms, and a script that only logs never loads the database or the HTTP client.
 - **Safe by default.** Prototype-pollution-proof objects, scrypt passwords, AES-256-GCM, constant-time comparisons, parameterized SQL, atomic file writes.
 - **One way of doing things.** Durations are always `"5m"` or milliseconds, options always come last, and every error has a stable `code`.
 - **Tested everywhere.** Linux, macOS and Windows, Node.js 22 and 24, TypeScript 5.9, 6 and 7.
@@ -66,29 +66,29 @@ Node.js 22.13 or newer. That's the first version where `node:sqlite` works witho
 
 | Namespace | What it's for | Often replaces |
 | --- | --- | --- |
-| [Logger](https://ix-xs.github.io/node-comfort/guide/logger.html) | Colorful logs, levels, JSON output, log files with rotation | `chalk`, `pino`, `winston` |
-| [`fs`](https://ix-xs.github.io/node-comfort/guide/fs.html) | Files and folders without try/catch, atomic writes, glob, watch | `fs-extra`, `glob`, `rimraf` |
-| [`checker`](https://ix-xs.github.io/node-comfort/guide/checker.html) | 60+ type guards and validators, `assert` | `is`, `validator` |
-| [`env`](https://ix-xs.github.io/node-comfort/guide/env.html) | `.env` loading, typed and validated configuration | `dotenv`, `envalid` |
-| [`schema`](https://ix-xs.github.io/node-comfort/guide/schema.html) | Data validation with TypeScript inference | `zod`, `yup`, `joi` |
-| [`http`](https://ix-xs.github.io/node-comfort/guide/http.html) | `fetch` with JSON, retries, timeouts, hooks, downloads | `axios`, `got`, `ky` |
-| [`SQLite`](https://ix-xs.github.io/node-comfort/guide/sqlite.html) | CRUD, filters, JSON columns, transactions, migrations | `better-sqlite3` and helpers |
-| [`time`](https://ix-xs.github.io/node-comfort/guide/time.html) | Formatting in any language and time zone, durations, date math, cron | `dayjs`, `ms`, `node-cron` |
-| [`str`](https://ix-xs.github.io/node-comfort/guide/str.html) | Case conversion, slugs, emoji-safe truncation, fuzzy matching, plurals | `lodash`, `slugify`, `leven` |
-| [`num`](https://ix-xs.github.io/node-comfort/guide/num.html) | Exact rounding, statistics, currencies, bytes | `numeral`, `pretty-bytes` |
-| [`arr`](https://ix-xs.github.io/node-comfort/guide/arr.html) | Chunk, group, multi-key sort, paginate, set operations | `lodash` |
-| [`obj`](https://ix-xs.github.io/node-comfort/guide/obj.html) | Deep clone, merge, equal and diff, typed dot paths | `lodash`, `deepmerge`, `dequal` |
-| [`func`](https://ix-xs.github.io/node-comfort/guide/func.html) | Debounce, throttle, memoize, retry with backoff, timeout | `p-retry`, `p-timeout` |
-| [`async`](https://ix-xs.github.io/node-comfort/guide/async.html) | Concurrency limits, queues, mutex, polling | `p-limit`, `p-map`, `p-queue` |
-| [`Cache`](https://ix-xs.github.io/node-comfort/guide/cache.html) | LRU cache with TTL, loaders and statistics | `lru-cache` |
-| [`Emitter`](https://ix-xs.github.io/node-comfort/guide/emitter.html) | Typed events, `waitFor`, async iteration | `mitt`, `emittery` |
-| [`id`](https://ix-xs.github.io/node-comfort/guide/id.html) | UUID v4 and v7, ULID, nanoid, tokens, Snowflakes | `uuid`, `ulid`, `nanoid` |
-| [`crypto`](https://ix-xs.github.io/node-comfort/guide/crypto.html) | Passwords, encryption, JWT, TOTP two-factor codes | `bcrypt`, `jsonwebtoken`, `otplib` |
-| [`cli`](https://ix-xs.github.io/node-comfort/guide/cli.html) | Typed arguments, prompts, menus, spinners, progress bars, tables | `commander`, `inquirer`, `ora` |
-| [`color`](https://ix-xs.github.io/node-comfort/guide/color.html) | Chainable terminal colors, truecolor, gradients, links | `chalk`, `picocolors` |
-| [`sys`](https://ix-xs.github.io/node-comfort/guide/sys.html) | Run commands, `which`, graceful shutdown, platform detection | `execa`, `which` |
-| [`utils`](https://ix-xs.github.io/node-comfort/guide/utils.html) | `wait`, safe JSON, crash guard | |
-| [`errors`](https://ix-xs.github.io/node-comfort/guide/errors.html) | Error classes with stable codes | |
+| [Logger](https://ix-xs.github.io/node-comfort/essentials/logger/) | Colorful logs, levels, JSON output, log files with rotation | `chalk`, `pino`, `winston` |
+| [`fs`](https://ix-xs.github.io/node-comfort/essentials/fs/) | Files and folders without try/catch, atomic writes, glob, watch | `fs-extra`, `glob`, `rimraf` |
+| [`checker`](https://ix-xs.github.io/node-comfort/essentials/checker/) | 70+ type guards and validators, `assert` | `is`, `validator` |
+| [`env`](https://ix-xs.github.io/node-comfort/essentials/env/) | `.env` loading, typed and validated configuration | `dotenv`, `envalid` |
+| [`schema`](https://ix-xs.github.io/node-comfort/data/schema/) | Data validation with TypeScript inference | `zod`, `yup`, `joi` |
+| [`http`](https://ix-xs.github.io/node-comfort/system/http/) | `fetch` with JSON, retries, timeouts, validated responses, hooks, downloads | `axios`, `got`, `ky` |
+| [`SQLite`](https://ix-xs.github.io/node-comfort/system/sqlite/) | CRUD, filters, JSON columns, pagination, transactions, migrations | `better-sqlite3` and helpers |
+| [`time`](https://ix-xs.github.io/node-comfort/data/time/) | Formatting in any language and time zone, durations, date math, cron | `dayjs`, `ms`, `node-cron` |
+| [`str`](https://ix-xs.github.io/node-comfort/data/str/) | Case conversion, slugs, emoji-safe truncation, fuzzy matching, plurals | `lodash`, `slugify`, `leven` |
+| [`num`](https://ix-xs.github.io/node-comfort/data/num/) | Exact rounding, statistics, currencies, bytes | `numeral`, `pretty-bytes` |
+| [`arr`](https://ix-xs.github.io/node-comfort/data/arr/) | Chunk, group, multi-key sort, paginate, set operations | `lodash` |
+| [`obj`](https://ix-xs.github.io/node-comfort/data/obj/) | Deep clone, merge, equal and diff, typed dot paths | `lodash`, `deepmerge`, `dequal` |
+| [`func`](https://ix-xs.github.io/node-comfort/flow/func/) | Debounce, throttle, memoize, retry with backoff, timeout | `p-retry`, `p-timeout` |
+| [`async`](https://ix-xs.github.io/node-comfort/flow/async/) | Concurrency limits, queues, mutex, polling | `p-limit`, `p-map`, `p-queue` |
+| [`Cache`](https://ix-xs.github.io/node-comfort/flow/cache/) | LRU cache with TTL, loaders and statistics | `lru-cache` |
+| [`Emitter`](https://ix-xs.github.io/node-comfort/flow/emitter/) | Typed events, `waitFor`, async iteration | `mitt`, `emittery` |
+| [`id`](https://ix-xs.github.io/node-comfort/data/id/) | UUID v4, v5 and v7, ULID, nanoid, ObjectId, tokens, Snowflakes | `uuid`, `ulid`, `nanoid` |
+| [`crypto`](https://ix-xs.github.io/node-comfort/system/crypto/) | Passwords, encryption, JWT, TOTP two-factor codes | `bcrypt`, `jsonwebtoken`, `otplib` |
+| [`cli`](https://ix-xs.github.io/node-comfort/system/cli/) | Typed arguments and subcommands, prompts, menus, spinners, progress bars, tables, trees | `commander`, `inquirer`, `ora` |
+| [`color`](https://ix-xs.github.io/node-comfort/system/color/) | Chainable terminal colors, truecolor, gradients, links | `chalk`, `picocolors` |
+| [`sys`](https://ix-xs.github.io/node-comfort/system/sys/) | Run commands, `which`, graceful shutdown, platform detection | `execa`, `which` |
+| [`utils`](https://ix-xs.github.io/node-comfort/essentials/utils/) | `wait`, safe JSON, crash guard | |
+| [`errors`](https://ix-xs.github.io/node-comfort/essentials/errors/) | Error classes with stable codes | |
 
 The logger, `fs`, `checker` and `utils` helpers are also available at the top level: `nc.info()`, `nc.readJSON()`, `nc.isEmail()`, `nc.wait()`.
 
@@ -104,7 +104,7 @@ import nc from "@ix-xs/node-comfort";
 import { slugify } from "@ix-xs/node-comfort/str";   // loads only what it needs
 ```
 
-Every namespace has its own entry point (`@ix-xs/node-comfort/http`, `/sqlite`, `/schema`...). In an ES module, importing from these keeps startup lean. See [Performance](https://ix-xs.github.io/node-comfort/guide/performance.html).
+Every namespace has its own entry point (`@ix-xs/node-comfort/http`, `/sqlite`, `/schema`...). In an ES module, importing from these keeps startup lean. See [Performance](https://ix-xs.github.io/node-comfort/start/performance/).
 
 TypeScript needs no setup: the types ship with the package.
 
@@ -188,7 +188,7 @@ const spinner = nc.cli.spinner(`Deploying to ${env}`).start();
 spinner.succeed("Deployed");
 ```
 
-That's a small part of it. The [guide](https://ix-xs.github.io/node-comfort/guide/introduction.html) walks through every namespace, and the [recipes](https://ix-xs.github.io/node-comfort/guide/recipes.html) show them working together: a small API server, a CLI, a scheduled job.
+That's a small part of it. The [guide](https://ix-xs.github.io/node-comfort/start/introduction/) walks through every namespace, and the [recipes](https://ix-xs.github.io/node-comfort/recipes/) show them working together: a small API server, a CLI, a scheduled job.
 
 ## Coming from 1.x
 
@@ -199,7 +199,9 @@ That's a small part of it. The [guide](https://ix-xs.github.io/node-comfort/guid
 - `warn` and `error` write to stderr.
 - Deep imports (`@ix-xs/node-comfort/src/...`) are replaced by official entry points (`@ix-xs/node-comfort/str`).
 
-The [migration guide](https://ix-xs.github.io/node-comfort/guide/migration.html) lists every change with before and after examples.
+The [migration guide](https://ix-xs.github.io/node-comfort/start/migration/) lists every change with before and after examples.
+
+Coming from 2.0, there is nothing to change: 2.1 adds functions, makes the existing ones faster and corrects edge cases. The [changelog](./CHANGELOG.md) has the details.
 
 ## Contributing
 

package/index.js

@@ -41,8 +41,8 @@ const modules = {
 // Helpers that are also available at the top level (nc.info, nc.readJSON...).
 const flat = {
   logger: ["log", "trace", "debug", "info", "success", "warn", "error", "fatal", "group", "groupEnd", "timeStart", "timeEnd", "table", "box", "divider", "setLevel", "getLevel", "isLevelEnabled", "configure", "setTimestamp", "setDelimiter", "createLogger"],
-  fs: ["getEnv", "createPath", "getFolder", "getFile", "getFoldersIn", "getFilesIn", "glob", "find", "readFile", "readLines", "readJSON", "writeFile", "writeJSON", "appendFile", "createFile", "createFolder", "ensureFolder", "ensureFile", "touch", "deleteFolder", "deleteFile", "remove", "deleteFoldersIn", "deleteFilesIn", "emptyFolder", "copy", "move", "copyFoldersIn", "copyFolder", "copyFilesIn", "copyFile", "moveFoldersIn", "moveFolder", "moveFilesIn", "moveFile", "exists", "isFile", "isFolder", "stat", "fileSize", "folderSize", "hashFile", "tempFolder", "sanitizeFilename", "watch"],
-  checker: ["isArray", "isNumber", "isFinite", "isInteger", "isSafeInteger", "isFloat", "isPositive", "isNegative", "isBoolean", "isString", "isSymbol", "isBigInt", "isUndefined", "isNull", "isNil", "isDefined", "isPrimitive", "isFunction", "isAsyncFunction", "isGeneratorFunction", "isGenerator", "isClass", "isObject", "isPlainObject", "isPromise", "isRegExp", "isDate", "isValidDate", "isMap", "isSet", "isWeakMap", "isWeakSet", "isIterable", "isAsyncIterable", "isBuffer", "isTypedArray", "isError", "isEmpty", "isBlank", "isArrayOf", "isOneOf", "isEmail", "isURL", "isUUID", "isJSON", "isNumeric", "isIP", "isIPv4", "isIPv6", "isPort", "isHex", "isHexColor", "isBase64", "isSemver", "isISODate", "isSlug", "isAlpha", "isAlphanumeric", "isCreditCard", "isJWT", "assert", "assertType"],
+  fs: ["getEnv", "createPath", "getFolder", "getFile", "getFoldersIn", "getFilesIn", "glob", "find", "findUp", "readFile", "readLines", "readJSON", "writeFile", "writeJSON", "appendFile", "createFile", "createFolder", "ensureFolder", "ensureFile", "touch", "deleteFolder", "deleteFile", "remove", "deleteFoldersIn", "deleteFilesIn", "emptyFolder", "copy", "move", "copyFoldersIn", "copyFolder", "copyFilesIn", "copyFile", "moveFoldersIn", "moveFolder", "moveFilesIn", "moveFile", "exists", "isFile", "isFolder", "stat", "fileSize", "folderSize", "hashFile", "tempFolder", "sanitizeFilename", "watch"],
+  checker: ["isArray", "isNumber", "isFinite", "isInteger", "isSafeInteger", "isFloat", "isPositive", "isNegative", "isBoolean", "isString", "isSymbol", "isBigInt", "isUndefined", "isNull", "isNil", "isDefined", "isPrimitive", "isFunction", "isAsyncFunction", "isGeneratorFunction", "isGenerator", "isClass", "isObject", "isPlainObject", "isPromise", "isRegExp", "isDate", "isValidDate", "isMap", "isSet", "isWeakMap", "isWeakSet", "isIterable", "isAsyncIterable", "isBuffer", "isTypedArray", "isError", "isEmpty", "isBlank", "isArrayOf", "isOneOf", "isEmail", "isURL", "isUUID", "isJSON", "isNumeric", "isIP", "isIPv4", "isIPv6", "isPort", "isHex", "isHexColor", "isBase64", "isSemver", "isISODate", "isSlug", "isAlpha", "isAlphanumeric", "isCreditCard", "isJWT", "isHostname", "isMACAddress", "isIBAN", "isE164", "isObjectId", "isULID", "isDataURL", "isMimeType", "isTimeZone", "isLocale", "isCron", "isASCII", "assert", "assertType"],
   utils: ["wait", "when", "dontCrash", "JSONString", "JSONParse"],
 };
 
@@ -81,4 +81,4 @@ exports.nodeComfort = exports;
 
 // Never runs. Node reads this line to know the named exports of the package
 // when it is imported from an ES module.
-0 && (module.exports = { log, trace, debug, info, success, warn, error, fatal, group, groupEnd, timeStart, timeEnd, table, box, divider, setLevel, getLevel, isLevelEnabled, configure, setTimestamp, setDelimiter, createLogger, getEnv, createPath, getFolder, getFile, getFoldersIn, getFilesIn, glob, find, readFile, readLines, readJSON, writeFile, writeJSON, appendFile, createFile, createFolder, ensureFolder, ensureFile, touch, deleteFolder, deleteFile, remove, deleteFoldersIn, deleteFilesIn, emptyFolder, copy, move, copyFoldersIn, copyFolder, copyFilesIn, copyFile, moveFoldersIn, moveFolder, moveFilesIn, moveFile, exists, isFile, isFolder, stat, fileSize, folderSize, hashFile, tempFolder, sanitizeFilename, watch, isArray, isNumber, isFinite, isInteger, isSafeInteger, isFloat, isPositive, isNegative, isBoolean, isString, isSymbol, isBigInt, isUndefined, isNull, isNil, isDefined, isPrimitive, isFunction, isAsyncFunction, isGeneratorFunction, isGenerator, isClass, isObject, isPlainObject, isPromise, isRegExp, isDate, isValidDate, isMap, isSet, isWeakMap, isWeakSet, isIterable, isAsyncIterable, isBuffer, isTypedArray, isError, isEmpty, isBlank, isArrayOf, isOneOf, isEmail, isURL, isUUID, isJSON, isNumeric, isIP, isIPv4, isIPv6, isPort, isHex, isHexColor, isBase64, isSemver, isISODate, isSlug, isAlpha, isAlphanumeric, isCreditCard, isJWT, assert, assertType, wait, when, dontCrash, JSONString, JSONParse, logger, fs, checker, utils, str, num, arr, obj, func, time, id, crypto, color, cli, sys, async, schema, http, env, errors, SQLite, Cache, Emitter, nc, nodeComfort });
+0 && (module.exports = { log, trace, debug, info, success, warn, error, fatal, group, groupEnd, timeStart, timeEnd, table, box, divider, setLevel, getLevel, isLevelEnabled, configure, setTimestamp, setDelimiter, createLogger, getEnv, createPath, getFolder, getFile, getFoldersIn, getFilesIn, glob, find, findUp, readFile, readLines, readJSON, writeFile, writeJSON, appendFile, createFile, createFolder, ensureFolder, ensureFile, touch, deleteFolder, deleteFile, remove, deleteFoldersIn, deleteFilesIn, emptyFolder, copy, move, copyFoldersIn, copyFolder, copyFilesIn, copyFile, moveFoldersIn, moveFolder, moveFilesIn, moveFile, exists, isFile, isFolder, stat, fileSize, folderSize, hashFile, tempFolder, sanitizeFilename, watch, isArray, isNumber, isFinite, isInteger, isSafeInteger, isFloat, isPositive, isNegative, isBoolean, isString, isSymbol, isBigInt, isUndefined, isNull, isNil, isDefined, isPrimitive, isFunction, isAsyncFunction, isGeneratorFunction, isGenerator, isClass, isObject, isPlainObject, isPromise, isRegExp, isDate, isValidDate, isMap, isSet, isWeakMap, isWeakSet, isIterable, isAsyncIterable, isBuffer, isTypedArray, isError, isEmpty, isBlank, isArrayOf, isOneOf, isEmail, isURL, isUUID, isJSON, isNumeric, isIP, isIPv4, isIPv6, isPort, isHex, isHexColor, isBase64, isSemver, isISODate, isSlug, isAlpha, isAlphanumeric, isCreditCard, isJWT, isHostname, isMACAddress, isIBAN, isE164, isObjectId, isULID, isDataURL, isMimeType, isTimeZone, isLocale, isCron, isASCII, assert, assertType, wait, when, dontCrash, JSONString, JSONParse, logger, fs, checker, utils, str, num, arr, obj, func, time, id, crypto, color, cli, sys, async, schema, http, env, errors, SQLite, Cache, Emitter, nc, nodeComfort });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ix-xs/node-comfort",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "The zero-dependency standard library for Node.js: logger, filesystem, SQLite, schema validation, HTTP client, CLI toolkit, cache, env, async pools, colors, events, i18n dates, ids, crypto and hundreds of fully typed helpers.",
   "keywords": [
     "utils",
@@ -184,14 +184,15 @@
     "access": "public"
   },
   "scripts": {
-    "build": "node scripts/build-types.js && node scripts/build-docs.js",
+    "build": "node scripts/build-types.js && node scripts/build-reference.js",
     "build:types": "node scripts/build-types.js",
-    "build:docs": "node scripts/build-docs.js",
-    "build:site": "node scripts/build-site.js",
-    "site:serve": "node scripts/serve-site.js",
-    "test": "node --test \"test/**/*.test.js\"",
+    "build:reference": "node scripts/build-reference.js",
+    "test": "node --test --test-reporter=spec --test-timeout=120000 \"test/**/*.test.js\"",
     "test:types": "node scripts/check-types.js",
-    "check": "npm run build && npm run build:site && npm test && npm run test:types",
+    "docs:install": "npm ci --prefix docs",
+    "docs:dev": "npm run dev --prefix docs",
+    "docs:build": "npm run build --prefix docs && npm run check-links --prefix docs && npm run check-translation --prefix docs",
+    "check": "npm run build && npm test && npm run test:types",
     "prepublishOnly": "npm run check"
   },
   "devDependencies": {