@socketsecurity/lib 5.27.0 → 6.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.
- package/CHANGELOG.md +69 -27
- package/README.md +1 -1
- package/dist/abort/signal.d.ts +28 -0
- package/dist/{abort.js → abort/signal.js} +12 -10
- package/dist/ai/discover.d.mts +50 -0
- package/dist/ai/discover.js +128 -0
- package/dist/ai/profiles.d.mts +39 -0
- package/dist/ai/profiles.js +61 -0
- package/dist/ai/spawn.d.mts +49 -0
- package/dist/ai/spawn.js +207 -0
- package/dist/ai/types.d.mts +117 -0
- package/dist/ai/types.js +18 -0
- package/dist/ai/worktree.d.mts +104 -0
- package/dist/ai/worktree.js +200 -0
- package/dist/ansi/constants.d.ts +10 -0
- package/dist/ansi/constants.js +45 -0
- package/dist/ansi/strip.d.ts +33 -0
- package/dist/{ansi.js → ansi/strip.js} +7 -24
- package/dist/archives/_internal.d.ts +39 -0
- package/dist/archives/_internal.js +87 -0
- package/dist/archives/detect.d.ts +19 -0
- package/dist/archives/detect.js +46 -0
- package/dist/archives/extract.d.ts +22 -0
- package/dist/archives/extract.js +53 -0
- package/dist/archives/tar.d.ts +42 -0
- package/dist/archives/tar.js +233 -0
- package/dist/archives/types.d.ts +34 -0
- package/dist/archives/types.js +18 -0
- package/dist/archives/zip.d.ts +20 -0
- package/dist/archives/zip.js +124 -0
- package/dist/argv/flag-predicates.d.ts +179 -0
- package/dist/argv/flag-predicates.js +118 -0
- package/dist/argv/flag-types.d.ts +123 -0
- package/dist/argv/flag-types.js +116 -0
- package/dist/argv/parse.d.ts +34 -33
- package/dist/argv/parse.js +6 -4
- package/dist/arrays/_internal.d.ts +43 -0
- package/dist/{arrays.js → arrays/_internal.js} +8 -41
- package/dist/arrays/chunk.d.ts +37 -0
- package/dist/arrays/chunk.js +43 -0
- package/dist/arrays/join.d.ts +76 -0
- package/dist/{env/helpers.js → arrays/join.js} +12 -18
- package/dist/arrays/predicates.d.ts +40 -0
- package/dist/arrays/predicates.js +30 -0
- package/dist/arrays/unique.d.ts +36 -0
- package/dist/arrays/unique.js +34 -0
- package/dist/bin/_internal.d.ts +22 -0
- package/dist/bin/_internal.js +43 -0
- package/dist/bin/check-primordials.d.ts +44 -0
- package/dist/bin/check-primordials.js +245 -0
- package/dist/bin/check.d.ts +10 -0
- package/dist/bin/check.js +77 -0
- package/dist/bin/exec.d.ts +37 -0
- package/dist/bin/exec.js +79 -0
- package/dist/bin/find.d.ts +58 -0
- package/dist/bin/find.js +143 -0
- package/dist/bin/resolve.d.ts +30 -0
- package/dist/bin/resolve.js +249 -0
- package/dist/bin/shadow.d.ts +16 -0
- package/dist/bin/shadow.js +36 -0
- package/dist/bin/socket-lib.d.ts +13 -0
- package/dist/bin/socket-lib.js +79 -0
- package/dist/bin/types.d.ts +34 -0
- package/dist/bin/types.js +18 -0
- package/dist/bin/which.d.ts +111 -0
- package/dist/bin/which.js +155 -0
- package/dist/cacache/_internal.d.ts +15 -0
- package/dist/cacache/_internal.js +43 -0
- package/dist/cacache/clear.d.ts +43 -0
- package/dist/cacache/clear.js +77 -0
- package/dist/cacache/read.d.ts +31 -0
- package/dist/cacache/read.js +51 -0
- package/dist/cacache/tmp.d.ts +18 -0
- package/dist/cacache/tmp.js +39 -0
- package/dist/cacache/types.d.ts +37 -0
- package/dist/cacache/types.js +18 -0
- package/dist/cacache/write.d.ts +31 -0
- package/dist/cacache/write.js +53 -0
- package/dist/checks/primordials.d.ts +118 -0
- package/dist/checks/primordials.js +293 -0
- package/dist/colors/convert.d.ts +35 -0
- package/dist/colors/convert.js +42 -0
- package/dist/colors/palette.d.ts +7 -0
- package/dist/{colors.js → colors/palette.js} +5 -17
- package/dist/colors/types.d.ts +29 -0
- package/dist/colors/types.js +18 -0
- package/dist/compression/_internal.d.ts +33 -0
- package/dist/compression/_internal.js +77 -0
- package/dist/compression/brotli.d.ts +82 -0
- package/dist/compression/brotli.js +147 -0
- package/dist/compression/gzip.d.ts +70 -0
- package/dist/compression/gzip.js +142 -0
- package/dist/compression/types.d.ts +37 -0
- package/dist/compression/types.js +18 -0
- package/dist/constants/agents.d.ts +4 -3
- package/dist/constants/agents.js +7 -4
- package/dist/constants/encoding.d.ts +3 -3
- package/dist/constants/github.d.ts +2 -3
- package/dist/constants/licenses.d.ts +5 -5
- package/dist/constants/licenses.js +2 -2
- package/dist/constants/lifecycle-script-names.d.ts +3 -4
- package/dist/constants/lifecycle-script-names.js +2 -2
- package/dist/constants/maintained-node-versions.d.ts +1 -1
- package/dist/constants/maintained-node-versions.js +3 -4
- package/dist/constants/node.d.ts +21 -20
- package/dist/constants/node.js +4 -4
- package/dist/constants/package-default-node-range.d.ts +1 -1
- package/dist/constants/package-default-socket-categories.d.ts +1 -1
- package/dist/constants/package-default-socket-categories.js +2 -2
- package/dist/constants/packages.d.ts +4 -4
- package/dist/constants/packages.js +7 -5
- package/dist/constants/platform.d.ts +3 -1
- package/dist/constants/platform.js +3 -10
- package/dist/constants/{core.d.ts → sentinels.d.ts} +4 -4
- package/dist/constants/{core.js → sentinels.js} +3 -3
- package/dist/constants/socket.d.ts +4 -6
- package/dist/constants/socket.js +6 -9
- package/dist/constants/testing.d.ts +3 -3
- package/dist/constants/time.d.ts +3 -3
- package/dist/constants/typescript.d.ts +3 -3
- package/dist/cover/code.d.ts +11 -3
- package/dist/cover/code.js +26 -36
- package/dist/cover/formatters.d.ts +19 -15
- package/dist/cover/formatters.js +21 -18
- package/dist/cover/type.d.ts +4 -3
- package/dist/cover/type.js +9 -8
- package/dist/cover/types.d.ts +1 -1
- package/dist/crypto/hash.d.ts +36 -0
- package/dist/{crypto.js → crypto/hash.js} +17 -17
- package/dist/debug/_internal.d.ts +25 -0
- package/dist/debug/_internal.js +77 -0
- package/dist/debug/caller-info.d.ts +12 -0
- package/dist/debug/caller-info.js +67 -0
- package/dist/debug/namespace.d.ts +35 -0
- package/dist/debug/namespace.js +101 -0
- package/dist/{debug.d.ts → debug/output.d.ts} +23 -42
- package/dist/debug/output.js +209 -0
- package/dist/debug/types.d.ts +21 -0
- package/dist/debug/types.js +18 -0
- package/dist/dlx/_internal.d.ts +10 -0
- package/dist/dlx/_internal.js +47 -0
- package/dist/dlx/arborist.d.ts +86 -61
- package/dist/dlx/arborist.js +30 -35
- package/dist/dlx/binary-cache.d.ts +108 -0
- package/dist/dlx/binary-cache.js +212 -0
- package/dist/dlx/binary-download.d.ts +67 -0
- package/dist/dlx/binary-download.js +216 -0
- package/dist/dlx/binary-resolution.d.ts +61 -0
- package/dist/dlx/binary-resolution.js +164 -0
- package/dist/dlx/binary-types.d.ts +144 -0
- package/dist/dlx/binary-types.js +18 -0
- package/dist/dlx/binary.d.ts +39 -268
- package/dist/dlx/binary.js +38 -319
- package/dist/dlx/cache.d.ts +21 -16
- package/dist/dlx/cache.js +2 -2
- package/dist/dlx/detect.d.ts +94 -68
- package/dist/dlx/detect.js +32 -35
- package/dist/dlx/dir.d.ts +20 -18
- package/dist/dlx/dir.js +7 -14
- package/dist/dlx/firewall.d.ts +27 -0
- package/dist/dlx/firewall.js +107 -0
- package/dist/dlx/lockfile.d.ts +73 -56
- package/dist/dlx/lockfile.js +36 -44
- package/dist/dlx/manifest.d.ts +50 -51
- package/dist/dlx/manifest.js +51 -52
- package/dist/dlx/package.d.ts +83 -249
- package/dist/dlx/package.js +48 -268
- package/dist/dlx/packages.d.ts +22 -20
- package/dist/dlx/packages.js +15 -20
- package/dist/dlx/paths.d.ts +26 -23
- package/dist/dlx/paths.js +8 -15
- package/dist/dlx/spec.d.ts +25 -0
- package/dist/dlx/spec.js +63 -0
- package/dist/dlx/types.d.ts +142 -0
- package/dist/dlx/types.js +18 -0
- package/dist/eco/cargo/lockfile-format.d.ts +8 -0
- package/dist/eco/cargo/lockfile-format.js +39 -0
- package/dist/eco/cargo/manifest-format.d.ts +7 -0
- package/dist/eco/cargo/manifest-format.js +38 -0
- package/dist/eco/cargo/parse-lockfile.d.ts +84 -0
- package/dist/eco/cargo/parse-lockfile.js +257 -0
- package/dist/eco/manifest/analyze-lockfile.d.ts +10 -0
- package/dist/eco/manifest/analyze-lockfile.js +67 -0
- package/dist/eco/manifest/detect-format.d.ts +15 -0
- package/dist/eco/manifest/detect-format.js +98 -0
- package/dist/eco/manifest/find-packages.d.ts +14 -0
- package/dist/eco/manifest/find-packages.js +69 -0
- package/dist/eco/manifest/get-package-versions.d.ts +8 -0
- package/dist/eco/manifest/get-package-versions.js +52 -0
- package/dist/eco/manifest/get-package.d.ts +10 -0
- package/dist/eco/manifest/get-package.js +44 -0
- package/dist/eco/manifest/manifest-error.d.ts +18 -0
- package/dist/eco/manifest/manifest-error.js +37 -0
- package/dist/eco/manifest/parse-lockfile.d.ts +16 -0
- package/dist/eco/manifest/parse-lockfile.js +91 -0
- package/dist/eco/manifest/parse-manifest.d.ts +12 -0
- package/dist/eco/manifest/parse-manifest.js +48 -0
- package/dist/eco/manifest/parse.d.ts +9 -0
- package/dist/eco/manifest/parse.js +52 -0
- package/dist/eco/manifest/types.d.ts +10 -0
- package/dist/eco/manifest/types.js +18 -0
- package/dist/eco/npm/bun/exec.d.ts +15 -0
- package/dist/eco/npm/bun/exec.js +35 -0
- package/dist/eco/npm/manifest-format.d.ts +11 -0
- package/dist/eco/npm/manifest-format.js +38 -0
- package/dist/eco/npm/npm/exec.d.ts +24 -0
- package/dist/eco/npm/npm/exec.js +64 -0
- package/dist/eco/npm/npm/extract-package-name-from-path.d.ts +9 -0
- package/dist/eco/npm/npm/extract-package-name-from-path.js +54 -0
- package/dist/eco/npm/npm/flags.d.ts +62 -0
- package/dist/eco/npm/npm/flags.js +63 -0
- package/dist/eco/npm/npm/lockfile-format.d.ts +9 -0
- package/dist/eco/npm/npm/lockfile-format.js +42 -0
- package/dist/eco/npm/npm/parse-git-url.d.ts +13 -0
- package/dist/eco/npm/npm/parse-git-url.js +43 -0
- package/dist/eco/npm/npm/parse-lockfile.d.ts +70 -0
- package/dist/eco/npm/npm/parse-lockfile.js +224 -0
- package/dist/eco/npm/parse-package-json.d.ts +16 -0
- package/dist/eco/npm/parse-package-json.js +115 -0
- package/dist/eco/npm/pnpm/detect-pnpm-version.d.ts +7 -0
- package/dist/eco/npm/pnpm/detect-pnpm-version.js +47 -0
- package/dist/eco/npm/pnpm/exec.d.ts +26 -0
- package/dist/eco/npm/pnpm/exec.js +65 -0
- package/dist/eco/npm/pnpm/flags.d.ts +44 -0
- package/dist/eco/npm/pnpm/flags.js +76 -0
- package/dist/eco/npm/pnpm/lockfile-format.d.ts +8 -0
- package/dist/eco/npm/pnpm/lockfile-format.js +39 -0
- package/dist/eco/npm/pnpm/parse-lockfile.d.ts +69 -0
- package/dist/eco/npm/pnpm/parse-lockfile.js +274 -0
- package/dist/eco/npm/pnpm/parse-pnpm-package-id-v5.d.ts +15 -0
- package/dist/eco/npm/pnpm/parse-pnpm-package-id-v5.js +50 -0
- package/dist/eco/npm/pnpm/parse-pnpm-package-id-v6-v9.d.ts +11 -0
- package/dist/eco/npm/pnpm/parse-pnpm-package-id-v6-v9.js +52 -0
- package/dist/eco/npm/script.d.ts +35 -0
- package/dist/eco/npm/script.js +93 -0
- package/dist/eco/npm/vlt/exec.d.ts +16 -0
- package/dist/eco/npm/vlt/exec.js +35 -0
- package/dist/eco/npm/yarnpkg/yarn/exec.d.ts +28 -0
- package/dist/eco/npm/yarnpkg/yarn/exec.js +63 -0
- package/dist/eco/npm/yarnpkg/yarn/lockfile-format.d.ts +9 -0
- package/dist/eco/npm/yarnpkg/yarn/lockfile-format.js +39 -0
- package/dist/eco/npm/yarnpkg/yarn/parse-lockfile.d.ts +61 -0
- package/dist/eco/npm/yarnpkg/yarn/parse-lockfile.js +261 -0
- package/dist/eco/npm/yarnpkg/yarn/parse-yarn-descriptor.d.ts +16 -0
- package/dist/eco/npm/yarnpkg/yarn/parse-yarn-descriptor.js +68 -0
- package/dist/{types.d.ts → eco/purl.d.ts} +14 -26
- package/dist/{types.js → eco/purl.js} +3 -3
- package/dist/eco/types.d.ts +51 -0
- package/dist/eco/types.js +18 -0
- package/dist/effects/pulse-frames.d.ts +16 -17
- package/dist/effects/pulse-frames.js +4 -4
- package/dist/effects/shimmer-keyframes.d.ts +39 -37
- package/dist/effects/shimmer-terminal.d.ts +43 -42
- package/dist/effects/shimmer-terminal.js +3 -3
- package/dist/effects/shimmer.d.ts +172 -153
- package/dist/effects/shimmer.js +78 -76
- package/dist/env/boolean.d.ts +33 -0
- package/dist/env/boolean.js +46 -0
- package/dist/env/case-insensitive.d.ts +42 -0
- package/dist/env/case-insensitive.js +42 -0
- package/dist/env/ci.d.ts +11 -12
- package/dist/env/debug.d.ts +10 -10
- package/dist/env/github.d.ts +71 -74
- package/dist/env/home.d.ts +15 -14
- package/dist/env/locale.d.ts +26 -29
- package/dist/env/node-auth-token.d.ts +10 -10
- package/dist/env/node-env.d.ts +10 -10
- package/dist/env/npm.d.ts +45 -47
- package/dist/env/number.d.ts +29 -0
- package/dist/env/number.js +54 -0
- package/dist/env/package-manager.d.ts +36 -33
- package/dist/env/package-manager.js +3 -3
- package/dist/env/path.d.ts +10 -10
- package/dist/env/pre-commit.d.ts +11 -11
- package/dist/env/pre-commit.js +2 -2
- package/dist/env/proxy.d.ts +44 -0
- package/dist/env/proxy.js +126 -0
- package/dist/env/rewire.d.ts +105 -99
- package/dist/env/rewire.js +11 -8
- package/dist/env/shell.d.ts +10 -10
- package/dist/env/socket-cli.d.ts +109 -125
- package/dist/env/socket-cli.js +7 -12
- package/dist/env/socket.d.ts +347 -130
- package/dist/env/socket.js +107 -8
- package/dist/env/string.d.ts +28 -0
- package/dist/env/string.js +47 -0
- package/dist/env/temp-dir.d.ts +26 -29
- package/dist/env/term.d.ts +10 -10
- package/dist/env/test.d.ts +29 -31
- package/dist/env/test.js +5 -4
- package/dist/env/types.d.ts +62 -0
- package/dist/env/types.js +18 -0
- package/dist/env/windows.d.ts +37 -38
- package/dist/env/xdg.d.ts +29 -29
- package/dist/errors/message.d.ts +27 -0
- package/dist/errors/message.js +49 -0
- package/dist/errors/predicates.d.ts +46 -0
- package/dist/{errors.js → errors/predicates.js} +13 -43
- package/dist/errors/stack.d.ts +16 -0
- package/dist/errors/stack.js +39 -0
- package/dist/external/@npmcli/package-json/lib/read-package.js +11 -1
- package/dist/external/@npmcli/package-json.js +300 -82
- package/dist/external/@npmcli/promise-spawn.js +15 -1
- package/dist/external/@socketregistry/packageurl-js.js +7 -1
- package/dist/external/@socketregistry/yocto-spinner.js +5 -1
- package/dist/external/@yarnpkg/extensions.js +1 -1
- package/dist/external/adm-zip.js +20 -4
- package/dist/external/debug.js +15 -1
- package/dist/external/external-pack.js +20 -4
- package/dist/external/fast-sort.js +3 -1
- package/dist/external/get-east-asian-width.js +3 -1
- package/dist/external/libnpmexec.js +5 -1
- package/dist/external/npm-pack.js +344 -113
- package/dist/external/p-map.js +7 -1
- package/dist/external/pico-pack.js +17 -1
- package/dist/external/pony-cause.js +1 -1
- package/dist/external/spdx-pack.js +3 -1
- package/dist/external/supports-color.js +1 -1
- package/dist/external/tar-fs.js +15 -1
- package/dist/external/which.js +11 -1
- package/dist/external/yargs-parser.js +15 -1
- package/dist/external-tools/bazel/asset-names.d.ts +66 -0
- package/dist/external-tools/bazel/asset-names.js +96 -0
- package/dist/external-tools/bazel/from-download.d.ts +49 -0
- package/dist/external-tools/bazel/from-download.js +49 -0
- package/dist/external-tools/bazel/from-path.d.ts +8 -0
- package/dist/external-tools/bazel/from-path.js +41 -0
- package/dist/external-tools/bazel/read-bazel-version-file.d.ts +12 -0
- package/dist/external-tools/bazel/read-bazel-version-file.js +61 -0
- package/dist/external-tools/bazel/resolve-asset-url.d.ts +14 -0
- package/dist/external-tools/bazel/resolve-asset-url.js +42 -0
- package/dist/external-tools/bazel/resolve-bazel-version.d.ts +19 -0
- package/dist/external-tools/bazel/resolve-bazel-version.js +59 -0
- package/dist/external-tools/bazel/resolve.d.ts +35 -0
- package/dist/external-tools/bazel/resolve.js +68 -0
- package/dist/external-tools/bazel/types.d.ts +22 -0
- package/dist/external-tools/bazel/types.js +18 -0
- package/dist/external-tools/cdxgen/asset-names.d.ts +58 -0
- package/dist/external-tools/cdxgen/asset-names.js +79 -0
- package/dist/external-tools/cdxgen/from-download.d.ts +43 -0
- package/dist/external-tools/cdxgen/from-download.js +83 -0
- package/dist/external-tools/cdxgen/from-path.d.ts +5 -0
- package/dist/external-tools/cdxgen/from-path.js +40 -0
- package/dist/external-tools/cdxgen/from-vfs.d.ts +7 -0
- package/dist/external-tools/cdxgen/from-vfs.js +47 -0
- package/dist/external-tools/cdxgen/resolve.d.ts +32 -0
- package/dist/external-tools/cdxgen/resolve.js +73 -0
- package/dist/external-tools/cdxgen/types.d.ts +33 -0
- package/dist/external-tools/cdxgen/types.js +18 -0
- package/dist/external-tools/from-download.d.ts +162 -0
- package/dist/external-tools/from-download.js +72 -0
- package/dist/external-tools/janus/asset-names.d.ts +36 -0
- package/dist/external-tools/janus/asset-names.js +52 -0
- package/dist/external-tools/janus/from-download.d.ts +26 -0
- package/dist/external-tools/janus/from-download.js +65 -0
- package/dist/external-tools/janus/from-path.d.ts +5 -0
- package/dist/external-tools/janus/from-path.js +40 -0
- package/dist/external-tools/janus/from-vfs.d.ts +7 -0
- package/dist/external-tools/janus/from-vfs.js +47 -0
- package/dist/external-tools/janus/resolve.d.ts +28 -0
- package/dist/external-tools/janus/resolve.js +73 -0
- package/dist/external-tools/janus/types.d.ts +24 -0
- package/dist/external-tools/janus/types.js +18 -0
- package/dist/external-tools/jre/asset-names.d.ts +91 -0
- package/dist/external-tools/jre/asset-names.js +88 -0
- package/dist/external-tools/jre/detect-platform-arch.d.ts +8 -0
- package/dist/external-tools/jre/detect-platform-arch.js +52 -0
- package/dist/external-tools/jre/from-download.d.ts +62 -0
- package/dist/external-tools/jre/from-download.js +70 -0
- package/dist/external-tools/jre/from-java-home.d.ts +10 -0
- package/dist/external-tools/jre/from-java-home.js +57 -0
- package/dist/external-tools/jre/from-path.d.ts +9 -0
- package/dist/external-tools/jre/from-path.js +52 -0
- package/dist/external-tools/jre/from-vfs.d.ts +17 -0
- package/dist/external-tools/jre/from-vfs.js +64 -0
- package/dist/external-tools/jre/resolve.d.ts +40 -0
- package/dist/external-tools/jre/resolve.js +78 -0
- package/dist/external-tools/jre/types.d.ts +28 -0
- package/dist/external-tools/jre/types.js +18 -0
- package/dist/external-tools/manifest.d.ts +105 -0
- package/dist/external-tools/manifest.js +167 -0
- package/dist/external-tools/opengrep/asset-names.d.ts +44 -0
- package/dist/external-tools/opengrep/asset-names.js +78 -0
- package/dist/external-tools/opengrep/from-download.d.ts +17 -0
- package/dist/external-tools/opengrep/from-download.js +83 -0
- package/dist/external-tools/opengrep/from-path.d.ts +5 -0
- package/dist/external-tools/opengrep/from-path.js +40 -0
- package/dist/external-tools/opengrep/from-vfs.d.ts +8 -0
- package/dist/external-tools/opengrep/from-vfs.js +47 -0
- package/dist/external-tools/opengrep/resolve.d.ts +26 -0
- package/dist/external-tools/opengrep/resolve.js +73 -0
- package/dist/external-tools/opengrep/types.d.ts +24 -0
- package/dist/external-tools/opengrep/types.js +18 -0
- package/dist/external-tools/sbt/asset-names.d.ts +31 -0
- package/dist/external-tools/sbt/asset-names.js +33 -0
- package/dist/external-tools/sbt/from-download.d.ts +44 -0
- package/dist/external-tools/sbt/from-download.js +64 -0
- package/dist/external-tools/sbt/from-path.d.ts +8 -0
- package/dist/external-tools/sbt/from-path.js +41 -0
- package/dist/external-tools/sbt/from-vfs.d.ts +14 -0
- package/dist/external-tools/sbt/from-vfs.js +48 -0
- package/dist/external-tools/sbt/resolve.d.ts +31 -0
- package/dist/external-tools/sbt/resolve.js +73 -0
- package/dist/external-tools/sbt/types.d.ts +32 -0
- package/dist/external-tools/sbt/types.js +18 -0
- package/dist/external-tools/synp/asset-names.d.ts +14 -0
- package/dist/external-tools/synp/asset-names.js +32 -0
- package/dist/external-tools/synp/from-download.d.ts +18 -0
- package/dist/external-tools/synp/from-download.js +44 -0
- package/dist/external-tools/synp/from-path.d.ts +5 -0
- package/dist/external-tools/synp/from-path.js +40 -0
- package/dist/external-tools/synp/from-vfs.d.ts +7 -0
- package/dist/external-tools/synp/from-vfs.js +47 -0
- package/dist/external-tools/synp/resolve.d.ts +21 -0
- package/dist/external-tools/synp/resolve.js +72 -0
- package/dist/external-tools/synp/types.d.ts +19 -0
- package/dist/external-tools/synp/types.js +18 -0
- package/dist/external-tools/trivy/asset-names.d.ts +34 -0
- package/dist/external-tools/trivy/asset-names.js +68 -0
- package/dist/external-tools/trivy/from-download.d.ts +17 -0
- package/dist/external-tools/trivy/from-download.js +67 -0
- package/dist/external-tools/trivy/from-path.d.ts +5 -0
- package/dist/external-tools/trivy/from-path.js +40 -0
- package/dist/external-tools/trivy/from-vfs.d.ts +7 -0
- package/dist/external-tools/trivy/from-vfs.js +47 -0
- package/dist/external-tools/trivy/resolve.d.ts +26 -0
- package/dist/external-tools/trivy/resolve.js +73 -0
- package/dist/external-tools/trivy/types.d.ts +24 -0
- package/dist/external-tools/trivy/types.js +18 -0
- package/dist/external-tools/trufflehog/asset-names.d.ts +34 -0
- package/dist/external-tools/trufflehog/asset-names.js +72 -0
- package/dist/external-tools/trufflehog/from-download.d.ts +37 -0
- package/dist/external-tools/trufflehog/from-download.js +65 -0
- package/dist/external-tools/trufflehog/from-path.d.ts +7 -0
- package/dist/external-tools/trufflehog/from-path.js +40 -0
- package/dist/external-tools/trufflehog/from-vfs.d.ts +11 -0
- package/dist/external-tools/trufflehog/from-vfs.js +47 -0
- package/dist/external-tools/trufflehog/resolve.d.ts +30 -0
- package/dist/external-tools/trufflehog/resolve.js +73 -0
- package/dist/external-tools/trufflehog/types.d.ts +25 -0
- package/dist/external-tools/trufflehog/types.js +18 -0
- package/dist/external-tools/uv/asset-names.d.ts +36 -0
- package/dist/external-tools/uv/asset-names.js +80 -0
- package/dist/external-tools/uv/from-download.d.ts +17 -0
- package/dist/external-tools/uv/from-download.js +68 -0
- package/dist/external-tools/uv/from-path.d.ts +5 -0
- package/dist/external-tools/uv/from-path.js +40 -0
- package/dist/external-tools/uv/from-vfs.d.ts +7 -0
- package/dist/external-tools/uv/from-vfs.js +47 -0
- package/dist/external-tools/uv/resolve.d.ts +25 -0
- package/dist/external-tools/uv/resolve.js +73 -0
- package/dist/external-tools/uv/types.d.ts +24 -0
- package/dist/external-tools/uv/types.js +18 -0
- package/dist/fs/_internal.d.ts +22 -0
- package/dist/fs/_internal.js +48 -0
- package/dist/fs/encoding.d.ts +49 -0
- package/dist/fs/encoding.js +102 -0
- package/dist/fs/find-up.d.ts +58 -0
- package/dist/fs/find-up.js +152 -0
- package/dist/fs/inspect.d.ts +117 -0
- package/dist/fs/inspect.js +112 -0
- package/dist/fs/path-cache.d.ts +21 -0
- package/dist/fs/path-cache.js +35 -0
- package/dist/fs/read-dir.d.ts +66 -0
- package/dist/fs/read-dir.js +86 -0
- package/dist/fs/read-file.d.ts +150 -0
- package/dist/fs/read-file.js +131 -0
- package/dist/fs/read-json.d.ts +72 -0
- package/dist/fs/read-json.js +120 -0
- package/dist/fs/safe.d.ts +153 -0
- package/dist/fs/safe.js +182 -0
- package/dist/fs/types.d.ts +277 -0
- package/dist/fs/types.js +18 -0
- package/dist/fs/unique.d.ts +29 -0
- package/dist/fs/unique.js +51 -0
- package/dist/fs/validate.d.ts +40 -0
- package/dist/fs/validate.js +46 -0
- package/dist/fs/write-json.d.ts +78 -0
- package/dist/fs/write-json.js +83 -0
- package/dist/git/_internal.d.ts +105 -0
- package/dist/git/_internal.js +236 -0
- package/dist/git/changed.d.ts +145 -0
- package/dist/git/changed.js +83 -0
- package/dist/git/repo.d.ts +62 -0
- package/dist/git/repo.js +111 -0
- package/dist/git/staged.d.ts +138 -0
- package/dist/git/staged.js +71 -0
- package/dist/git/types.d.ts +109 -0
- package/dist/git/types.js +18 -0
- package/dist/git/unstaged.d.ts +141 -0
- package/dist/git/unstaged.js +71 -0
- package/dist/github/constants.d.ts +18 -0
- package/dist/github/constants.js +36 -0
- package/dist/github/errors.d.ts +36 -0
- package/dist/github/errors.js +40 -0
- package/dist/github/fetch.d.ts +89 -0
- package/dist/github/fetch.js +87 -0
- package/dist/github/ghsa.d.ts +118 -0
- package/dist/github/ghsa.js +178 -0
- package/dist/github/refs-cache.d.ts +40 -0
- package/dist/github/refs-cache.js +49 -0
- package/dist/github/refs-graphql.d.ts +42 -0
- package/dist/github/refs-graphql.js +109 -0
- package/dist/github/refs-rest.d.ts +23 -0
- package/dist/github/refs-rest.js +104 -0
- package/dist/github/refs.d.ts +84 -0
- package/dist/github/refs.js +67 -0
- package/dist/github/token.d.ts +77 -0
- package/dist/github/token.js +55 -0
- package/dist/github/types.d.ts +277 -0
- package/dist/github/types.js +18 -0
- package/dist/globs/_internal.d.ts +46 -0
- package/dist/globs/_internal.js +96 -0
- package/dist/globs/defaults.d.ts +7 -0
- package/dist/globs/defaults.js +61 -0
- package/dist/globs/glob.d.ts +59 -0
- package/dist/globs/glob.js +84 -0
- package/dist/globs/matcher.d.ts +46 -0
- package/dist/globs/matcher.js +99 -0
- package/dist/globs/stream.d.ts +18 -0
- package/dist/globs/stream.js +58 -0
- package/dist/globs/types.d.ts +35 -0
- package/dist/globs/types.js +18 -0
- package/dist/http-request/_internal.d.ts +18 -0
- package/dist/http-request/_internal.js +39 -0
- package/dist/http-request/checksums.d.ts +69 -0
- package/dist/http-request/checksums.js +72 -0
- package/dist/http-request/convenience.d.ts +104 -0
- package/dist/http-request/convenience.js +96 -0
- package/dist/http-request/download-types.d.ts +224 -0
- package/dist/http-request/download-types.js +18 -0
- package/dist/http-request/download.d.ts +71 -0
- package/dist/http-request/download.js +201 -0
- package/dist/http-request/errors.d.ts +23 -0
- package/dist/http-request/errors.js +50 -0
- package/dist/http-request/headers.d.ts +57 -0
- package/dist/http-request/headers.js +86 -0
- package/dist/http-request/request-attempt.d.ts +21 -0
- package/dist/http-request/request-attempt.js +284 -0
- package/dist/http-request/request-types.d.ts +238 -0
- package/dist/http-request/request-types.js +18 -0
- package/dist/http-request/request.d.ts +59 -0
- package/dist/http-request/request.js +106 -0
- package/dist/http-request/response-reader.d.ts +25 -0
- package/dist/http-request/response-reader.js +54 -0
- package/dist/http-request/response-types.d.ts +123 -0
- package/dist/http-request/response-types.js +40 -0
- package/dist/http-request/user-agent.d.ts +55 -0
- package/dist/http-request/user-agent.js +61 -0
- package/dist/{dlx/integrity.d.ts → integrity.d.ts} +36 -30
- package/dist/{dlx/integrity.js → integrity.js} +25 -19
- package/dist/ipc/_internal.d.ts +25 -0
- package/dist/ipc/_internal.js +50 -0
- package/dist/ipc/directory.d.ts +18 -0
- package/dist/ipc/directory.js +66 -0
- package/dist/ipc/paths.d.ts +37 -0
- package/dist/ipc/paths.js +48 -0
- package/dist/ipc/types.d.ts +22 -0
- package/dist/ipc/types.js +18 -0
- package/dist/ipc/write.d.ts +39 -0
- package/dist/ipc/write.js +77 -0
- package/dist/ipc-cli/get.d.ts +21 -0
- package/dist/{ipc-cli.js → ipc-cli/get.js} +5 -5
- package/dist/ipc-cli/types.d.ts +14 -0
- package/dist/ipc-cli/types.js +18 -0
- package/dist/json/edit.d.ts +22 -8
- package/dist/json/edit.js +85 -96
- package/dist/json/format.d.ts +100 -86
- package/dist/json/format.js +4 -3
- package/dist/json/parse.d.ts +113 -88
- package/dist/json/parse.js +30 -24
- package/dist/json/types.d.ts +133 -117
- package/dist/links/link.d.ts +65 -0
- package/dist/{links.js → links/link.js} +10 -10
- package/dist/links/types.d.ts +19 -0
- package/dist/links/types.js +18 -0
- package/dist/logger/_internal.d.ts +82 -0
- package/dist/logger/_internal.js +80 -0
- package/dist/logger/colors.d.ts +18 -0
- package/dist/logger/colors.js +54 -0
- package/dist/logger/console.d.ts +33 -0
- package/dist/logger/console.js +119 -0
- package/dist/logger/logger.d.ts +405 -0
- package/dist/logger/logger.js +854 -0
- package/dist/logger/symbols-builder.d.ts +29 -0
- package/dist/logger/symbols-builder.js +61 -0
- package/dist/logger/symbols.d.ts +61 -0
- package/dist/logger/symbols.js +129 -0
- package/dist/logger/types.d.ts +88 -0
- package/dist/logger/types.js +18 -0
- package/dist/memo/_internal.d.ts +16 -0
- package/dist/memo/_internal.js +53 -0
- package/dist/memo/async.d.ts +32 -0
- package/dist/memo/async.js +120 -0
- package/dist/memo/clear.d.ts +15 -0
- package/dist/memo/clear.js +37 -0
- package/dist/memo/decorator.d.ts +29 -0
- package/dist/memo/decorator.js +40 -0
- package/dist/memo/memoize.d.ts +33 -0
- package/dist/memo/memoize.js +91 -0
- package/dist/memo/once.d.ts +25 -0
- package/dist/memo/once.js +44 -0
- package/dist/memo/types.d.ts +43 -0
- package/dist/memo/types.js +18 -0
- package/dist/memo/weak.d.ts +26 -0
- package/dist/memo/weak.js +44 -0
- package/dist/node/async-hooks.d.ts +2 -2
- package/dist/node/child-process.d.ts +5 -7
- package/dist/node/crypto.d.ts +2 -2
- package/dist/node/events.d.ts +2 -2
- package/dist/node/fs-promises.d.ts +2 -2
- package/dist/node/fs.d.ts +6 -10
- package/dist/node/http.d.ts +2 -2
- package/dist/node/https.d.ts +2 -2
- package/dist/node/module.d.ts +7 -0
- package/dist/node/module.js +41 -0
- package/dist/node/os.d.ts +2 -2
- package/dist/node/path.d.ts +2 -2
- package/dist/node/timers-promises.d.ts +2 -2
- package/dist/node/url.d.ts +2 -2
- package/dist/node/util.d.ts +2 -2
- package/dist/objects/getters.d.ts +116 -0
- package/dist/objects/getters.js +137 -0
- package/dist/objects/inspect.d.ts +67 -0
- package/dist/objects/inspect.js +59 -0
- package/dist/objects/mutate.d.ts +72 -0
- package/dist/objects/mutate.js +81 -0
- package/dist/objects/predicates.d.ts +96 -0
- package/dist/objects/predicates.js +68 -0
- package/dist/objects/sort.d.ts +88 -0
- package/dist/objects/sort.js +85 -0
- package/dist/objects/types.d.ts +68 -0
- package/dist/objects/types.js +18 -0
- package/dist/packages/edit-class.d.ts +39 -0
- package/dist/packages/edit-class.js +269 -0
- package/dist/packages/edit.d.ts +60 -61
- package/dist/packages/edit.js +21 -286
- package/dist/packages/exports.d.ts +30 -28
- package/dist/packages/exports.js +38 -34
- package/dist/packages/isolation.d.ts +16 -7
- package/dist/packages/isolation.js +50 -57
- package/dist/packages/licenses.d.ts +49 -45
- package/dist/packages/licenses.js +13 -18
- package/dist/packages/manifest.d.ts +14 -14
- package/dist/packages/manifest.js +16 -15
- package/dist/packages/normalize.d.ts +17 -16
- package/dist/packages/normalize.js +20 -17
- package/dist/packages/operations.d.ts +49 -36
- package/dist/packages/operations.js +30 -15
- package/dist/packages/provenance.d.ts +22 -9
- package/dist/packages/provenance.js +76 -66
- package/dist/packages/specs.d.ts +21 -21
- package/dist/packages/specs.js +7 -7
- package/dist/{packages.d.ts → packages/types.d.ts} +12 -20
- package/dist/packages/types.js +18 -0
- package/dist/packages/validation.d.ts +13 -13
- package/dist/packages/validation.js +2 -2
- package/dist/paths/_internal.d.ts +51 -0
- package/dist/paths/_internal.js +102 -0
- package/dist/paths/conversion.d.ts +82 -0
- package/dist/paths/conversion.js +74 -0
- package/dist/paths/dirnames.d.ts +1 -1
- package/dist/paths/exts.d.ts +1 -1
- package/dist/paths/filenames.d.ts +1 -1
- package/dist/paths/globs.d.ts +1 -1
- package/dist/paths/normalize.d.ts +30 -440
- package/dist/paths/normalize.js +49 -289
- package/dist/paths/packages.d.ts +7 -1
- package/dist/paths/packages.js +7 -12
- package/dist/paths/predicates.d.ts +129 -0
- package/dist/paths/predicates.js +121 -0
- package/dist/paths/resolve.d.ts +71 -0
- package/dist/paths/resolve.js +135 -0
- package/dist/paths/rewire.d.ts +37 -38
- package/dist/paths/rewire.js +3 -3
- package/dist/paths/socket.d.ts +146 -47
- package/dist/paths/socket.js +23 -25
- package/dist/perf/_internal.d.ts +10 -0
- package/dist/perf/_internal.js +30 -0
- package/dist/perf/enabled.d.ts +13 -0
- package/dist/perf/enabled.js +33 -0
- package/dist/perf/metrics.d.ts +51 -0
- package/dist/perf/metrics.js +74 -0
- package/dist/perf/report.d.ts +40 -0
- package/dist/perf/report.js +85 -0
- package/dist/perf/timer.d.ts +100 -0
- package/dist/perf/timer.js +137 -0
- package/dist/perf/types.d.ts +15 -0
- package/dist/perf/types.js +18 -0
- package/dist/pkg-ext/data.d.ts +8 -0
- package/dist/{package-extensions.js → pkg-ext/data.js} +4 -4
- package/dist/pkg-ext/types.d.ts +6 -0
- package/dist/pkg-ext/types.js +18 -0
- package/dist/primordials/array.d.ts +73 -0
- package/dist/primordials/array.js +220 -0
- package/dist/primordials/buffer.d.ts +17 -0
- package/dist/primordials/buffer.js +61 -0
- package/dist/primordials/date.d.ts +16 -0
- package/dist/primordials/date.js +56 -0
- package/dist/primordials/error.d.ts +19 -0
- package/dist/primordials/error.js +75 -0
- package/dist/primordials/function.d.ts +10 -0
- package/dist/primordials/function.js +42 -0
- package/dist/primordials/globals.d.ts +17 -0
- package/dist/primordials/globals.js +54 -0
- package/dist/primordials/json.d.ts +11 -0
- package/dist/primordials/json.js +33 -0
- package/dist/primordials/map-set.d.ts +35 -0
- package/dist/primordials/map-set.js +115 -0
- package/dist/primordials/math.d.ts +51 -0
- package/dist/primordials/math.js +161 -0
- package/dist/primordials/number.d.ts +25 -0
- package/dist/primordials/number.js +92 -0
- package/dist/primordials/object.d.ts +74 -0
- package/dist/primordials/object.js +142 -0
- package/dist/primordials/promise.d.ts +34 -0
- package/dist/primordials/promise.js +61 -0
- package/dist/primordials/reflect.d.ts +18 -0
- package/dist/primordials/reflect.js +66 -0
- package/dist/primordials/regexp.d.ts +14 -0
- package/dist/primordials/regexp.js +50 -0
- package/dist/primordials/string.d.ts +71 -0
- package/dist/primordials/string.js +174 -0
- package/dist/primordials/symbol.d.ts +28 -0
- package/dist/primordials/symbol.js +94 -0
- package/dist/primordials/uncurry.d.ts +18 -0
- package/dist/primordials/uncurry.js +65 -0
- package/dist/primordials/url.d.ts +13 -0
- package/dist/primordials/url.js +69 -0
- package/dist/process/_internal.d.ts +8 -0
- package/dist/process/_internal.js +33 -0
- package/dist/process/abort.d.ts +20 -0
- package/dist/{constants/process.js → process/abort.js} +3 -3
- package/dist/process/lock-instance.d.ts +19 -0
- package/dist/process/lock-instance.js +31 -0
- package/dist/process/lock-manager.d.ts +152 -0
- package/dist/{process-lock.js → process/lock-manager.js} +97 -105
- package/dist/process/lock-types.d.ts +43 -0
- package/dist/process/lock-types.js +18 -0
- package/dist/process/transient.d.ts +22 -0
- package/dist/{temporary-executor.js → process/transient.js} +8 -8
- package/dist/promise-queue/queue.d.ts +51 -0
- package/dist/{promise-queue.js → promise-queue/queue.js} +27 -22
- package/dist/promise-queue/types.d.ts +10 -0
- package/dist/promise-queue/types.js +18 -0
- package/dist/promises/_internal.d.ts +15 -0
- package/dist/promises/_internal.js +41 -0
- package/dist/promises/iterate.d.ts +190 -0
- package/dist/promises/iterate.js +111 -0
- package/dist/promises/options.d.ts +76 -0
- package/dist/promises/options.js +108 -0
- package/dist/promises/resolvers.d.ts +55 -0
- package/dist/promises/resolvers.js +49 -0
- package/dist/promises/retry.d.ts +105 -0
- package/dist/promises/retry.js +104 -0
- package/dist/promises/types.d.ts +190 -0
- package/dist/promises/types.js +18 -0
- package/dist/regexps/escape.d.ts +6 -0
- package/dist/regexps/escape.js +32 -0
- package/dist/regexps/hex.d.ts +7 -0
- package/dist/regexps/hex.js +38 -0
- package/dist/regexps/spec.d.ts +15 -0
- package/dist/{regexps.js → regexps/spec.js} +32 -36
- package/dist/releases/github-archives.d.ts +47 -36
- package/dist/releases/github-archives.js +21 -35
- package/dist/releases/github-asset-url.d.ts +72 -0
- package/dist/releases/github-asset-url.js +167 -0
- package/dist/releases/github-assets.d.ts +13 -11
- package/dist/releases/github-assets.js +2 -2
- package/dist/releases/github-auth.d.ts +9 -9
- package/dist/releases/github-downloads.d.ts +31 -26
- package/dist/releases/github-downloads.js +22 -34
- package/dist/releases/github-listing.d.ts +105 -0
- package/dist/releases/github-listing.js +171 -0
- package/dist/releases/github-types.d.ts +45 -19
- package/dist/releases/socket-btm.d.ts +149 -99
- package/dist/releases/socket-btm.js +14 -20
- package/dist/schema/parse.d.ts +14 -15
- package/dist/schema/parse.js +2 -2
- package/dist/schema/types.d.ts +49 -37
- package/dist/schema/validate.d.ts +42 -19
- package/dist/schema/validate.js +15 -6
- package/dist/sea/detect.d.ts +37 -0
- package/dist/sea/{util.js → detect.js} +6 -6
- package/dist/secrets/_internal.d.ts +57 -0
- package/dist/secrets/_internal.js +84 -0
- package/dist/secrets/find.d.ts +79 -0
- package/dist/secrets/find.js +84 -0
- package/dist/secrets/keychain.d.ts +138 -0
- package/dist/secrets/keychain.js +328 -0
- package/dist/secrets/linux.d.ts +20 -0
- package/dist/secrets/linux.js +151 -0
- package/dist/secrets/macos.d.ts +36 -0
- package/dist/secrets/macos.js +165 -0
- package/dist/secrets/rc.d.ts +139 -0
- package/dist/secrets/rc.js +196 -0
- package/dist/secrets/socket-api-token.d.ts +23 -0
- package/dist/secrets/socket-api-token.js +50 -0
- package/dist/secrets/types.d.ts +69 -0
- package/dist/secrets/types.js +18 -0
- package/dist/secrets/windows.d.ts +50 -0
- package/dist/secrets/windows.js +318 -0
- package/dist/shadow/skip.d.ts +25 -0
- package/dist/{shadow.js → shadow/skip.js} +4 -4
- package/dist/shadow/types.d.ts +8 -0
- package/dist/shadow/types.js +18 -0
- package/dist/signal-exit/_internal.d.ts +68 -0
- package/dist/signal-exit/_internal.js +127 -0
- package/dist/signal-exit/intercept.d.ts +8 -0
- package/dist/signal-exit/intercept.js +75 -0
- package/dist/signal-exit/lifecycle.d.ts +28 -0
- package/dist/signal-exit/lifecycle.js +109 -0
- package/dist/signal-exit/register.d.ts +20 -0
- package/dist/signal-exit/register.js +58 -0
- package/dist/signal-exit/signals.d.ts +16 -0
- package/dist/signal-exit/signals.js +34 -0
- package/dist/signal-exit/types.d.ts +21 -0
- package/dist/signal-exit/types.js +18 -0
- package/dist/smol/detect.d.ts +80 -0
- package/dist/smol/{util.js → detect.js} +16 -24
- package/dist/smol/http.d.ts +60 -0
- package/dist/smol/http.js +42 -0
- package/dist/smol/https.d.ts +59 -0
- package/dist/smol/https.js +42 -0
- package/dist/smol/manifest.d.ts +140 -0
- package/dist/smol/manifest.js +42 -0
- package/dist/smol/primordial.d.ts +16 -21
- package/dist/smol/primordial.js +7 -11
- package/dist/smol/purl.d.ts +84 -0
- package/dist/smol/purl.js +42 -0
- package/dist/smol/versions.d.ts +11 -14
- package/dist/smol/versions.js +7 -11
- package/dist/smol/vfs.d.ts +99 -0
- package/dist/smol/vfs.js +43 -0
- package/dist/sorts/_internal.d.ts +9 -0
- package/dist/sorts/_internal.js +47 -0
- package/dist/sorts/natural.d.ts +39 -0
- package/dist/{sorts.js → sorts/natural.js} +5 -42
- package/dist/sorts/semver.d.ts +15 -0
- package/dist/sorts/semver.js +46 -0
- package/dist/sorts/strings.d.ts +16 -0
- package/dist/sorts/strings.js +33 -0
- package/dist/sorts/types.d.ts +7 -0
- package/dist/sorts/types.js +18 -0
- package/dist/spawn/_internal.d.ts +24 -0
- package/dist/spawn/_internal.js +62 -0
- package/dist/spawn/errors.d.ts +45 -0
- package/dist/spawn/errors.js +118 -0
- package/dist/spawn/spawn.d.ts +134 -0
- package/dist/{spawn.js → spawn/spawn.js} +29 -147
- package/dist/spawn/stdio.d.ts +37 -0
- package/dist/spawn/stdio.js +38 -0
- package/dist/spawn/types.d.ts +325 -0
- package/dist/spawn/types.js +18 -0
- package/dist/spinner/format.d.ts +64 -0
- package/dist/spinner/format.js +83 -0
- package/dist/spinner/registry.d.ts +49 -0
- package/dist/spinner/registry.js +70 -0
- package/dist/spinner/spinner.d.ts +40 -0
- package/dist/spinner/spinner.js +802 -0
- package/dist/spinner/types.d.ts +368 -0
- package/dist/spinner/types.js +18 -0
- package/dist/spinner/with.d.ts +125 -0
- package/dist/spinner/with.js +144 -0
- package/dist/ssri/convert.d.ts +48 -0
- package/dist/{ssri.js → ssri/convert.js} +11 -34
- package/dist/ssri/parse.d.ts +27 -0
- package/dist/ssri/parse.js +40 -0
- package/dist/ssri/validate.d.ts +41 -0
- package/dist/ssri/validate.js +39 -0
- package/dist/stdio/{_stream.d.ts → _internal.d.ts} +10 -5
- package/dist/stdio/{_stream.js → _internal.js} +3 -3
- package/dist/stdio/clear.d.ts +98 -84
- package/dist/stdio/divider.d.ts +100 -78
- package/dist/stdio/divider.js +36 -14
- package/dist/stdio/footer.d.ts +75 -51
- package/dist/stdio/footer.js +28 -18
- package/dist/stdio/header.d.ts +61 -50
- package/dist/stdio/header.js +15 -13
- package/dist/stdio/progress.d.ts +67 -57
- package/dist/stdio/progress.js +55 -51
- package/dist/stdio/prompts.d.ts +147 -100
- package/dist/stdio/prompts.js +23 -15
- package/dist/stdio/stderr.d.ts +86 -84
- package/dist/stdio/stderr.js +6 -6
- package/dist/stdio/stdout.d.ts +77 -78
- package/dist/stdio/stdout.js +6 -6
- package/dist/streams/parallel.d.ts +40 -0
- package/dist/{streams.js → streams/parallel.js} +10 -27
- package/dist/streams/transform.d.ts +20 -0
- package/dist/streams/transform.js +48 -0
- package/dist/strings/format.d.ts +115 -0
- package/dist/strings/format.js +73 -0
- package/dist/strings/predicates.d.ts +52 -0
- package/dist/strings/predicates.js +39 -0
- package/dist/strings/search.d.ts +34 -0
- package/dist/strings/search.js +45 -0
- package/dist/strings/transform.d.ts +80 -0
- package/dist/strings/transform.js +79 -0
- package/dist/strings/types.d.ts +38 -0
- package/dist/strings/types.js +18 -0
- package/dist/strings/width.d.ts +42 -0
- package/dist/strings/width.js +95 -0
- package/dist/tables/bordered.d.ts +44 -0
- package/dist/tables/bordered.js +84 -0
- package/dist/tables/padding.d.ts +18 -0
- package/dist/tables/padding.js +51 -0
- package/dist/tables/simple.d.ts +36 -0
- package/dist/tables/simple.js +73 -0
- package/dist/tables/types.d.ts +15 -0
- package/dist/tables/types.js +18 -0
- package/dist/temporal/instant.d.ts +39 -0
- package/dist/temporal/instant.js +91 -0
- package/dist/temporal/now.d.ts +24 -0
- package/dist/temporal/now.js +34 -0
- package/dist/temporal/slots.d.ts +32 -0
- package/dist/temporal/slots.js +45 -0
- package/dist/temporal/system.d.ts +20 -0
- package/dist/temporal/system.js +42 -0
- package/dist/temporal/temporal.d.ts +22 -0
- package/dist/temporal/temporal.js +43 -0
- package/dist/themes/context.d.ts +65 -48
- package/dist/themes/context.js +6 -2
- package/dist/themes/resolve.d.ts +90 -0
- package/dist/themes/{utils.js → resolve.js} +6 -6
- package/dist/themes/themes.d.ts +14 -16
- package/dist/themes/types.d.ts +93 -35
- package/dist/ttl-cache/cache.d.ts +29 -0
- package/dist/{cache-with-ttl.js → ttl-cache/cache.js} +45 -37
- package/dist/ttl-cache/types.d.ts +109 -0
- package/dist/ttl-cache/types.js +18 -0
- package/dist/url/parse.d.ts +26 -0
- package/dist/url/parse.js +57 -0
- package/dist/url/predicates.d.ts +15 -0
- package/dist/url/predicates.js +34 -0
- package/dist/url/search-params.d.ts +71 -0
- package/dist/{url.js → url/search-params.js} +19 -54
- package/dist/url/types.d.ts +20 -0
- package/dist/url/types.js +18 -0
- package/dist/versions/_internal.d.ts +24 -0
- package/dist/versions/_internal.js +37 -0
- package/dist/versions/compare.d.ts +57 -0
- package/dist/versions/compare.js +65 -0
- package/dist/versions/modify.d.ts +28 -0
- package/dist/versions/modify.js +44 -0
- package/dist/versions/parse.d.ts +67 -0
- package/dist/versions/parse.js +77 -0
- package/dist/versions/range.d.ts +45 -0
- package/dist/versions/range.js +50 -0
- package/dist/versions/types.d.ts +13 -0
- package/dist/versions/types.js +18 -0
- package/dist/warnings/event-target.d.ts +31 -0
- package/dist/warnings/event-target.js +43 -0
- package/dist/warnings/suppress.d.ts +65 -0
- package/dist/{suppress-warnings.js → warnings/suppress.js} +16 -28
- package/dist/words/article.d.ts +14 -0
- package/dist/words/article.js +33 -0
- package/dist/words/capitalize.d.ts +15 -0
- package/dist/{words.js → words/capitalize.js} +5 -18
- package/dist/words/pluralize.d.ts +16 -0
- package/dist/words/pluralize.js +34 -0
- package/dist/words/types.d.ts +7 -0
- package/dist/words/types.js +18 -0
- package/package.json +1939 -244
- package/dist/abort.d.ts +0 -27
- package/dist/agent.d.ts +0 -196
- package/dist/agent.js +0 -287
- package/dist/ansi.d.ts +0 -39
- package/dist/archives.d.ts +0 -95
- package/dist/archives.js +0 -408
- package/dist/argv/flags.d.ts +0 -292
- package/dist/argv/flags.js +0 -297
- package/dist/arrays.d.ts +0 -168
- package/dist/bin.d.ts +0 -181
- package/dist/bin.js +0 -544
- package/dist/cacache.d.ts +0 -130
- package/dist/cacache.js +0 -156
- package/dist/cache-with-ttl.d.ts +0 -165
- package/dist/colors.d.ts +0 -49
- package/dist/constants/process.d.ts +0 -20
- package/dist/crypto.d.ts +0 -36
- package/dist/debug.js +0 -337
- package/dist/env/helpers.d.ts +0 -66
- package/dist/env.d.ts +0 -182
- package/dist/env.js +0 -205
- package/dist/errors.d.ts +0 -100
- package/dist/fs.d.ts +0 -916
- package/dist/fs.js +0 -808
- package/dist/git.d.ts +0 -546
- package/dist/git.js +0 -409
- package/dist/github.d.ts +0 -526
- package/dist/github.js +0 -448
- package/dist/globs.d.ts +0 -119
- package/dist/globs.js +0 -282
- package/dist/http-request.d.ts +0 -951
- package/dist/http-request.js +0 -761
- package/dist/ipc-cli.d.ts +0 -28
- package/dist/ipc.d.ts +0 -76
- package/dist/ipc.js +0 -130
- package/dist/links.d.ts +0 -69
- package/dist/logger.d.ts +0 -993
- package/dist/logger.js +0 -1498
- package/dist/memoization.d.ts +0 -131
- package/dist/memoization.js +0 -243
- package/dist/objects.d.ts +0 -500
- package/dist/objects.js +0 -303
- package/dist/package-extensions.d.ts +0 -9
- package/dist/packages.js +0 -132
- package/dist/performance.d.ts +0 -181
- package/dist/performance.js +0 -233
- package/dist/primordials.d.ts +0 -420
- package/dist/primordials.js +0 -1116
- package/dist/process-lock.d.ts +0 -180
- package/dist/promise-queue.d.ts +0 -48
- package/dist/promises.d.ts +0 -506
- package/dist/promises.js +0 -292
- package/dist/regexps.d.ts +0 -6
- package/dist/releases/github-api.d.ts +0 -56
- package/dist/releases/github-api.js +0 -275
- package/dist/sea/util.d.ts +0 -43
- package/dist/shadow.d.ts +0 -28
- package/dist/signal-exit.d.ts +0 -50
- package/dist/signal-exit.js +0 -247
- package/dist/smol/util.d.ts +0 -87
- package/dist/sorts.d.ts +0 -59
- package/dist/spawn.d.ts +0 -454
- package/dist/spinner.d.ts +0 -444
- package/dist/spinner.js +0 -988
- package/dist/ssri.d.ts +0 -90
- package/dist/streams.d.ts +0 -45
- package/dist/strings.d.ts +0 -414
- package/dist/strings.js +0 -218
- package/dist/suppress-warnings.d.ts +0 -81
- package/dist/tables.d.ts +0 -73
- package/dist/tables.js +0 -133
- package/dist/temporary-executor.d.ts +0 -20
- package/dist/themes/utils.d.ts +0 -86
- package/dist/url.d.ts +0 -114
- package/dist/versions.d.ts +0 -207
- package/dist/versions.js +0 -181
- package/dist/words.d.ts +0 -39
package/dist/logger.d.ts
DELETED
|
@@ -1,993 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @fileoverview Console logging utilities with line prefix support.
|
|
3
|
-
* Provides enhanced console methods with formatted output capabilities.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Log symbols for terminal output with colored indicators.
|
|
7
|
-
*
|
|
8
|
-
* Each symbol provides visual feedback for different message types, with
|
|
9
|
-
* Unicode and ASCII fallback support.
|
|
10
|
-
*
|
|
11
|
-
* @example
|
|
12
|
-
* ```typescript
|
|
13
|
-
* import { LOG_SYMBOLS } from '@socketsecurity/lib'
|
|
14
|
-
*
|
|
15
|
-
* console.log(`${LOG_SYMBOLS.success} Operation completed`)
|
|
16
|
-
* console.log(`${LOG_SYMBOLS.fail} Operation failed`)
|
|
17
|
-
* console.log(`${LOG_SYMBOLS.warn} Warning message`)
|
|
18
|
-
* console.log(`${LOG_SYMBOLS.info} Information message`)
|
|
19
|
-
* console.log(`${LOG_SYMBOLS.step} Processing step`)
|
|
20
|
-
* console.log(`${LOG_SYMBOLS.progress} Working on task`)
|
|
21
|
-
* ```
|
|
22
|
-
*/
|
|
23
|
-
type LogSymbols = {
|
|
24
|
-
/** Red colored failure symbol (✖ or × in ASCII) */
|
|
25
|
-
fail: string;
|
|
26
|
-
/** Blue colored information symbol (ℹ or i in ASCII) */
|
|
27
|
-
info: string;
|
|
28
|
-
/** Cyan colored progress indicator symbol (∴ or :. in ASCII) */
|
|
29
|
-
progress: string;
|
|
30
|
-
/** Cyan colored skip symbol (↻ or @ in ASCII) */
|
|
31
|
-
skip: string;
|
|
32
|
-
/** Cyan colored step symbol (→ or > in ASCII) */
|
|
33
|
-
step: string;
|
|
34
|
-
/** Green colored success symbol (✔ or √ in ASCII) */
|
|
35
|
-
success: string;
|
|
36
|
-
/** Yellow colored warning symbol (⚠ or ‼ in ASCII) */
|
|
37
|
-
warn: string;
|
|
38
|
-
};
|
|
39
|
-
/**
|
|
40
|
-
* Type definition for logger methods that mirror console methods.
|
|
41
|
-
*
|
|
42
|
-
* All methods return the logger instance for method chaining.
|
|
43
|
-
*/
|
|
44
|
-
type LoggerMethods = {
|
|
45
|
-
[K in keyof typeof console]: (typeof console)[K] extends (...args: infer A) => any ? (...args: A) => Logger : (typeof console)[K];
|
|
46
|
-
};
|
|
47
|
-
/**
|
|
48
|
-
* A task that can be executed with automatic start/complete logging.
|
|
49
|
-
*
|
|
50
|
-
* @example
|
|
51
|
-
* ```typescript
|
|
52
|
-
* const task = logger.createTask('Database migration')
|
|
53
|
-
* task.run(() => {
|
|
54
|
-
* // Migration logic here
|
|
55
|
-
* })
|
|
56
|
-
* // Logs: "Starting task: Database migration"
|
|
57
|
-
* // Logs: "Completed task: Database migration"
|
|
58
|
-
* ```
|
|
59
|
-
*/
|
|
60
|
-
interface Task {
|
|
61
|
-
/**
|
|
62
|
-
* Executes the task function with automatic logging.
|
|
63
|
-
*
|
|
64
|
-
* @template T - The return type of the task function
|
|
65
|
-
* @param f - The function to execute
|
|
66
|
-
* @returns The result of the task function
|
|
67
|
-
*/
|
|
68
|
-
run<T>(f: () => T): T;
|
|
69
|
-
}
|
|
70
|
-
export type { LogSymbols, LoggerMethods, Task };
|
|
71
|
-
/**
|
|
72
|
-
* Log symbols for terminal output with colored indicators.
|
|
73
|
-
*
|
|
74
|
-
* Provides colored Unicode symbols (✖, ℹ, ∴, →, ✔, ⚠) with ASCII fallbacks (×, i, :., >, √, ‼)
|
|
75
|
-
* for terminals that don't support Unicode. Symbols are colored according to the active
|
|
76
|
-
* theme's color palette (error, info, reason, step, success, warning).
|
|
77
|
-
*
|
|
78
|
-
* The symbols are lazily initialized on first access and automatically update when the
|
|
79
|
-
* fallback theme changes (via setTheme()). Note that LOG_SYMBOLS reflect the global
|
|
80
|
-
* fallback theme, not async-local theme contexts from withTheme().
|
|
81
|
-
*
|
|
82
|
-
* @example
|
|
83
|
-
* ```typescript
|
|
84
|
-
* import { LOG_SYMBOLS } from '@socketsecurity/lib'
|
|
85
|
-
*
|
|
86
|
-
* console.log(`${LOG_SYMBOLS.fail} Build failed`) // Theme error color ✖
|
|
87
|
-
* console.log(`${LOG_SYMBOLS.info} Starting process`) // Theme info color ℹ
|
|
88
|
-
* console.log(`${LOG_SYMBOLS.progress} Working on task`) // Theme step color ∴
|
|
89
|
-
* console.log(`${LOG_SYMBOLS.step} Processing files`) // Theme step color →
|
|
90
|
-
* console.log(`${LOG_SYMBOLS.success} Build completed`) // Theme success color ✔
|
|
91
|
-
* console.log(`${LOG_SYMBOLS.warn} Deprecated API used`) // Theme warning color ⚠
|
|
92
|
-
* ```
|
|
93
|
-
*/
|
|
94
|
-
export declare const LOG_SYMBOLS: Record<string, string>;
|
|
95
|
-
/**
|
|
96
|
-
* Symbol for incrementing the internal log call counter.
|
|
97
|
-
*
|
|
98
|
-
* This is an internal symbol used to track the number of times logging
|
|
99
|
-
* methods have been called on a logger instance.
|
|
100
|
-
*/
|
|
101
|
-
export declare const incLogCallCountSymbol: unique symbol;
|
|
102
|
-
/**
|
|
103
|
-
* Symbol for tracking whether the last logged line was blank.
|
|
104
|
-
*
|
|
105
|
-
* This is used internally to prevent multiple consecutive blank lines
|
|
106
|
-
* and to determine whether to add spacing before certain messages.
|
|
107
|
-
*/
|
|
108
|
-
export declare const lastWasBlankSymbol: unique symbol;
|
|
109
|
-
/**
|
|
110
|
-
* Enhanced console logger with indentation, colored symbols, and stream management.
|
|
111
|
-
*
|
|
112
|
-
* Provides a fluent API for logging with automatic indentation tracking, colored
|
|
113
|
-
* status symbols, separate stderr/stdout management, and method chaining. All
|
|
114
|
-
* methods return `this` for easy chaining.
|
|
115
|
-
*
|
|
116
|
-
* Features:
|
|
117
|
-
* - Automatic line prefixing with indentation
|
|
118
|
-
* - Colored status symbols (success, fail, warn, info)
|
|
119
|
-
* - Separate indentation tracking for stderr and stdout
|
|
120
|
-
* - Stream-bound logger instances via `.stderr` and `.stdout`
|
|
121
|
-
* - Group/indentation management
|
|
122
|
-
* - Progress indicators with clearable lines
|
|
123
|
-
* - Task execution with automatic logging
|
|
124
|
-
*
|
|
125
|
-
* @example
|
|
126
|
-
* ```typescript
|
|
127
|
-
* import { logger } from '@socketsecurity/lib'
|
|
128
|
-
*
|
|
129
|
-
* // Basic logging with symbols
|
|
130
|
-
* logger.success('Build completed')
|
|
131
|
-
* logger.fail('Build failed')
|
|
132
|
-
* logger.warn('Deprecated API')
|
|
133
|
-
* logger.info('Starting process')
|
|
134
|
-
*
|
|
135
|
-
* // Indentation and grouping
|
|
136
|
-
* logger.log('Processing files:')
|
|
137
|
-
* logger.indent()
|
|
138
|
-
* logger.log('file1.js')
|
|
139
|
-
* logger.log('file2.js')
|
|
140
|
-
* logger.dedent()
|
|
141
|
-
*
|
|
142
|
-
* // Method chaining
|
|
143
|
-
* logger
|
|
144
|
-
* .log('Step 1')
|
|
145
|
-
* .indent()
|
|
146
|
-
* .log('Substep 1.1')
|
|
147
|
-
* .log('Substep 1.2')
|
|
148
|
-
* .dedent()
|
|
149
|
-
* .log('Step 2')
|
|
150
|
-
*
|
|
151
|
-
* // Stream-specific logging
|
|
152
|
-
* logger.stdout.log('Normal output')
|
|
153
|
-
* logger.stderr.error('Error message')
|
|
154
|
-
*
|
|
155
|
-
* // Progress indicators
|
|
156
|
-
* logger.progress('Processing...')
|
|
157
|
-
* // ... do work ...
|
|
158
|
-
* logger.clearLine()
|
|
159
|
-
* logger.success('Done')
|
|
160
|
-
*
|
|
161
|
-
* // Task execution
|
|
162
|
-
* const task = logger.createTask('Migration')
|
|
163
|
-
* task.run(() => {
|
|
164
|
-
* // Migration logic
|
|
165
|
-
* })
|
|
166
|
-
* ```
|
|
167
|
-
*/
|
|
168
|
-
export declare class Logger {
|
|
169
|
-
#private;
|
|
170
|
-
/**
|
|
171
|
-
* Static reference to log symbols for convenience.
|
|
172
|
-
*
|
|
173
|
-
* @example
|
|
174
|
-
* ```typescript
|
|
175
|
-
* console.log(`${Logger.LOG_SYMBOLS.success} Done`)
|
|
176
|
-
* ```
|
|
177
|
-
*/
|
|
178
|
-
static LOG_SYMBOLS: Record<string, string>;
|
|
179
|
-
/**
|
|
180
|
-
* Creates a new Logger instance.
|
|
181
|
-
*
|
|
182
|
-
* When called without arguments, creates a logger using the default
|
|
183
|
-
* `process.stdout` and `process.stderr` streams. Can accept custom
|
|
184
|
-
* console constructor arguments for advanced use cases.
|
|
185
|
-
*
|
|
186
|
-
* @param args - Optional console constructor arguments
|
|
187
|
-
*
|
|
188
|
-
* @example
|
|
189
|
-
* ```typescript
|
|
190
|
-
* // Default logger
|
|
191
|
-
* const logger = new Logger()
|
|
192
|
-
*
|
|
193
|
-
* // Custom streams (advanced)
|
|
194
|
-
* const customLogger = new Logger({
|
|
195
|
-
* stdout: customWritableStream,
|
|
196
|
-
* stderr: customErrorStream
|
|
197
|
-
* })
|
|
198
|
-
* ```
|
|
199
|
-
*/
|
|
200
|
-
constructor(...args: unknown[]);
|
|
201
|
-
/**
|
|
202
|
-
* Gets a logger instance bound exclusively to stderr.
|
|
203
|
-
*
|
|
204
|
-
* All logging operations on this instance will write to stderr only.
|
|
205
|
-
* Indentation is tracked separately from stdout. The instance is
|
|
206
|
-
* cached and reused on subsequent accesses.
|
|
207
|
-
*
|
|
208
|
-
* @returns A logger instance bound to stderr
|
|
209
|
-
*
|
|
210
|
-
* @example
|
|
211
|
-
* ```typescript
|
|
212
|
-
* // Write errors to stderr
|
|
213
|
-
* logger.stderr.error('Configuration invalid')
|
|
214
|
-
* logger.stderr.warn('Using fallback settings')
|
|
215
|
-
*
|
|
216
|
-
* // Indent only affects stderr
|
|
217
|
-
* logger.stderr.indent()
|
|
218
|
-
* logger.stderr.error('Nested error details')
|
|
219
|
-
* logger.stderr.dedent()
|
|
220
|
-
* ```
|
|
221
|
-
*/
|
|
222
|
-
get stderr(): Logger;
|
|
223
|
-
/**
|
|
224
|
-
* Gets a logger instance bound exclusively to stdout.
|
|
225
|
-
*
|
|
226
|
-
* All logging operations on this instance will write to stdout only.
|
|
227
|
-
* Indentation is tracked separately from stderr. The instance is
|
|
228
|
-
* cached and reused on subsequent accesses.
|
|
229
|
-
*
|
|
230
|
-
* @returns A logger instance bound to stdout
|
|
231
|
-
*
|
|
232
|
-
* @example
|
|
233
|
-
* ```typescript
|
|
234
|
-
* // Write normal output to stdout
|
|
235
|
-
* logger.stdout.log('Processing started')
|
|
236
|
-
* logger.stdout.log('Items processed: 42')
|
|
237
|
-
*
|
|
238
|
-
* // Indent only affects stdout
|
|
239
|
-
* logger.stdout.indent()
|
|
240
|
-
* logger.stdout.log('Detailed output')
|
|
241
|
-
* logger.stdout.dedent()
|
|
242
|
-
* ```
|
|
243
|
-
*/
|
|
244
|
-
get stdout(): Logger;
|
|
245
|
-
/**
|
|
246
|
-
* Gets the total number of log calls made on this logger instance.
|
|
247
|
-
*
|
|
248
|
-
* Tracks all logging method calls including `log()`, `error()`, `warn()`,
|
|
249
|
-
* `success()`, `fail()`, etc. Useful for testing and monitoring logging activity.
|
|
250
|
-
*
|
|
251
|
-
* @returns The number of times logging methods have been called
|
|
252
|
-
*
|
|
253
|
-
* @example
|
|
254
|
-
* ```typescript
|
|
255
|
-
* logger.log('Message 1')
|
|
256
|
-
* logger.error('Message 2')
|
|
257
|
-
* console.log(logger.logCallCount) // 2
|
|
258
|
-
* ```
|
|
259
|
-
*/
|
|
260
|
-
get logCallCount(): number;
|
|
261
|
-
/**
|
|
262
|
-
* Increments the internal log call counter.
|
|
263
|
-
*
|
|
264
|
-
* This is called automatically by logging methods and should not
|
|
265
|
-
* be called directly in normal usage.
|
|
266
|
-
*
|
|
267
|
-
* @returns The logger instance for chaining
|
|
268
|
-
*/
|
|
269
|
-
[incLogCallCountSymbol](): this;
|
|
270
|
-
/**
|
|
271
|
-
* Sets whether the last logged line was blank.
|
|
272
|
-
*
|
|
273
|
-
* Used internally to track blank lines and prevent duplicate spacing.
|
|
274
|
-
* This is called automatically by logging methods.
|
|
275
|
-
*
|
|
276
|
-
* @param value - Whether the last line was blank
|
|
277
|
-
* @param stream - Optional stream to update (defaults to both streams if not bound, or target stream if bound)
|
|
278
|
-
* @returns The logger instance for chaining
|
|
279
|
-
*/
|
|
280
|
-
[lastWasBlankSymbol](value: unknown, stream?: 'stderr' | 'stdout'): this;
|
|
281
|
-
/**
|
|
282
|
-
* Logs an assertion failure message if the value is falsy.
|
|
283
|
-
*
|
|
284
|
-
* Works like `console.assert()` but returns the logger for chaining.
|
|
285
|
-
* If the value is truthy, nothing is logged. If falsy, logs an error
|
|
286
|
-
* message with an assertion failure.
|
|
287
|
-
*
|
|
288
|
-
* @param value - The value to test
|
|
289
|
-
* @param message - Optional message and additional arguments to log
|
|
290
|
-
* @returns The logger instance for chaining
|
|
291
|
-
*
|
|
292
|
-
* @example
|
|
293
|
-
* ```typescript
|
|
294
|
-
* logger.assert(true, 'This will not log')
|
|
295
|
-
* logger.assert(false, 'Assertion failed: value is false')
|
|
296
|
-
* logger.assert(items.length > 0, 'No items found')
|
|
297
|
-
* ```
|
|
298
|
-
*/
|
|
299
|
-
assert(value: unknown, ...message: unknown[]): this;
|
|
300
|
-
/**
|
|
301
|
-
* Clears the current line in the terminal.
|
|
302
|
-
*
|
|
303
|
-
* Moves the cursor to the beginning of the line and clears all content.
|
|
304
|
-
* Works in both TTY and non-TTY environments. Useful for clearing
|
|
305
|
-
* progress indicators created with `progress()`.
|
|
306
|
-
*
|
|
307
|
-
* The stream to clear (stderr or stdout) depends on whether the logger
|
|
308
|
-
* is stream-bound.
|
|
309
|
-
*
|
|
310
|
-
* @returns The logger instance for chaining
|
|
311
|
-
*
|
|
312
|
-
* @example
|
|
313
|
-
* ```typescript
|
|
314
|
-
* logger.progress('Loading...')
|
|
315
|
-
* // ... do work ...
|
|
316
|
-
* logger.clearLine()
|
|
317
|
-
* logger.success('Loaded')
|
|
318
|
-
*
|
|
319
|
-
* // Clear multiple progress updates
|
|
320
|
-
* for (const file of files) {
|
|
321
|
-
* logger.progress(`Processing ${file}`)
|
|
322
|
-
* processFile(file)
|
|
323
|
-
* logger.clearLine()
|
|
324
|
-
* }
|
|
325
|
-
* logger.success('All files processed')
|
|
326
|
-
* ```
|
|
327
|
-
*/
|
|
328
|
-
clearLine(): this;
|
|
329
|
-
/**
|
|
330
|
-
* Clears the visible terminal screen.
|
|
331
|
-
*
|
|
332
|
-
* Only available on the main logger instance, not on stream-bound instances
|
|
333
|
-
* (`.stderr` or `.stdout`). Resets the log call count and blank line tracking
|
|
334
|
-
* if the output is a TTY.
|
|
335
|
-
*
|
|
336
|
-
* @returns The logger instance for chaining
|
|
337
|
-
* @throws {Error} If called on a stream-bound logger instance
|
|
338
|
-
*
|
|
339
|
-
* @example
|
|
340
|
-
* ```typescript
|
|
341
|
-
* logger.log('Some output')
|
|
342
|
-
* logger.clearVisible() // Screen is now clear
|
|
343
|
-
*
|
|
344
|
-
* // Error: Can't call on stream-bound instance
|
|
345
|
-
* logger.stderr.clearVisible() // throws
|
|
346
|
-
* ```
|
|
347
|
-
*/
|
|
348
|
-
clearVisible(): this;
|
|
349
|
-
/**
|
|
350
|
-
* Increments and logs a counter for the given label.
|
|
351
|
-
*
|
|
352
|
-
* Each unique label maintains its own counter. Works like `console.count()`.
|
|
353
|
-
*
|
|
354
|
-
* @param label - Optional label for the counter
|
|
355
|
-
* @default 'default'
|
|
356
|
-
* @returns The logger instance for chaining
|
|
357
|
-
*
|
|
358
|
-
* @example
|
|
359
|
-
* ```typescript
|
|
360
|
-
* logger.count('requests') // requests: 1
|
|
361
|
-
* logger.count('requests') // requests: 2
|
|
362
|
-
* logger.count('errors') // errors: 1
|
|
363
|
-
* logger.count() // default: 1
|
|
364
|
-
* ```
|
|
365
|
-
*/
|
|
366
|
-
count(label?: string | undefined): this;
|
|
367
|
-
/**
|
|
368
|
-
* Creates a task that logs start and completion messages automatically.
|
|
369
|
-
*
|
|
370
|
-
* Returns a task object with a `run()` method that executes the provided
|
|
371
|
-
* function and logs "Starting task: {name}" before execution and
|
|
372
|
-
* "Completed task: {name}" after completion.
|
|
373
|
-
*
|
|
374
|
-
* @param name - The name of the task
|
|
375
|
-
* @returns A task object with a `run()` method
|
|
376
|
-
*
|
|
377
|
-
* @example
|
|
378
|
-
* ```typescript
|
|
379
|
-
* const task = logger.createTask('Database Migration')
|
|
380
|
-
* const result = task.run(() => {
|
|
381
|
-
* // Logs: "Starting task: Database Migration"
|
|
382
|
-
* migrateDatabase()
|
|
383
|
-
* return 'success'
|
|
384
|
-
* // Logs: "Completed task: Database Migration"
|
|
385
|
-
* })
|
|
386
|
-
* console.log(result) // 'success'
|
|
387
|
-
* ```
|
|
388
|
-
*/
|
|
389
|
-
createTask(name: string): Task;
|
|
390
|
-
/**
|
|
391
|
-
* Decreases the indentation level by removing spaces from the prefix.
|
|
392
|
-
*
|
|
393
|
-
* When called on the main logger, affects both stderr and stdout indentation.
|
|
394
|
-
* When called on a stream-bound logger (`.stderr` or `.stdout`), affects
|
|
395
|
-
* only that stream's indentation.
|
|
396
|
-
*
|
|
397
|
-
* @param spaces - Number of spaces to remove from indentation
|
|
398
|
-
* @default 2
|
|
399
|
-
* @returns The logger instance for chaining
|
|
400
|
-
*
|
|
401
|
-
* @example
|
|
402
|
-
* ```typescript
|
|
403
|
-
* logger.indent()
|
|
404
|
-
* logger.log('Indented')
|
|
405
|
-
* logger.dedent()
|
|
406
|
-
* logger.log('Back to normal')
|
|
407
|
-
*
|
|
408
|
-
* // Remove custom amount
|
|
409
|
-
* logger.indent(4)
|
|
410
|
-
* logger.log('Four spaces')
|
|
411
|
-
* logger.dedent(4)
|
|
412
|
-
*
|
|
413
|
-
* // Stream-specific dedent
|
|
414
|
-
* logger.stdout.indent()
|
|
415
|
-
* logger.stdout.log('Indented stdout')
|
|
416
|
-
* logger.stdout.dedent()
|
|
417
|
-
* ```
|
|
418
|
-
*/
|
|
419
|
-
dedent(spaces?: number): this;
|
|
420
|
-
/**
|
|
421
|
-
* Displays an object's properties in a formatted way.
|
|
422
|
-
*
|
|
423
|
-
* Works like `console.dir()` with customizable options for depth,
|
|
424
|
-
* colors, etc. Useful for inspecting complex objects.
|
|
425
|
-
*
|
|
426
|
-
* @param obj - The object to display
|
|
427
|
-
* @param options - Optional formatting options (Node.js inspect options)
|
|
428
|
-
* @returns The logger instance for chaining
|
|
429
|
-
*
|
|
430
|
-
* @example
|
|
431
|
-
* ```typescript
|
|
432
|
-
* const obj = { a: 1, b: { c: 2, d: { e: 3 } } }
|
|
433
|
-
* logger.dir(obj)
|
|
434
|
-
* logger.dir(obj, { depth: 1 }) // Limit nesting depth
|
|
435
|
-
* logger.dir(obj, { colors: true }) // Enable colors
|
|
436
|
-
* ```
|
|
437
|
-
*/
|
|
438
|
-
dir(obj: unknown, options?: unknown | undefined): this;
|
|
439
|
-
/**
|
|
440
|
-
* Displays data as XML/HTML in a formatted way.
|
|
441
|
-
*
|
|
442
|
-
* Works like `console.dirxml()`. In Node.js, behaves the same as `dir()`.
|
|
443
|
-
*
|
|
444
|
-
* @param data - The data to display
|
|
445
|
-
* @returns The logger instance for chaining
|
|
446
|
-
*
|
|
447
|
-
* @example
|
|
448
|
-
* ```typescript
|
|
449
|
-
* logger.dirxml(document.body) // In browser environments
|
|
450
|
-
* logger.dirxml(xmlObject) // In Node.js
|
|
451
|
-
* ```
|
|
452
|
-
*/
|
|
453
|
-
dirxml(...data: unknown[]): this;
|
|
454
|
-
/**
|
|
455
|
-
* Logs a completion message with a success symbol (alias for `success()`).
|
|
456
|
-
*
|
|
457
|
-
* Provides semantic clarity when marking something as "done". Does NOT
|
|
458
|
-
* automatically clear the current line - call `clearLine()` first if
|
|
459
|
-
* needed after using `progress()`.
|
|
460
|
-
*
|
|
461
|
-
* @param args - Message and additional arguments to log
|
|
462
|
-
* @returns The logger instance for chaining
|
|
463
|
-
*
|
|
464
|
-
* @example
|
|
465
|
-
* ```typescript
|
|
466
|
-
* logger.done('Task completed')
|
|
467
|
-
*
|
|
468
|
-
* // After progress indicator
|
|
469
|
-
* logger.progress('Processing...')
|
|
470
|
-
* // ... do work ...
|
|
471
|
-
* logger.clearLine()
|
|
472
|
-
* logger.done('Processing complete')
|
|
473
|
-
* ```
|
|
474
|
-
*/
|
|
475
|
-
done(...args: unknown[]): this;
|
|
476
|
-
/**
|
|
477
|
-
* Logs an error message to stderr.
|
|
478
|
-
*
|
|
479
|
-
* Automatically applies current indentation. All arguments are formatted
|
|
480
|
-
* and logged like `console.error()`.
|
|
481
|
-
*
|
|
482
|
-
* @param args - Message and additional arguments to log
|
|
483
|
-
* @returns The logger instance for chaining
|
|
484
|
-
*
|
|
485
|
-
* @example
|
|
486
|
-
* ```typescript
|
|
487
|
-
* logger.error('Build failed')
|
|
488
|
-
* logger.error('Error code:', 500)
|
|
489
|
-
* logger.error('Details:', { message: 'Not found' })
|
|
490
|
-
* ```
|
|
491
|
-
*/
|
|
492
|
-
error(...args: unknown[]): this;
|
|
493
|
-
/**
|
|
494
|
-
* Logs a newline to stderr only if the last line wasn't already blank.
|
|
495
|
-
*
|
|
496
|
-
* Prevents multiple consecutive blank lines. Useful for adding spacing
|
|
497
|
-
* between sections without creating excessive whitespace.
|
|
498
|
-
*
|
|
499
|
-
* @returns The logger instance for chaining
|
|
500
|
-
*
|
|
501
|
-
* @example
|
|
502
|
-
* ```typescript
|
|
503
|
-
* logger.error('Error message')
|
|
504
|
-
* logger.errorNewline() // Adds blank line
|
|
505
|
-
* logger.errorNewline() // Does nothing (already blank)
|
|
506
|
-
* logger.error('Next section')
|
|
507
|
-
* ```
|
|
508
|
-
*/
|
|
509
|
-
errorNewline(): this;
|
|
510
|
-
/**
|
|
511
|
-
* Logs a failure message with a red colored fail symbol.
|
|
512
|
-
*
|
|
513
|
-
* Automatically prefixes the message with `LOG_SYMBOLS.fail` (red ✖).
|
|
514
|
-
* Always outputs to stderr. If the message starts with an existing
|
|
515
|
-
* symbol, it will be stripped and replaced.
|
|
516
|
-
*
|
|
517
|
-
* @param args - Message and additional arguments to log
|
|
518
|
-
* @returns The logger instance for chaining
|
|
519
|
-
*
|
|
520
|
-
* @example
|
|
521
|
-
* ```typescript
|
|
522
|
-
* logger.fail('Build failed')
|
|
523
|
-
* logger.fail('Test suite failed:', { passed: 5, failed: 3 })
|
|
524
|
-
* ```
|
|
525
|
-
*/
|
|
526
|
-
fail(...args: unknown[]): this;
|
|
527
|
-
/**
|
|
528
|
-
* Starts a new indented log group.
|
|
529
|
-
*
|
|
530
|
-
* If a label is provided, it's logged before increasing indentation.
|
|
531
|
-
* Groups can be nested. Each group increases indentation by the
|
|
532
|
-
* `kGroupIndentWidth` (default 2 spaces). Call `groupEnd()` to close.
|
|
533
|
-
*
|
|
534
|
-
* @param label - Optional label to display before the group
|
|
535
|
-
* @returns The logger instance for chaining
|
|
536
|
-
*
|
|
537
|
-
* @example
|
|
538
|
-
* ```typescript
|
|
539
|
-
* logger.group('Processing files:')
|
|
540
|
-
* logger.log('file1.js')
|
|
541
|
-
* logger.log('file2.js')
|
|
542
|
-
* logger.groupEnd()
|
|
543
|
-
*
|
|
544
|
-
* // Nested groups
|
|
545
|
-
* logger.group('Outer')
|
|
546
|
-
* logger.log('Outer content')
|
|
547
|
-
* logger.group('Inner')
|
|
548
|
-
* logger.log('Inner content')
|
|
549
|
-
* logger.groupEnd()
|
|
550
|
-
* logger.groupEnd()
|
|
551
|
-
* ```
|
|
552
|
-
*/
|
|
553
|
-
group(...label: unknown[]): this;
|
|
554
|
-
/**
|
|
555
|
-
* Starts a new collapsed log group (alias for `group()`).
|
|
556
|
-
*
|
|
557
|
-
* In browser consoles, this creates a collapsed group. In Node.js,
|
|
558
|
-
* it behaves identically to `group()`.
|
|
559
|
-
*
|
|
560
|
-
* @param label - Optional label to display before the group
|
|
561
|
-
* @returns The logger instance for chaining
|
|
562
|
-
*
|
|
563
|
-
* @example
|
|
564
|
-
* ```typescript
|
|
565
|
-
* logger.groupCollapsed('Details')
|
|
566
|
-
* logger.log('Hidden by default in browsers')
|
|
567
|
-
* logger.groupEnd()
|
|
568
|
-
* ```
|
|
569
|
-
*/
|
|
570
|
-
groupCollapsed(...label: unknown[]): this;
|
|
571
|
-
/**
|
|
572
|
-
* Ends the current log group and decreases indentation.
|
|
573
|
-
*
|
|
574
|
-
* Must be called once for each `group()` or `groupCollapsed()` call
|
|
575
|
-
* to properly close the group and restore indentation.
|
|
576
|
-
*
|
|
577
|
-
* @returns The logger instance for chaining
|
|
578
|
-
*
|
|
579
|
-
* @example
|
|
580
|
-
* ```typescript
|
|
581
|
-
* logger.group('Group 1')
|
|
582
|
-
* logger.log('Content')
|
|
583
|
-
* logger.groupEnd() // Closes 'Group 1'
|
|
584
|
-
* ```
|
|
585
|
-
*/
|
|
586
|
-
groupEnd(): this;
|
|
587
|
-
/**
|
|
588
|
-
* Increases the indentation level by adding spaces to the prefix.
|
|
589
|
-
*
|
|
590
|
-
* When called on the main logger, affects both stderr and stdout indentation.
|
|
591
|
-
* When called on a stream-bound logger (`.stderr` or `.stdout`), affects
|
|
592
|
-
* only that stream's indentation. Maximum indentation is 1000 spaces.
|
|
593
|
-
*
|
|
594
|
-
* @param spaces - Number of spaces to add to indentation
|
|
595
|
-
* @default 2
|
|
596
|
-
* @returns The logger instance for chaining
|
|
597
|
-
*
|
|
598
|
-
* @example
|
|
599
|
-
* ```typescript
|
|
600
|
-
* logger.log('Level 0')
|
|
601
|
-
* logger.indent()
|
|
602
|
-
* logger.log('Level 1')
|
|
603
|
-
* logger.indent()
|
|
604
|
-
* logger.log('Level 2')
|
|
605
|
-
* logger.dedent()
|
|
606
|
-
* logger.dedent()
|
|
607
|
-
*
|
|
608
|
-
* // Custom indent amount
|
|
609
|
-
* logger.indent(4)
|
|
610
|
-
* logger.log('Indented 4 spaces')
|
|
611
|
-
* logger.dedent(4)
|
|
612
|
-
*
|
|
613
|
-
* // Stream-specific indent
|
|
614
|
-
* logger.stdout.indent()
|
|
615
|
-
* logger.stdout.log('Only stdout is indented')
|
|
616
|
-
* ```
|
|
617
|
-
*/
|
|
618
|
-
indent(spaces?: number): this;
|
|
619
|
-
/**
|
|
620
|
-
* Logs an informational message with a blue colored info symbol.
|
|
621
|
-
*
|
|
622
|
-
* Automatically prefixes the message with `LOG_SYMBOLS.info` (blue ℹ).
|
|
623
|
-
* Always outputs to stderr. If the message starts with an existing
|
|
624
|
-
* symbol, it will be stripped and replaced.
|
|
625
|
-
*
|
|
626
|
-
* @param args - Message and additional arguments to log
|
|
627
|
-
* @returns The logger instance for chaining
|
|
628
|
-
*
|
|
629
|
-
* @example
|
|
630
|
-
* ```typescript
|
|
631
|
-
* logger.info('Starting build process')
|
|
632
|
-
* logger.info('Configuration loaded:', config)
|
|
633
|
-
* logger.info('Using cache directory:', cacheDir)
|
|
634
|
-
* ```
|
|
635
|
-
*/
|
|
636
|
-
info(...args: unknown[]): this;
|
|
637
|
-
/**
|
|
638
|
-
* Logs a message to stdout.
|
|
639
|
-
*
|
|
640
|
-
* Automatically applies current indentation. All arguments are formatted
|
|
641
|
-
* and logged like `console.log()`. This is the primary method for
|
|
642
|
-
* standard output.
|
|
643
|
-
*
|
|
644
|
-
* @param args - Message and additional arguments to log
|
|
645
|
-
* @returns The logger instance for chaining
|
|
646
|
-
*
|
|
647
|
-
* @example
|
|
648
|
-
* ```typescript
|
|
649
|
-
* logger.log('Processing complete')
|
|
650
|
-
* logger.log('Items processed:', 42)
|
|
651
|
-
* logger.log('Results:', { success: true, count: 10 })
|
|
652
|
-
*
|
|
653
|
-
* // Method chaining
|
|
654
|
-
* logger.log('Step 1').log('Step 2').log('Step 3')
|
|
655
|
-
* ```
|
|
656
|
-
*/
|
|
657
|
-
log(...args: unknown[]): this;
|
|
658
|
-
/**
|
|
659
|
-
* Logs a newline to stdout only if the last line wasn't already blank.
|
|
660
|
-
*
|
|
661
|
-
* Prevents multiple consecutive blank lines. Useful for adding spacing
|
|
662
|
-
* between sections without creating excessive whitespace.
|
|
663
|
-
*
|
|
664
|
-
* @returns The logger instance for chaining
|
|
665
|
-
*
|
|
666
|
-
* @example
|
|
667
|
-
* ```typescript
|
|
668
|
-
* logger.log('Section 1')
|
|
669
|
-
* logger.logNewline() // Adds blank line
|
|
670
|
-
* logger.logNewline() // Does nothing (already blank)
|
|
671
|
-
* logger.log('Section 2')
|
|
672
|
-
* ```
|
|
673
|
-
*/
|
|
674
|
-
logNewline(): this;
|
|
675
|
-
/**
|
|
676
|
-
* Shows a progress indicator that can be cleared with `clearLine()`.
|
|
677
|
-
*
|
|
678
|
-
* Displays a simple status message with a '∴' prefix. Does not include
|
|
679
|
-
* animation or spinner. Intended to be cleared once the operation completes.
|
|
680
|
-
* The output stream (stderr or stdout) depends on whether the logger is
|
|
681
|
-
* stream-bound.
|
|
682
|
-
*
|
|
683
|
-
* @param text - The progress message to display
|
|
684
|
-
* @returns The logger instance for chaining
|
|
685
|
-
*
|
|
686
|
-
* @example
|
|
687
|
-
* ```typescript
|
|
688
|
-
* logger.progress('Processing files...')
|
|
689
|
-
* // ... do work ...
|
|
690
|
-
* logger.clearLine()
|
|
691
|
-
* logger.success('Files processed')
|
|
692
|
-
*
|
|
693
|
-
* // Stream-specific progress
|
|
694
|
-
* logger.stdout.progress('Loading...')
|
|
695
|
-
* // ... do work ...
|
|
696
|
-
* logger.stdout.clearLine()
|
|
697
|
-
* logger.stdout.log('Done')
|
|
698
|
-
* ```
|
|
699
|
-
*/
|
|
700
|
-
progress(text: string): this;
|
|
701
|
-
/**
|
|
702
|
-
* Resets all indentation to zero.
|
|
703
|
-
*
|
|
704
|
-
* When called on the main logger, resets both stderr and stdout indentation.
|
|
705
|
-
* When called on a stream-bound logger (`.stderr` or `.stdout`), resets
|
|
706
|
-
* only that stream's indentation.
|
|
707
|
-
*
|
|
708
|
-
* @returns The logger instance for chaining
|
|
709
|
-
*
|
|
710
|
-
* @example
|
|
711
|
-
* ```typescript
|
|
712
|
-
* logger.indent().indent().indent()
|
|
713
|
-
* logger.log('Very indented')
|
|
714
|
-
* logger.resetIndent()
|
|
715
|
-
* logger.log('Back to zero indentation')
|
|
716
|
-
*
|
|
717
|
-
* // Reset only stdout
|
|
718
|
-
* logger.stdout.resetIndent()
|
|
719
|
-
* ```
|
|
720
|
-
*/
|
|
721
|
-
resetIndent(): this;
|
|
722
|
-
/**
|
|
723
|
-
* Logs a skip message with a cyan colored skip symbol.
|
|
724
|
-
*
|
|
725
|
-
* Automatically prefixes the message with `LOG_SYMBOLS.skip` (cyan ↻).
|
|
726
|
-
* Always outputs to stderr. If the message starts with an existing
|
|
727
|
-
* symbol, it will be stripped and replaced.
|
|
728
|
-
*
|
|
729
|
-
* @param args - Message and additional arguments to log
|
|
730
|
-
* @returns The logger instance for chaining
|
|
731
|
-
*
|
|
732
|
-
* @example
|
|
733
|
-
* ```typescript
|
|
734
|
-
* logger.skip('Test skipped due to environment')
|
|
735
|
-
* logger.skip('Skipping optional step')
|
|
736
|
-
* logger.skip('Feature disabled, skipping')
|
|
737
|
-
* ```
|
|
738
|
-
*/
|
|
739
|
-
skip(...args: unknown[]): this;
|
|
740
|
-
/**
|
|
741
|
-
* Logs a main step message with a cyan arrow symbol and blank line before it.
|
|
742
|
-
*
|
|
743
|
-
* Automatically prefixes the message with `LOG_SYMBOLS.step` (cyan →) and
|
|
744
|
-
* adds a blank line before the message unless the last line was already blank.
|
|
745
|
-
* Useful for marking major steps in a process with clear visual separation.
|
|
746
|
-
* Always outputs to stdout. If the message starts with an existing symbol,
|
|
747
|
-
* it will be stripped and replaced.
|
|
748
|
-
*
|
|
749
|
-
* @param msg - The step message to log
|
|
750
|
-
* @param extras - Additional arguments to log
|
|
751
|
-
* @returns The logger instance for chaining
|
|
752
|
-
*
|
|
753
|
-
* @example
|
|
754
|
-
* ```typescript
|
|
755
|
-
* logger.step('Building project')
|
|
756
|
-
* logger.log('Compiling TypeScript...')
|
|
757
|
-
* logger.step('Running tests')
|
|
758
|
-
* logger.log('Running test suite...')
|
|
759
|
-
* // Output:
|
|
760
|
-
* // [blank line]
|
|
761
|
-
* // → Building project
|
|
762
|
-
* // Compiling TypeScript...
|
|
763
|
-
* // [blank line]
|
|
764
|
-
* // → Running tests
|
|
765
|
-
* // Running test suite...
|
|
766
|
-
* ```
|
|
767
|
-
*/
|
|
768
|
-
step(msg: string, ...extras: unknown[]): this;
|
|
769
|
-
/**
|
|
770
|
-
* Logs an indented substep message (stateless).
|
|
771
|
-
*
|
|
772
|
-
* Adds a 2-space indent to the message without affecting the logger's
|
|
773
|
-
* indentation state. Useful for showing sub-items under a main step.
|
|
774
|
-
*
|
|
775
|
-
* @param msg - The substep message to log
|
|
776
|
-
* @param extras - Additional arguments to log
|
|
777
|
-
* @returns The logger instance for chaining
|
|
778
|
-
*
|
|
779
|
-
* @example
|
|
780
|
-
* ```typescript
|
|
781
|
-
* logger.log('Installing dependencies:')
|
|
782
|
-
* logger.substep('Installing react')
|
|
783
|
-
* logger.substep('Installing typescript')
|
|
784
|
-
* logger.substep('Installing eslint')
|
|
785
|
-
* // Output:
|
|
786
|
-
* // Installing dependencies:
|
|
787
|
-
* // Installing react
|
|
788
|
-
* // Installing typescript
|
|
789
|
-
* // Installing eslint
|
|
790
|
-
* ```
|
|
791
|
-
*/
|
|
792
|
-
substep(msg: string, ...extras: unknown[]): this;
|
|
793
|
-
/**
|
|
794
|
-
* Logs a success message with a green colored success symbol.
|
|
795
|
-
*
|
|
796
|
-
* Automatically prefixes the message with `LOG_SYMBOLS.success` (green ✔).
|
|
797
|
-
* Always outputs to stderr. If the message starts with an existing
|
|
798
|
-
* symbol, it will be stripped and replaced.
|
|
799
|
-
*
|
|
800
|
-
* @param args - Message and additional arguments to log
|
|
801
|
-
* @returns The logger instance for chaining
|
|
802
|
-
*
|
|
803
|
-
* @example
|
|
804
|
-
* ```typescript
|
|
805
|
-
* logger.success('Build completed')
|
|
806
|
-
* logger.success('Tests passed:', { total: 42, passed: 42 })
|
|
807
|
-
* logger.success('Deployment successful')
|
|
808
|
-
* ```
|
|
809
|
-
*/
|
|
810
|
-
success(...args: unknown[]): this;
|
|
811
|
-
/**
|
|
812
|
-
* Displays data in a table format.
|
|
813
|
-
*
|
|
814
|
-
* Works like `console.table()`. Accepts arrays of objects or
|
|
815
|
-
* objects with nested objects. Optionally specify which properties
|
|
816
|
-
* to include in the table.
|
|
817
|
-
*
|
|
818
|
-
* @param tabularData - The data to display as a table
|
|
819
|
-
* @param properties - Optional array of property names to include
|
|
820
|
-
* @returns The logger instance for chaining
|
|
821
|
-
*
|
|
822
|
-
* @example
|
|
823
|
-
* ```typescript
|
|
824
|
-
* // Array of objects
|
|
825
|
-
* logger.table([
|
|
826
|
-
* { name: 'Alice', age: 30 },
|
|
827
|
-
* { name: 'Bob', age: 25 }
|
|
828
|
-
* ])
|
|
829
|
-
*
|
|
830
|
-
* // Specify properties to show
|
|
831
|
-
* logger.table(users, ['name', 'email'])
|
|
832
|
-
*
|
|
833
|
-
* // Object with nested objects
|
|
834
|
-
* logger.table({
|
|
835
|
-
* user1: { name: 'Alice', age: 30 },
|
|
836
|
-
* user2: { name: 'Bob', age: 25 }
|
|
837
|
-
* })
|
|
838
|
-
* ```
|
|
839
|
-
*/
|
|
840
|
-
table(tabularData: unknown, properties?: readonly string[] | undefined): this;
|
|
841
|
-
/**
|
|
842
|
-
* Starts a timer for measuring elapsed time.
|
|
843
|
-
*
|
|
844
|
-
* Creates a timer with the given label. Use `timeEnd()` with the same
|
|
845
|
-
* label to stop the timer and log the elapsed time, or use `timeLog()`
|
|
846
|
-
* to check the time without stopping the timer.
|
|
847
|
-
*
|
|
848
|
-
* @param label - Optional label for the timer
|
|
849
|
-
* @default 'default'
|
|
850
|
-
* @returns The logger instance for chaining
|
|
851
|
-
*
|
|
852
|
-
* @example
|
|
853
|
-
* ```typescript
|
|
854
|
-
* logger.time('operation')
|
|
855
|
-
* // ... do work ...
|
|
856
|
-
* logger.timeEnd('operation')
|
|
857
|
-
* // Logs: "operation: 123.456ms"
|
|
858
|
-
*
|
|
859
|
-
* logger.time()
|
|
860
|
-
* // ... do work ...
|
|
861
|
-
* logger.timeEnd()
|
|
862
|
-
* // Logs: "default: 123.456ms"
|
|
863
|
-
* ```
|
|
864
|
-
*/
|
|
865
|
-
time(label?: string | undefined): this;
|
|
866
|
-
/**
|
|
867
|
-
* Ends a timer and logs the elapsed time.
|
|
868
|
-
*
|
|
869
|
-
* Logs the duration since `console.time()` or `logger.time()` was called
|
|
870
|
-
* with the same label. The timer is stopped and removed.
|
|
871
|
-
*
|
|
872
|
-
* @param label - Optional label for the timer
|
|
873
|
-
* @default 'default'
|
|
874
|
-
* @returns The logger instance for chaining
|
|
875
|
-
*
|
|
876
|
-
* @example
|
|
877
|
-
* ```typescript
|
|
878
|
-
* logger.time('operation')
|
|
879
|
-
* // ... do work ...
|
|
880
|
-
* logger.timeEnd('operation')
|
|
881
|
-
* // Logs: "operation: 123.456ms"
|
|
882
|
-
*
|
|
883
|
-
* logger.time()
|
|
884
|
-
* // ... do work ...
|
|
885
|
-
* logger.timeEnd()
|
|
886
|
-
* // Logs: "default: 123.456ms"
|
|
887
|
-
* ```
|
|
888
|
-
*/
|
|
889
|
-
timeEnd(label?: string | undefined): this;
|
|
890
|
-
/**
|
|
891
|
-
* Logs the current value of a timer without stopping it.
|
|
892
|
-
*
|
|
893
|
-
* Logs the duration since `console.time()` was called with the same
|
|
894
|
-
* label, but keeps the timer running. Can include additional data
|
|
895
|
-
* to log alongside the time.
|
|
896
|
-
*
|
|
897
|
-
* @param label - Optional label for the timer
|
|
898
|
-
* @param data - Additional data to log with the time
|
|
899
|
-
* @default 'default'
|
|
900
|
-
* @returns The logger instance for chaining
|
|
901
|
-
*
|
|
902
|
-
* @example
|
|
903
|
-
* ```typescript
|
|
904
|
-
* console.time('process')
|
|
905
|
-
* // ... partial work ...
|
|
906
|
-
* logger.timeLog('process', 'Checkpoint 1')
|
|
907
|
-
* // Logs: "process: 123.456ms Checkpoint 1"
|
|
908
|
-
* // ... more work ...
|
|
909
|
-
* logger.timeLog('process', 'Checkpoint 2')
|
|
910
|
-
* // Logs: "process: 234.567ms Checkpoint 2"
|
|
911
|
-
* console.timeEnd('process')
|
|
912
|
-
* ```
|
|
913
|
-
*/
|
|
914
|
-
timeLog(label?: string | undefined, ...data: unknown[]): this;
|
|
915
|
-
/**
|
|
916
|
-
* Logs a stack trace to the console.
|
|
917
|
-
*
|
|
918
|
-
* Works like `console.trace()`. Shows the call stack leading to
|
|
919
|
-
* where this method was called. Useful for debugging.
|
|
920
|
-
*
|
|
921
|
-
* @param message - Optional message to display with the trace
|
|
922
|
-
* @param args - Additional arguments to log
|
|
923
|
-
* @returns The logger instance for chaining
|
|
924
|
-
*
|
|
925
|
-
* @example
|
|
926
|
-
* ```typescript
|
|
927
|
-
* function debugFunction() {
|
|
928
|
-
* logger.trace('Debug point reached')
|
|
929
|
-
* }
|
|
930
|
-
*
|
|
931
|
-
* logger.trace('Trace from here')
|
|
932
|
-
* logger.trace('Error context:', { userId: 123 })
|
|
933
|
-
* ```
|
|
934
|
-
*/
|
|
935
|
-
trace(message?: unknown | undefined, ...args: unknown[]): this;
|
|
936
|
-
/**
|
|
937
|
-
* Logs a warning message with a yellow colored warning symbol.
|
|
938
|
-
*
|
|
939
|
-
* Automatically prefixes the message with `LOG_SYMBOLS.warn` (yellow ⚠).
|
|
940
|
-
* Always outputs to stderr. If the message starts with an existing
|
|
941
|
-
* symbol, it will be stripped and replaced.
|
|
942
|
-
*
|
|
943
|
-
* @param args - Message and additional arguments to log
|
|
944
|
-
* @returns The logger instance for chaining
|
|
945
|
-
*
|
|
946
|
-
* @example
|
|
947
|
-
* ```typescript
|
|
948
|
-
* logger.warn('Deprecated API used')
|
|
949
|
-
* logger.warn('Low memory:', { available: '100MB' })
|
|
950
|
-
* logger.warn('Missing optional configuration')
|
|
951
|
-
* ```
|
|
952
|
-
*/
|
|
953
|
-
warn(...args: unknown[]): this;
|
|
954
|
-
/**
|
|
955
|
-
* Writes text directly to stdout without a newline or indentation.
|
|
956
|
-
*
|
|
957
|
-
* Useful for progress indicators or custom formatting where you need
|
|
958
|
-
* low-level control. Does not apply any indentation or formatting.
|
|
959
|
-
*
|
|
960
|
-
* @param text - The text to write
|
|
961
|
-
* @returns The logger instance for chaining
|
|
962
|
-
*
|
|
963
|
-
* @example
|
|
964
|
-
* ```typescript
|
|
965
|
-
* logger.write('Processing... ')
|
|
966
|
-
* // ... do work ...
|
|
967
|
-
* logger.write('done\n')
|
|
968
|
-
*
|
|
969
|
-
* // Build a line incrementally
|
|
970
|
-
* logger.write('Step 1')
|
|
971
|
-
* logger.write('... Step 2')
|
|
972
|
-
* logger.write('... Step 3\n')
|
|
973
|
-
* ```
|
|
974
|
-
*/
|
|
975
|
-
write(text: string): this;
|
|
976
|
-
}
|
|
977
|
-
/**
|
|
978
|
-
* Get the default logger instance.
|
|
979
|
-
* Lazily creates the logger to avoid circular dependencies during module initialization.
|
|
980
|
-
* Reuses the same instance across calls.
|
|
981
|
-
*
|
|
982
|
-
* @returns Shared default logger instance
|
|
983
|
-
*
|
|
984
|
-
* @example
|
|
985
|
-
* ```ts
|
|
986
|
-
* import { getDefaultLogger } from '@socketsecurity/lib/logger'
|
|
987
|
-
*
|
|
988
|
-
* const logger = getDefaultLogger()
|
|
989
|
-
* logger.log('Application started')
|
|
990
|
-
* logger.success('Configuration loaded')
|
|
991
|
-
* ```
|
|
992
|
-
*/
|
|
993
|
-
export declare function getDefaultLogger(): Logger;
|