@hyperfrontend/project-scope 0.1.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/ARCHITECTURE.md +370 -0
- package/CHANGELOG.md +10 -0
- package/FUNDING.md +141 -0
- package/LICENSE.md +21 -0
- package/README.md +242 -0
- package/SECURITY.md +82 -0
- package/analyze.d.ts +33 -0
- package/analyze.d.ts.map +1 -0
- package/cli/commands/analyze.d.ts +20 -0
- package/cli/commands/analyze.d.ts.map +1 -0
- package/cli/commands/config.d.ts +20 -0
- package/cli/commands/config.d.ts.map +1 -0
- package/cli/commands/deps.d.ts +18 -0
- package/cli/commands/deps.d.ts.map +1 -0
- package/cli/commands/tree.d.ts +24 -0
- package/cli/commands/tree.d.ts.map +1 -0
- package/cli/index.cjs.js +6639 -0
- package/cli/index.cjs.js.map +1 -0
- package/cli/index.d.ts +7 -0
- package/cli/index.d.ts.map +1 -0
- package/cli/index.esm.js +6629 -0
- package/cli/index.esm.js.map +1 -0
- package/cli/run.d.ts +25 -0
- package/cli/run.d.ts.map +1 -0
- package/cli/types.d.ts +55 -0
- package/cli/types.d.ts.map +1 -0
- package/core/cache.d.ts +157 -0
- package/core/cache.d.ts.map +1 -0
- package/core/encoding/convert.d.ts +32 -0
- package/core/encoding/convert.d.ts.map +1 -0
- package/core/encoding/detect.d.ts +86 -0
- package/core/encoding/detect.d.ts.map +1 -0
- package/core/encoding/index.cjs.js +751 -0
- package/core/encoding/index.cjs.js.map +1 -0
- package/core/encoding/index.d.ts +3 -0
- package/core/encoding/index.d.ts.map +1 -0
- package/core/encoding/index.esm.js +736 -0
- package/core/encoding/index.esm.js.map +1 -0
- package/core/errors/structured-errors.d.ts +64 -0
- package/core/errors/structured-errors.d.ts.map +1 -0
- package/core/fs/directory.d.ts +88 -0
- package/core/fs/directory.d.ts.map +1 -0
- package/core/fs/index.cjs.js +1079 -0
- package/core/fs/index.cjs.js.map +1 -0
- package/core/fs/index.d.ts +6 -0
- package/core/fs/index.d.ts.map +1 -0
- package/core/fs/index.esm.js +1056 -0
- package/core/fs/index.esm.js.map +1 -0
- package/core/fs/read.d.ts +86 -0
- package/core/fs/read.d.ts.map +1 -0
- package/core/fs/stat.d.ts +58 -0
- package/core/fs/stat.d.ts.map +1 -0
- package/core/fs/traversal.d.ts +26 -0
- package/core/fs/traversal.d.ts.map +1 -0
- package/core/fs/write.d.ts +75 -0
- package/core/fs/write.d.ts.map +1 -0
- package/core/index.cjs.js +2376 -0
- package/core/index.cjs.js.map +1 -0
- package/core/index.d.ts +9 -0
- package/core/index.d.ts.map +1 -0
- package/core/index.esm.js +2286 -0
- package/core/index.esm.js.map +1 -0
- package/core/logger.d.ts +111 -0
- package/core/logger.d.ts.map +1 -0
- package/core/path/index.cjs.js +254 -0
- package/core/path/index.cjs.js.map +1 -0
- package/core/path/index.d.ts +5 -0
- package/core/path/index.d.ts.map +1 -0
- package/core/path/index.esm.js +233 -0
- package/core/path/index.esm.js.map +1 -0
- package/core/path/join.d.ts +17 -0
- package/core/path/join.d.ts.map +1 -0
- package/core/path/normalize.d.ts +37 -0
- package/core/path/normalize.d.ts.map +1 -0
- package/core/path/resolve.d.ts +52 -0
- package/core/path/resolve.d.ts.map +1 -0
- package/core/path/segments.d.ts +59 -0
- package/core/path/segments.d.ts.map +1 -0
- package/core/patterns/glob.d.ts +46 -0
- package/core/patterns/glob.d.ts.map +1 -0
- package/core/platform/detect.d.ts +66 -0
- package/core/platform/detect.d.ts.map +1 -0
- package/core/platform/index.cjs.js +241 -0
- package/core/platform/index.cjs.js.map +1 -0
- package/core/platform/index.d.ts +3 -0
- package/core/platform/index.d.ts.map +1 -0
- package/core/platform/index.esm.js +226 -0
- package/core/platform/index.esm.js.map +1 -0
- package/core/platform/line-endings.d.ts +48 -0
- package/core/platform/line-endings.d.ts.map +1 -0
- package/heuristics/dependencies/analyze.d.ts +77 -0
- package/heuristics/dependencies/analyze.d.ts.map +1 -0
- package/heuristics/dependencies/index.cjs.js +1126 -0
- package/heuristics/dependencies/index.cjs.js.map +1 -0
- package/heuristics/dependencies/index.d.ts +2 -0
- package/heuristics/dependencies/index.d.ts.map +1 -0
- package/heuristics/dependencies/index.esm.js +1122 -0
- package/heuristics/dependencies/index.esm.js.map +1 -0
- package/heuristics/entry-points/discover.d.ts +86 -0
- package/heuristics/entry-points/discover.d.ts.map +1 -0
- package/heuristics/entry-points/index.cjs.js +1581 -0
- package/heuristics/entry-points/index.cjs.js.map +1 -0
- package/heuristics/entry-points/index.d.ts +2 -0
- package/heuristics/entry-points/index.d.ts.map +1 -0
- package/heuristics/entry-points/index.esm.js +1577 -0
- package/heuristics/entry-points/index.esm.js.map +1 -0
- package/heuristics/framework/identify.d.ts +84 -0
- package/heuristics/framework/identify.d.ts.map +1 -0
- package/heuristics/framework/index.cjs.js +3618 -0
- package/heuristics/framework/index.cjs.js.map +1 -0
- package/heuristics/framework/index.d.ts +2 -0
- package/heuristics/framework/index.d.ts.map +1 -0
- package/heuristics/framework/index.esm.js +3614 -0
- package/heuristics/framework/index.esm.js.map +1 -0
- package/heuristics/index.cjs.js +4833 -0
- package/heuristics/index.cjs.js.map +1 -0
- package/heuristics/index.d.ts +5 -0
- package/heuristics/index.d.ts.map +1 -0
- package/heuristics/index.esm.js +4822 -0
- package/heuristics/index.esm.js.map +1 -0
- package/heuristics/project-type/detect.d.ts +61 -0
- package/heuristics/project-type/detect.d.ts.map +1 -0
- package/heuristics/project-type/index.cjs.js +3633 -0
- package/heuristics/project-type/index.cjs.js.map +1 -0
- package/heuristics/project-type/index.d.ts +2 -0
- package/heuristics/project-type/index.d.ts.map +1 -0
- package/heuristics/project-type/index.esm.js +3631 -0
- package/heuristics/project-type/index.esm.js.map +1 -0
- package/index.cjs.js +10255 -0
- package/index.cjs.js.map +1 -0
- package/index.d.ts +10 -0
- package/index.d.ts.map +1 -0
- package/index.esm.js +10006 -0
- package/index.esm.js.map +1 -0
- package/models/index.cjs.js +3 -0
- package/models/index.cjs.js.map +1 -0
- package/models/index.d.ts +176 -0
- package/models/index.d.ts.map +1 -0
- package/models/index.esm.js +2 -0
- package/models/index.esm.js.map +1 -0
- package/nx/detect.d.ts +105 -0
- package/nx/detect.d.ts.map +1 -0
- package/nx/devkit-loader.d.ts +62 -0
- package/nx/devkit-loader.d.ts.map +1 -0
- package/nx/index.cjs.js +1302 -0
- package/nx/index.cjs.js.map +1 -0
- package/nx/index.d.ts +4 -0
- package/nx/index.d.ts.map +1 -0
- package/nx/index.esm.js +1286 -0
- package/nx/index.esm.js.map +1 -0
- package/nx/project-config.d.ts +109 -0
- package/nx/project-config.d.ts.map +1 -0
- package/package.json +218 -0
- package/project/config/detect.d.ts +77 -0
- package/project/config/detect.d.ts.map +1 -0
- package/project/config/index.cjs.js +1982 -0
- package/project/config/index.cjs.js.map +1 -0
- package/project/config/index.d.ts +4 -0
- package/project/config/index.d.ts.map +1 -0
- package/project/config/index.esm.js +1971 -0
- package/project/config/index.esm.js.map +1 -0
- package/project/config/parse.d.ts +53 -0
- package/project/config/parse.d.ts.map +1 -0
- package/project/config/patterns.d.ts +31 -0
- package/project/config/patterns.d.ts.map +1 -0
- package/project/index.cjs.js +2585 -0
- package/project/index.cjs.js.map +1 -0
- package/project/index.d.ts +5 -0
- package/project/index.d.ts.map +1 -0
- package/project/index.esm.js +2549 -0
- package/project/index.esm.js.map +1 -0
- package/project/package/dependencies.d.ts +101 -0
- package/project/package/dependencies.d.ts.map +1 -0
- package/project/package/index.cjs.js +972 -0
- package/project/package/index.cjs.js.map +1 -0
- package/project/package/index.d.ts +3 -0
- package/project/package/index.d.ts.map +1 -0
- package/project/package/index.esm.js +957 -0
- package/project/package/index.esm.js.map +1 -0
- package/project/package/read.d.ts +66 -0
- package/project/package/read.d.ts.map +1 -0
- package/project/root/detect.d.ts +65 -0
- package/project/root/detect.d.ts.map +1 -0
- package/project/root/index.cjs.js +860 -0
- package/project/root/index.cjs.js.map +1 -0
- package/project/root/index.d.ts +2 -0
- package/project/root/index.d.ts.map +1 -0
- package/project/root/index.esm.js +853 -0
- package/project/root/index.esm.js.map +1 -0
- package/project/traversal/index.cjs.js +1179 -0
- package/project/traversal/index.cjs.js.map +1 -0
- package/project/traversal/index.d.ts +3 -0
- package/project/traversal/index.d.ts.map +1 -0
- package/project/traversal/index.esm.js +1173 -0
- package/project/traversal/index.esm.js.map +1 -0
- package/project/traversal/search.d.ts +59 -0
- package/project/traversal/search.d.ts.map +1 -0
- package/project/traversal/walk.d.ts +63 -0
- package/project/traversal/walk.d.ts.map +1 -0
- package/tech/backend/detect-all.d.ts +13 -0
- package/tech/backend/detect-all.d.ts.map +1 -0
- package/tech/backend/express.d.ts +11 -0
- package/tech/backend/express.d.ts.map +1 -0
- package/tech/backend/fastify.d.ts +11 -0
- package/tech/backend/fastify.d.ts.map +1 -0
- package/tech/backend/hono.d.ts +11 -0
- package/tech/backend/hono.d.ts.map +1 -0
- package/tech/backend/index.cjs.js +939 -0
- package/tech/backend/index.cjs.js.map +1 -0
- package/tech/backend/index.d.ts +8 -0
- package/tech/backend/index.d.ts.map +1 -0
- package/tech/backend/index.esm.js +931 -0
- package/tech/backend/index.esm.js.map +1 -0
- package/tech/backend/koa.d.ts +11 -0
- package/tech/backend/koa.d.ts.map +1 -0
- package/tech/backend/nestjs.d.ts +11 -0
- package/tech/backend/nestjs.d.ts.map +1 -0
- package/tech/backend/types.d.ts +31 -0
- package/tech/backend/types.d.ts.map +1 -0
- package/tech/build/babel.d.ts +13 -0
- package/tech/build/babel.d.ts.map +1 -0
- package/tech/build/detect-all.d.ts +13 -0
- package/tech/build/detect-all.d.ts.map +1 -0
- package/tech/build/esbuild.d.ts +11 -0
- package/tech/build/esbuild.d.ts.map +1 -0
- package/tech/build/index.cjs.js +1118 -0
- package/tech/build/index.cjs.js.map +1 -0
- package/tech/build/index.d.ts +10 -0
- package/tech/build/index.d.ts.map +1 -0
- package/tech/build/index.esm.js +1102 -0
- package/tech/build/index.esm.js.map +1 -0
- package/tech/build/parcel.d.ts +13 -0
- package/tech/build/parcel.d.ts.map +1 -0
- package/tech/build/rollup.d.ts +13 -0
- package/tech/build/rollup.d.ts.map +1 -0
- package/tech/build/swc.d.ts +13 -0
- package/tech/build/swc.d.ts.map +1 -0
- package/tech/build/types.d.ts +31 -0
- package/tech/build/types.d.ts.map +1 -0
- package/tech/build/vite.d.ts +13 -0
- package/tech/build/vite.d.ts.map +1 -0
- package/tech/build/webpack.d.ts +13 -0
- package/tech/build/webpack.d.ts.map +1 -0
- package/tech/frontend/angular.d.ts +11 -0
- package/tech/frontend/angular.d.ts.map +1 -0
- package/tech/frontend/astro.d.ts +11 -0
- package/tech/frontend/astro.d.ts.map +1 -0
- package/tech/frontend/detect-all.d.ts +13 -0
- package/tech/frontend/detect-all.d.ts.map +1 -0
- package/tech/frontend/gatsby.d.ts +11 -0
- package/tech/frontend/gatsby.d.ts.map +1 -0
- package/tech/frontend/index.cjs.js +1310 -0
- package/tech/frontend/index.cjs.js.map +1 -0
- package/tech/frontend/index.d.ts +15 -0
- package/tech/frontend/index.d.ts.map +1 -0
- package/tech/frontend/index.esm.js +1295 -0
- package/tech/frontend/index.esm.js.map +1 -0
- package/tech/frontend/nextjs.d.ts +11 -0
- package/tech/frontend/nextjs.d.ts.map +1 -0
- package/tech/frontend/nuxt.d.ts +11 -0
- package/tech/frontend/nuxt.d.ts.map +1 -0
- package/tech/frontend/qwik.d.ts +11 -0
- package/tech/frontend/qwik.d.ts.map +1 -0
- package/tech/frontend/react.d.ts +11 -0
- package/tech/frontend/react.d.ts.map +1 -0
- package/tech/frontend/remix.d.ts +11 -0
- package/tech/frontend/remix.d.ts.map +1 -0
- package/tech/frontend/solid.d.ts +11 -0
- package/tech/frontend/solid.d.ts.map +1 -0
- package/tech/frontend/svelte.d.ts +11 -0
- package/tech/frontend/svelte.d.ts.map +1 -0
- package/tech/frontend/sveltekit.d.ts +11 -0
- package/tech/frontend/sveltekit.d.ts.map +1 -0
- package/tech/frontend/types.d.ts +35 -0
- package/tech/frontend/types.d.ts.map +1 -0
- package/tech/frontend/vue.d.ts +11 -0
- package/tech/frontend/vue.d.ts.map +1 -0
- package/tech/index.cjs.js +3684 -0
- package/tech/index.cjs.js.map +1 -0
- package/tech/index.d.ts +96 -0
- package/tech/index.d.ts.map +1 -0
- package/tech/index.esm.js +3603 -0
- package/tech/index.esm.js.map +1 -0
- package/tech/legacy/angularjs.d.ts +12 -0
- package/tech/legacy/angularjs.d.ts.map +1 -0
- package/tech/legacy/backbone.d.ts +11 -0
- package/tech/legacy/backbone.d.ts.map +1 -0
- package/tech/legacy/detect-all.d.ts +13 -0
- package/tech/legacy/detect-all.d.ts.map +1 -0
- package/tech/legacy/ember.d.ts +11 -0
- package/tech/legacy/ember.d.ts.map +1 -0
- package/tech/legacy/index.cjs.js +903 -0
- package/tech/legacy/index.cjs.js.map +1 -0
- package/tech/legacy/index.d.ts +7 -0
- package/tech/legacy/index.d.ts.map +1 -0
- package/tech/legacy/index.esm.js +896 -0
- package/tech/legacy/index.esm.js.map +1 -0
- package/tech/legacy/jquery.d.ts +11 -0
- package/tech/legacy/jquery.d.ts.map +1 -0
- package/tech/legacy/types.d.ts +33 -0
- package/tech/legacy/types.d.ts.map +1 -0
- package/tech/linting/biome.d.ts +11 -0
- package/tech/linting/biome.d.ts.map +1 -0
- package/tech/linting/detect-all.d.ts +13 -0
- package/tech/linting/detect-all.d.ts.map +1 -0
- package/tech/linting/eslint.d.ts +13 -0
- package/tech/linting/eslint.d.ts.map +1 -0
- package/tech/linting/index.cjs.js +992 -0
- package/tech/linting/index.cjs.js.map +1 -0
- package/tech/linting/index.d.ts +7 -0
- package/tech/linting/index.d.ts.map +1 -0
- package/tech/linting/index.esm.js +982 -0
- package/tech/linting/index.esm.js.map +1 -0
- package/tech/linting/prettier.d.ts +13 -0
- package/tech/linting/prettier.d.ts.map +1 -0
- package/tech/linting/stylelint.d.ts +13 -0
- package/tech/linting/stylelint.d.ts.map +1 -0
- package/tech/linting/types.d.ts +31 -0
- package/tech/linting/types.d.ts.map +1 -0
- package/tech/monorepo/detect-all.d.ts +13 -0
- package/tech/monorepo/detect-all.d.ts.map +1 -0
- package/tech/monorepo/index.cjs.js +1021 -0
- package/tech/monorepo/index.cjs.js.map +1 -0
- package/tech/monorepo/index.d.ts +10 -0
- package/tech/monorepo/index.d.ts.map +1 -0
- package/tech/monorepo/index.esm.js +1011 -0
- package/tech/monorepo/index.esm.js.map +1 -0
- package/tech/monorepo/lerna.d.ts +11 -0
- package/tech/monorepo/lerna.d.ts.map +1 -0
- package/tech/monorepo/npm-workspaces.d.ts +11 -0
- package/tech/monorepo/npm-workspaces.d.ts.map +1 -0
- package/tech/monorepo/nx.d.ts +11 -0
- package/tech/monorepo/nx.d.ts.map +1 -0
- package/tech/monorepo/pnpm-workspaces.d.ts +9 -0
- package/tech/monorepo/pnpm-workspaces.d.ts.map +1 -0
- package/tech/monorepo/rush.d.ts +11 -0
- package/tech/monorepo/rush.d.ts.map +1 -0
- package/tech/monorepo/turborepo.d.ts +11 -0
- package/tech/monorepo/turborepo.d.ts.map +1 -0
- package/tech/monorepo/types.d.ts +39 -0
- package/tech/monorepo/types.d.ts.map +1 -0
- package/tech/monorepo/yarn-workspaces.d.ts +11 -0
- package/tech/monorepo/yarn-workspaces.d.ts.map +1 -0
- package/tech/shared-utils/detector-helpers.d.ts +52 -0
- package/tech/shared-utils/detector-helpers.d.ts.map +1 -0
- package/tech/shared-utils/types.d.ts +41 -0
- package/tech/shared-utils/types.d.ts.map +1 -0
- package/tech/testing/cypress.d.ts +13 -0
- package/tech/testing/cypress.d.ts.map +1 -0
- package/tech/testing/detect-all.d.ts +13 -0
- package/tech/testing/detect-all.d.ts.map +1 -0
- package/tech/testing/index.cjs.js +1031 -0
- package/tech/testing/index.cjs.js.map +1 -0
- package/tech/testing/index.d.ts +8 -0
- package/tech/testing/index.d.ts.map +1 -0
- package/tech/testing/index.esm.js +1018 -0
- package/tech/testing/index.esm.js.map +1 -0
- package/tech/testing/jest.d.ts +13 -0
- package/tech/testing/jest.d.ts.map +1 -0
- package/tech/testing/mocha.d.ts +13 -0
- package/tech/testing/mocha.d.ts.map +1 -0
- package/tech/testing/playwright.d.ts +13 -0
- package/tech/testing/playwright.d.ts.map +1 -0
- package/tech/testing/types.d.ts +35 -0
- package/tech/testing/types.d.ts.map +1 -0
- package/tech/testing/vitest.d.ts +13 -0
- package/tech/testing/vitest.d.ts.map +1 -0
- package/tech/types/detectors.d.ts +67 -0
- package/tech/types/detectors.d.ts.map +1 -0
- package/tech/types/index.cjs.js +1045 -0
- package/tech/types/index.cjs.js.map +1 -0
- package/tech/types/index.d.ts +2 -0
- package/tech/types/index.d.ts.map +1 -0
- package/tech/types/index.esm.js +1039 -0
- package/tech/types/index.esm.js.map +1 -0
- package/vfs/commit.d.ts +32 -0
- package/vfs/commit.d.ts.map +1 -0
- package/vfs/diff.d.ts +73 -0
- package/vfs/diff.d.ts.map +1 -0
- package/vfs/factory.d.ts +37 -0
- package/vfs/factory.d.ts.map +1 -0
- package/vfs/fs-tree.d.ts +13 -0
- package/vfs/fs-tree.d.ts.map +1 -0
- package/vfs/index.cjs.js +1600 -0
- package/vfs/index.cjs.js.map +1 -0
- package/vfs/index.d.ts +6 -0
- package/vfs/index.d.ts.map +1 -0
- package/vfs/index.esm.js +1590 -0
- package/vfs/index.esm.js.map +1 -0
- package/vfs/types.d.ts +178 -0
- package/vfs/types.d.ts.map +1 -0
|
@@ -0,0 +1,1079 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var node_fs = require('node:fs');
|
|
4
|
+
var node_path = require('node:path');
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Safe copies of Error built-ins via factory functions.
|
|
8
|
+
*
|
|
9
|
+
* Since constructors cannot be safely captured via Object.assign, this module
|
|
10
|
+
* provides factory functions that use Reflect.construct internally.
|
|
11
|
+
*
|
|
12
|
+
* These references are captured at module initialization time to protect against
|
|
13
|
+
* prototype pollution attacks. Import only what you need for tree-shaking.
|
|
14
|
+
*
|
|
15
|
+
* @module @hyperfrontend/immutable-api-utils/built-in-copy/error
|
|
16
|
+
*/
|
|
17
|
+
// Capture references at module initialization time
|
|
18
|
+
const _Error = globalThis.Error;
|
|
19
|
+
const _Reflect$1 = globalThis.Reflect;
|
|
20
|
+
/**
|
|
21
|
+
* (Safe copy) Creates a new Error using the captured Error constructor.
|
|
22
|
+
* Use this instead of `new Error()`.
|
|
23
|
+
*
|
|
24
|
+
* @param message - Optional error message.
|
|
25
|
+
* @param options - Optional error options.
|
|
26
|
+
* @returns A new Error instance.
|
|
27
|
+
*/
|
|
28
|
+
const createError = (message, options) => _Reflect$1.construct(_Error, [message, options]);
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Safe copies of JSON built-in methods.
|
|
32
|
+
*
|
|
33
|
+
* These references are captured at module initialization time to protect against
|
|
34
|
+
* prototype pollution attacks. Import only what you need for tree-shaking.
|
|
35
|
+
*
|
|
36
|
+
* @module @hyperfrontend/immutable-api-utils/built-in-copy/json
|
|
37
|
+
*/
|
|
38
|
+
// Capture references at module initialization time
|
|
39
|
+
const _JSON = globalThis.JSON;
|
|
40
|
+
/**
|
|
41
|
+
* (Safe copy) Converts a JavaScript Object Notation (JSON) string into an object.
|
|
42
|
+
*/
|
|
43
|
+
const parse = _JSON.parse;
|
|
44
|
+
/**
|
|
45
|
+
* (Safe copy) Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
|
|
46
|
+
*/
|
|
47
|
+
const stringify = _JSON.stringify;
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Safe copies of Object built-in methods.
|
|
51
|
+
*
|
|
52
|
+
* These references are captured at module initialization time to protect against
|
|
53
|
+
* prototype pollution attacks. Import only what you need for tree-shaking.
|
|
54
|
+
*
|
|
55
|
+
* @module @hyperfrontend/immutable-api-utils/built-in-copy/object
|
|
56
|
+
*/
|
|
57
|
+
// Capture references at module initialization time
|
|
58
|
+
const _Object = globalThis.Object;
|
|
59
|
+
/**
|
|
60
|
+
* (Safe copy) Prevents modification of existing property attributes and values,
|
|
61
|
+
* and prevents the addition of new properties.
|
|
62
|
+
*/
|
|
63
|
+
const freeze = _Object.freeze;
|
|
64
|
+
/**
|
|
65
|
+
* (Safe copy) Returns the names of the enumerable string properties and methods of an object.
|
|
66
|
+
*/
|
|
67
|
+
const keys = _Object.keys;
|
|
68
|
+
/**
|
|
69
|
+
* (Safe copy) Returns an array of key/values of the enumerable own properties of an object.
|
|
70
|
+
*/
|
|
71
|
+
const entries = _Object.entries;
|
|
72
|
+
/**
|
|
73
|
+
* (Safe copy) Adds one or more properties to an object, and/or modifies attributes of existing properties.
|
|
74
|
+
*/
|
|
75
|
+
const defineProperties = _Object.defineProperties;
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Safe copies of Array built-in static methods.
|
|
79
|
+
*
|
|
80
|
+
* These references are captured at module initialization time to protect against
|
|
81
|
+
* prototype pollution attacks. Import only what you need for tree-shaking.
|
|
82
|
+
*
|
|
83
|
+
* @module @hyperfrontend/immutable-api-utils/built-in-copy/array
|
|
84
|
+
*/
|
|
85
|
+
// Capture references at module initialization time
|
|
86
|
+
const _Array = globalThis.Array;
|
|
87
|
+
/**
|
|
88
|
+
* (Safe copy) Determines whether the passed value is an Array.
|
|
89
|
+
*/
|
|
90
|
+
const isArray = _Array.isArray;
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Safe copies of Console built-in methods.
|
|
94
|
+
*
|
|
95
|
+
* These references are captured at module initialization time to protect against
|
|
96
|
+
* prototype pollution attacks. Import only what you need for tree-shaking.
|
|
97
|
+
*
|
|
98
|
+
* @module @hyperfrontend/immutable-api-utils/built-in-copy/console
|
|
99
|
+
*/
|
|
100
|
+
// Capture references at module initialization time
|
|
101
|
+
const _console = globalThis.console;
|
|
102
|
+
/**
|
|
103
|
+
* (Safe copy) Outputs a message to the console.
|
|
104
|
+
*/
|
|
105
|
+
const log = _console.log.bind(_console);
|
|
106
|
+
/**
|
|
107
|
+
* (Safe copy) Outputs a warning message to the console.
|
|
108
|
+
*/
|
|
109
|
+
const warn = _console.warn.bind(_console);
|
|
110
|
+
/**
|
|
111
|
+
* (Safe copy) Outputs an error message to the console.
|
|
112
|
+
*/
|
|
113
|
+
const error = _console.error.bind(_console);
|
|
114
|
+
/**
|
|
115
|
+
* (Safe copy) Outputs an informational message to the console.
|
|
116
|
+
*/
|
|
117
|
+
const info = _console.info.bind(_console);
|
|
118
|
+
/**
|
|
119
|
+
* (Safe copy) Outputs a debug message to the console.
|
|
120
|
+
*/
|
|
121
|
+
const debug = _console.debug.bind(_console);
|
|
122
|
+
/**
|
|
123
|
+
* (Safe copy) Outputs a stack trace to the console.
|
|
124
|
+
*/
|
|
125
|
+
_console.trace.bind(_console);
|
|
126
|
+
/**
|
|
127
|
+
* (Safe copy) Displays an interactive listing of the properties of a specified object.
|
|
128
|
+
*/
|
|
129
|
+
_console.dir.bind(_console);
|
|
130
|
+
/**
|
|
131
|
+
* (Safe copy) Displays tabular data as a table.
|
|
132
|
+
*/
|
|
133
|
+
_console.table.bind(_console);
|
|
134
|
+
/**
|
|
135
|
+
* (Safe copy) Writes an error message to the console if the assertion is false.
|
|
136
|
+
*/
|
|
137
|
+
_console.assert.bind(_console);
|
|
138
|
+
/**
|
|
139
|
+
* (Safe copy) Clears the console.
|
|
140
|
+
*/
|
|
141
|
+
_console.clear.bind(_console);
|
|
142
|
+
/**
|
|
143
|
+
* (Safe copy) Logs the number of times that this particular call to count() has been called.
|
|
144
|
+
*/
|
|
145
|
+
_console.count.bind(_console);
|
|
146
|
+
/**
|
|
147
|
+
* (Safe copy) Resets the counter used with console.count().
|
|
148
|
+
*/
|
|
149
|
+
_console.countReset.bind(_console);
|
|
150
|
+
/**
|
|
151
|
+
* (Safe copy) Creates a new inline group in the console.
|
|
152
|
+
*/
|
|
153
|
+
_console.group.bind(_console);
|
|
154
|
+
/**
|
|
155
|
+
* (Safe copy) Creates a new inline group in the console that is initially collapsed.
|
|
156
|
+
*/
|
|
157
|
+
_console.groupCollapsed.bind(_console);
|
|
158
|
+
/**
|
|
159
|
+
* (Safe copy) Exits the current inline group.
|
|
160
|
+
*/
|
|
161
|
+
_console.groupEnd.bind(_console);
|
|
162
|
+
/**
|
|
163
|
+
* (Safe copy) Starts a timer with a name specified as an input parameter.
|
|
164
|
+
*/
|
|
165
|
+
_console.time.bind(_console);
|
|
166
|
+
/**
|
|
167
|
+
* (Safe copy) Stops a timer that was previously started.
|
|
168
|
+
*/
|
|
169
|
+
_console.timeEnd.bind(_console);
|
|
170
|
+
/**
|
|
171
|
+
* (Safe copy) Logs the current value of a timer that was previously started.
|
|
172
|
+
*/
|
|
173
|
+
_console.timeLog.bind(_console);
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* Safe copies of Set built-in via factory function.
|
|
177
|
+
*
|
|
178
|
+
* Since constructors cannot be safely captured via Object.assign, this module
|
|
179
|
+
* provides a factory function that uses Reflect.construct internally.
|
|
180
|
+
*
|
|
181
|
+
* These references are captured at module initialization time to protect against
|
|
182
|
+
* prototype pollution attacks. Import only what you need for tree-shaking.
|
|
183
|
+
*
|
|
184
|
+
* @module @hyperfrontend/immutable-api-utils/built-in-copy/set
|
|
185
|
+
*/
|
|
186
|
+
// Capture references at module initialization time
|
|
187
|
+
const _Set = globalThis.Set;
|
|
188
|
+
const _Reflect = globalThis.Reflect;
|
|
189
|
+
/**
|
|
190
|
+
* (Safe copy) Creates a new Set using the captured Set constructor.
|
|
191
|
+
* Use this instead of `new Set()`.
|
|
192
|
+
*
|
|
193
|
+
* @param iterable - Optional iterable of values.
|
|
194
|
+
* @returns A new Set instance.
|
|
195
|
+
*/
|
|
196
|
+
const createSet = (iterable) => _Reflect.construct(_Set, iterable ? [iterable] : []);
|
|
197
|
+
|
|
198
|
+
const registeredClasses = [];
|
|
199
|
+
|
|
200
|
+
/**
|
|
201
|
+
* Returns the data type of the target.
|
|
202
|
+
* Uses native `typeof` operator, however, makes distinction between `null`, `array`, and `object`.
|
|
203
|
+
* Also, when classes are registered via `registerClass`, it checks if objects are instance of any known registered class.
|
|
204
|
+
*
|
|
205
|
+
* @param target - The target to get the data type of.
|
|
206
|
+
* @returns The data type of the target.
|
|
207
|
+
*/
|
|
208
|
+
const getType = (target) => {
|
|
209
|
+
if (target === null)
|
|
210
|
+
return 'null';
|
|
211
|
+
const nativeDataType = typeof target;
|
|
212
|
+
if (nativeDataType === 'object') {
|
|
213
|
+
if (isArray(target))
|
|
214
|
+
return 'array';
|
|
215
|
+
for (const registeredClass of registeredClasses) {
|
|
216
|
+
if (target instanceof registeredClass)
|
|
217
|
+
return registeredClass.name;
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
return nativeDataType;
|
|
221
|
+
};
|
|
222
|
+
|
|
223
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
224
|
+
/**
|
|
225
|
+
* Creates a wrapper function that only executes the wrapped function if the condition function returns true.
|
|
226
|
+
*
|
|
227
|
+
* @param func - The function to be conditionally executed.
|
|
228
|
+
* @param conditionFunc - A function that returns a boolean, determining if `func` should be executed.
|
|
229
|
+
* @returns A wrapped version of `func` that executes conditionally.
|
|
230
|
+
*/
|
|
231
|
+
function createConditionalExecutionFunction(func, conditionFunc) {
|
|
232
|
+
return function (...args) {
|
|
233
|
+
if (conditionFunc()) {
|
|
234
|
+
return func(...args);
|
|
235
|
+
}
|
|
236
|
+
};
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
240
|
+
/**
|
|
241
|
+
* Creates a wrapper function that silently ignores any errors thrown by the wrapped void function.
|
|
242
|
+
* This function is specifically for wrapping functions that do not return a value (void functions).
|
|
243
|
+
* Exceptions are swallowed without any logging or handling.
|
|
244
|
+
*
|
|
245
|
+
* @param func - The void function to be wrapped.
|
|
246
|
+
* @returns A wrapped version of the input function that ignores errors.
|
|
247
|
+
*/
|
|
248
|
+
function createErrorIgnoringFunction(func) {
|
|
249
|
+
return function (...args) {
|
|
250
|
+
try {
|
|
251
|
+
func(...args);
|
|
252
|
+
}
|
|
253
|
+
catch {
|
|
254
|
+
// Deliberately swallowing/ignoring the exception
|
|
255
|
+
}
|
|
256
|
+
};
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
260
|
+
/**
|
|
261
|
+
* A no-operation function (noop) that does nothing regardless of the arguments passed.
|
|
262
|
+
* It is designed to be as permissive as possible in its typing without using the `Function` keyword.
|
|
263
|
+
*
|
|
264
|
+
* @param args - Any arguments passed to the function (ignored)
|
|
265
|
+
*/
|
|
266
|
+
const noop = (...args) => {
|
|
267
|
+
// Intentionally does nothing
|
|
268
|
+
};
|
|
269
|
+
|
|
270
|
+
const logLevels = ['none', 'error', 'warn', 'log', 'info', 'debug'];
|
|
271
|
+
const priority = {
|
|
272
|
+
error: 4,
|
|
273
|
+
warn: 3,
|
|
274
|
+
log: 2,
|
|
275
|
+
info: 1,
|
|
276
|
+
debug: 0,
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* Validates whether a given string is a valid log level.
|
|
280
|
+
*
|
|
281
|
+
* @param level - The log level to validate
|
|
282
|
+
* @returns True if the level is valid, false otherwise
|
|
283
|
+
*/
|
|
284
|
+
function isValidLogLevel(level) {
|
|
285
|
+
return logLevels.includes(level);
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* Creates a log level configuration manager for controlling logging behavior.
|
|
289
|
+
* Provides methods to get, set, and evaluate log levels based on priority.
|
|
290
|
+
*
|
|
291
|
+
* @param level - The initial log level (defaults to 'error')
|
|
292
|
+
* @returns A configuration object with log level management methods
|
|
293
|
+
* @throws {Error} When the provided level is not a valid log level
|
|
294
|
+
*/
|
|
295
|
+
function createLogLevelConfig(level = 'error') {
|
|
296
|
+
if (!isValidLogLevel(level)) {
|
|
297
|
+
throw createError('Cannot create log level configuration with a valid default log level');
|
|
298
|
+
}
|
|
299
|
+
const state = { level };
|
|
300
|
+
const getLogLevel = () => state.level;
|
|
301
|
+
const setLogLevel = (level) => {
|
|
302
|
+
if (!isValidLogLevel(level)) {
|
|
303
|
+
throw createError(`Cannot set value '${level}' level. Expected levels are ${logLevels}.`);
|
|
304
|
+
}
|
|
305
|
+
state.level = level;
|
|
306
|
+
};
|
|
307
|
+
const shouldLog = (level) => {
|
|
308
|
+
if (state.level === 'none' || level === 'none' || !isValidLogLevel(level)) {
|
|
309
|
+
return false;
|
|
310
|
+
}
|
|
311
|
+
return priority[level] >= priority[state.level];
|
|
312
|
+
};
|
|
313
|
+
return freeze({
|
|
314
|
+
getLogLevel,
|
|
315
|
+
setLogLevel,
|
|
316
|
+
shouldLog,
|
|
317
|
+
});
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
/**
|
|
321
|
+
* Creates a logger instance with configurable log level filtering.
|
|
322
|
+
* Each log function is wrapped to respect the current log level setting.
|
|
323
|
+
*
|
|
324
|
+
* @param error - Function to handle error-level logs (required)
|
|
325
|
+
* @param warn - Function to handle warning-level logs (optional, defaults to noop)
|
|
326
|
+
* @param log - Function to handle standard logs (optional, defaults to noop)
|
|
327
|
+
* @param info - Function to handle info-level logs (optional, defaults to noop)
|
|
328
|
+
* @param debug - Function to handle debug-level logs (optional, defaults to noop)
|
|
329
|
+
* @returns A frozen logger object with log methods and level control
|
|
330
|
+
* @throws {ErrorLevelFn} When any provided log function is invalid
|
|
331
|
+
*/
|
|
332
|
+
function createLogger(error, warn = noop, log = noop, info = noop, debug = noop) {
|
|
333
|
+
if (notValidLogFn(error)) {
|
|
334
|
+
throw createError(notFnMsg('error'));
|
|
335
|
+
}
|
|
336
|
+
if (notValidLogFn(warn)) {
|
|
337
|
+
throw createError(notFnMsg('warn'));
|
|
338
|
+
}
|
|
339
|
+
if (notValidLogFn(log)) {
|
|
340
|
+
throw createError(notFnMsg('log'));
|
|
341
|
+
}
|
|
342
|
+
if (notValidLogFn(info)) {
|
|
343
|
+
throw createError(notFnMsg('info'));
|
|
344
|
+
}
|
|
345
|
+
if (notValidLogFn(debug)) {
|
|
346
|
+
throw createError(notFnMsg('debug'));
|
|
347
|
+
}
|
|
348
|
+
const { setLogLevel, getLogLevel, shouldLog } = createLogLevelConfig();
|
|
349
|
+
const wrapLogFn = (fn, level) => {
|
|
350
|
+
if (fn === noop)
|
|
351
|
+
return fn;
|
|
352
|
+
const condition = () => shouldLog(level);
|
|
353
|
+
return createConditionalExecutionFunction(createErrorIgnoringFunction(fn), condition);
|
|
354
|
+
};
|
|
355
|
+
return freeze({
|
|
356
|
+
error: wrapLogFn(error, 'error'),
|
|
357
|
+
warn: wrapLogFn(warn, 'warn'),
|
|
358
|
+
log: wrapLogFn(log, 'log'),
|
|
359
|
+
info: wrapLogFn(info, 'info'),
|
|
360
|
+
debug: wrapLogFn(debug, 'debug'),
|
|
361
|
+
setLogLevel,
|
|
362
|
+
getLogLevel,
|
|
363
|
+
});
|
|
364
|
+
}
|
|
365
|
+
/**
|
|
366
|
+
* Validates whether a given value is a valid log function.
|
|
367
|
+
*
|
|
368
|
+
* @param fn - The value to validate
|
|
369
|
+
* @returns True if the value is not a function (invalid), false if it is valid
|
|
370
|
+
*/
|
|
371
|
+
function notValidLogFn(fn) {
|
|
372
|
+
return getType(fn) !== 'function' && fn !== noop;
|
|
373
|
+
}
|
|
374
|
+
/**
|
|
375
|
+
* Generates an error message for invalid log function parameters.
|
|
376
|
+
*
|
|
377
|
+
* @param label - The name of the log function that failed validation
|
|
378
|
+
* @returns A formatted error message string
|
|
379
|
+
*/
|
|
380
|
+
function notFnMsg(label) {
|
|
381
|
+
return `Cannot create a logger when ${label} is not a function`;
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
createLogger(error, warn, log, info, debug);
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Global log level registry.
|
|
388
|
+
* Tracks all created scoped loggers to allow global log level changes.
|
|
389
|
+
*/
|
|
390
|
+
const loggerRegistry = createSet();
|
|
391
|
+
/** Redacted placeholder for sensitive values */
|
|
392
|
+
const REDACTED = '[REDACTED]';
|
|
393
|
+
/**
|
|
394
|
+
* Patterns that indicate a sensitive key name.
|
|
395
|
+
* Keys containing these patterns will have their values sanitized.
|
|
396
|
+
*/
|
|
397
|
+
const SENSITIVE_KEY_PATTERNS = [
|
|
398
|
+
/token/i,
|
|
399
|
+
/key/i,
|
|
400
|
+
/password/i,
|
|
401
|
+
/secret/i,
|
|
402
|
+
/credential/i,
|
|
403
|
+
/auth/i,
|
|
404
|
+
/bearer/i,
|
|
405
|
+
/api[_-]?key/i,
|
|
406
|
+
/private/i,
|
|
407
|
+
/passphrase/i,
|
|
408
|
+
];
|
|
409
|
+
/**
|
|
410
|
+
* Checks if a key name indicates sensitive data.
|
|
411
|
+
*
|
|
412
|
+
* @param key - Key name to check
|
|
413
|
+
* @returns True if the key indicates sensitive data
|
|
414
|
+
*/
|
|
415
|
+
function isSensitiveKey(key) {
|
|
416
|
+
return SENSITIVE_KEY_PATTERNS.some((pattern) => pattern.test(key));
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* Sanitizes an object by replacing sensitive values with REDACTED.
|
|
420
|
+
* This function recursively processes nested objects and arrays.
|
|
421
|
+
*
|
|
422
|
+
* @param obj - Object to sanitize
|
|
423
|
+
* @returns New object with sensitive values redacted
|
|
424
|
+
*/
|
|
425
|
+
function sanitize(obj) {
|
|
426
|
+
if (obj === null || obj === undefined) {
|
|
427
|
+
return obj;
|
|
428
|
+
}
|
|
429
|
+
if (isArray(obj)) {
|
|
430
|
+
return obj.map((item) => sanitize(item));
|
|
431
|
+
}
|
|
432
|
+
if (typeof obj === 'object') {
|
|
433
|
+
const result = {};
|
|
434
|
+
for (const [key, value] of entries(obj)) {
|
|
435
|
+
if (isSensitiveKey(key)) {
|
|
436
|
+
result[key] = REDACTED;
|
|
437
|
+
}
|
|
438
|
+
else if (typeof value === 'object' && value !== null) {
|
|
439
|
+
result[key] = sanitize(value);
|
|
440
|
+
}
|
|
441
|
+
else {
|
|
442
|
+
result[key] = value;
|
|
443
|
+
}
|
|
444
|
+
}
|
|
445
|
+
return result;
|
|
446
|
+
}
|
|
447
|
+
return obj;
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* Formats a log message with optional metadata.
|
|
451
|
+
*
|
|
452
|
+
* @param namespace - Logger namespace prefix
|
|
453
|
+
* @param message - Log message
|
|
454
|
+
* @param meta - Optional metadata object
|
|
455
|
+
* @returns Formatted log string
|
|
456
|
+
*/
|
|
457
|
+
function formatMessage(namespace, message, meta) {
|
|
458
|
+
const prefix = `[${namespace}]`;
|
|
459
|
+
if (meta && keys(meta).length > 0) {
|
|
460
|
+
const sanitizedMeta = sanitize(meta);
|
|
461
|
+
return `${prefix} ${message} ${stringify(sanitizedMeta)}`;
|
|
462
|
+
}
|
|
463
|
+
return `${prefix} ${message}`;
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* Creates a scoped logger with namespace prefix and optional secret sanitization.
|
|
467
|
+
* All log messages will be prefixed with [namespace] and sensitive metadata
|
|
468
|
+
* values will be automatically redacted.
|
|
469
|
+
*
|
|
470
|
+
* @param namespace - Logger namespace (e.g., 'project-scope', 'analyze')
|
|
471
|
+
* @param options - Logger configuration options
|
|
472
|
+
* @returns A configured scoped logger instance
|
|
473
|
+
*
|
|
474
|
+
* @example
|
|
475
|
+
* ```typescript
|
|
476
|
+
* const logger = createScopedLogger('project-scope')
|
|
477
|
+
* logger.setLogLevel('debug')
|
|
478
|
+
*
|
|
479
|
+
* // Basic logging
|
|
480
|
+
* logger.info('Starting analysis', { path: './project' })
|
|
481
|
+
*
|
|
482
|
+
* // Sensitive data is automatically redacted
|
|
483
|
+
* logger.debug('Config loaded', { apiKey: 'secret123' })
|
|
484
|
+
* // Output: [project-scope] Config loaded {"apiKey":"[REDACTED]"}
|
|
485
|
+
* ```
|
|
486
|
+
*/
|
|
487
|
+
function createScopedLogger(namespace, options = {}) {
|
|
488
|
+
const { level = 'error', sanitizeSecrets = true } = options;
|
|
489
|
+
// Create wrapper functions that add namespace prefix and sanitization
|
|
490
|
+
const createLogFn = (baseFn) => (message, meta) => {
|
|
491
|
+
const processedMeta = sanitizeSecrets && meta ? sanitize(meta) : meta;
|
|
492
|
+
baseFn(formatMessage(namespace, message, processedMeta));
|
|
493
|
+
};
|
|
494
|
+
// Create base logger with wrapped functions
|
|
495
|
+
const baseLogger = createLogger(createLogFn(error), createLogFn(warn), createLogFn(log), createLogFn(info), createLogFn(debug));
|
|
496
|
+
// Set initial log level (use global override if set)
|
|
497
|
+
baseLogger.setLogLevel(level);
|
|
498
|
+
const scopedLogger = freeze({
|
|
499
|
+
error: (message, meta) => baseLogger.error(message, meta),
|
|
500
|
+
warn: (message, meta) => baseLogger.warn(message, meta),
|
|
501
|
+
log: (message, meta) => baseLogger.log(message, meta),
|
|
502
|
+
info: (message, meta) => baseLogger.info(message, meta),
|
|
503
|
+
debug: (message, meta) => baseLogger.debug(message, meta),
|
|
504
|
+
setLogLevel: baseLogger.setLogLevel,
|
|
505
|
+
getLogLevel: baseLogger.getLogLevel,
|
|
506
|
+
});
|
|
507
|
+
// Register logger for global level management
|
|
508
|
+
loggerRegistry.add(scopedLogger);
|
|
509
|
+
return scopedLogger;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* Default logger instance for the project-scope library.
|
|
513
|
+
* Use this for general logging within the library.
|
|
514
|
+
*
|
|
515
|
+
* @example
|
|
516
|
+
* ```typescript
|
|
517
|
+
* import { logger } from '@hyperfrontend/project-scope/core'
|
|
518
|
+
*
|
|
519
|
+
* logger.setLogLevel('debug')
|
|
520
|
+
* logger.debug('Analyzing project', { path: './src' })
|
|
521
|
+
* ```
|
|
522
|
+
*/
|
|
523
|
+
createScopedLogger('project-scope');
|
|
524
|
+
|
|
525
|
+
const fsLogger = createScopedLogger('project-scope:fs');
|
|
526
|
+
/**
|
|
527
|
+
* Create a file system error with code and context.
|
|
528
|
+
*
|
|
529
|
+
* @param message - The error message describing what went wrong
|
|
530
|
+
* @param code - The category code for this type of filesystem failure
|
|
531
|
+
* @param context - Additional context including path, operation, and cause
|
|
532
|
+
* @returns A configured Error object with code and context properties
|
|
533
|
+
*/
|
|
534
|
+
function createFileSystemError(message, code, context) {
|
|
535
|
+
const error = createError(message);
|
|
536
|
+
defineProperties(error, {
|
|
537
|
+
code: { value: code, enumerable: true },
|
|
538
|
+
context: { value: context, enumerable: true },
|
|
539
|
+
});
|
|
540
|
+
return error;
|
|
541
|
+
}
|
|
542
|
+
/**
|
|
543
|
+
* Read file contents as string.
|
|
544
|
+
*
|
|
545
|
+
* @param filePath - Path to file
|
|
546
|
+
* @param encoding - File encoding (default: utf-8)
|
|
547
|
+
* @returns File contents as string
|
|
548
|
+
* @throws {Error} If file doesn't exist or can't be read
|
|
549
|
+
*
|
|
550
|
+
* @example
|
|
551
|
+
* ```typescript
|
|
552
|
+
* import { readFileContent } from '@hyperfrontend/project-scope'
|
|
553
|
+
*
|
|
554
|
+
* const content = readFileContent('./package.json')
|
|
555
|
+
* console.log(content) // JSON string
|
|
556
|
+
* ```
|
|
557
|
+
*/
|
|
558
|
+
function readFileContent(filePath, encoding = 'utf-8') {
|
|
559
|
+
if (!node_fs.existsSync(filePath)) {
|
|
560
|
+
fsLogger.debug('File not found', { path: filePath });
|
|
561
|
+
throw createFileSystemError(`File not found: ${filePath}`, 'FS_NOT_FOUND', { path: filePath, operation: 'read' });
|
|
562
|
+
}
|
|
563
|
+
try {
|
|
564
|
+
return node_fs.readFileSync(filePath, { encoding });
|
|
565
|
+
}
|
|
566
|
+
catch (error) {
|
|
567
|
+
fsLogger.warn('Failed to read file', { path: filePath });
|
|
568
|
+
throw createFileSystemError(`Failed to read file: ${filePath}`, 'FS_READ_ERROR', { path: filePath, operation: 'read', cause: error });
|
|
569
|
+
}
|
|
570
|
+
}
|
|
571
|
+
/**
|
|
572
|
+
* Read file contents as Buffer.
|
|
573
|
+
*
|
|
574
|
+
* @param filePath - Path to file
|
|
575
|
+
* @returns File contents as Buffer
|
|
576
|
+
* @throws {Error} If file doesn't exist or can't be read
|
|
577
|
+
*/
|
|
578
|
+
function readFileBuffer(filePath) {
|
|
579
|
+
if (!node_fs.existsSync(filePath)) {
|
|
580
|
+
throw createFileSystemError(`File not found: ${filePath}`, 'FS_NOT_FOUND', { path: filePath, operation: 'read' });
|
|
581
|
+
}
|
|
582
|
+
try {
|
|
583
|
+
return node_fs.readFileSync(filePath);
|
|
584
|
+
}
|
|
585
|
+
catch (error) {
|
|
586
|
+
throw createFileSystemError(`Failed to read file: ${filePath}`, 'FS_READ_ERROR', { path: filePath, operation: 'read', cause: error });
|
|
587
|
+
}
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* Read file if exists, return null otherwise.
|
|
591
|
+
*
|
|
592
|
+
* @param filePath - Path to file
|
|
593
|
+
* @param encoding - File encoding (default: utf-8)
|
|
594
|
+
* @returns File contents or null if file doesn't exist
|
|
595
|
+
*/
|
|
596
|
+
function readFileIfExists(filePath, encoding = 'utf-8') {
|
|
597
|
+
if (!node_fs.existsSync(filePath)) {
|
|
598
|
+
return null;
|
|
599
|
+
}
|
|
600
|
+
try {
|
|
601
|
+
return node_fs.readFileSync(filePath, { encoding });
|
|
602
|
+
}
|
|
603
|
+
catch {
|
|
604
|
+
return null;
|
|
605
|
+
}
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* Read and parse JSON file.
|
|
609
|
+
*
|
|
610
|
+
* @param filePath - Path to JSON file
|
|
611
|
+
* @param options - Parse options
|
|
612
|
+
* @param options.default - Default value if file not found (if not provided, throws on missing file)
|
|
613
|
+
* @returns Parsed JSON object
|
|
614
|
+
* @throws {Error} If file doesn't exist (when no default provided) or contains invalid JSON
|
|
615
|
+
*
|
|
616
|
+
* @example
|
|
617
|
+
* ```typescript
|
|
618
|
+
* import { readJsonFile } from '@hyperfrontend/project-scope'
|
|
619
|
+
*
|
|
620
|
+
* // Read with type inference
|
|
621
|
+
* interface Config { port: number }
|
|
622
|
+
* const config = readJsonFile<Config>('./config.json')
|
|
623
|
+
*
|
|
624
|
+
* // Read with default fallback
|
|
625
|
+
* const settings = readJsonFile('./settings.json', { default: {} })
|
|
626
|
+
* ```
|
|
627
|
+
*/
|
|
628
|
+
function readJsonFile(filePath, options) {
|
|
629
|
+
if (!node_fs.existsSync(filePath)) {
|
|
630
|
+
if (options && 'default' in options) {
|
|
631
|
+
fsLogger.debug('JSON file not found, using default', { path: filePath });
|
|
632
|
+
return options.default;
|
|
633
|
+
}
|
|
634
|
+
fsLogger.debug('JSON file not found', { path: filePath });
|
|
635
|
+
throw createFileSystemError(`File not found: ${filePath}`, 'FS_NOT_FOUND', { path: filePath, operation: 'read' });
|
|
636
|
+
}
|
|
637
|
+
try {
|
|
638
|
+
const content = node_fs.readFileSync(filePath, { encoding: 'utf-8' });
|
|
639
|
+
return parse(content);
|
|
640
|
+
}
|
|
641
|
+
catch (error) {
|
|
642
|
+
if (error?.code === 'ENOENT') {
|
|
643
|
+
fsLogger.debug('JSON file not found (ENOENT)', { path: filePath });
|
|
644
|
+
throw createFileSystemError(`File not found: ${filePath}`, 'FS_NOT_FOUND', { path: filePath, operation: 'read', cause: error });
|
|
645
|
+
}
|
|
646
|
+
fsLogger.warn('Failed to parse JSON file', { path: filePath });
|
|
647
|
+
throw createFileSystemError(`Failed to parse JSON file: ${filePath}`, 'FS_PARSE_ERROR', {
|
|
648
|
+
path: filePath,
|
|
649
|
+
operation: 'read',
|
|
650
|
+
cause: error,
|
|
651
|
+
});
|
|
652
|
+
}
|
|
653
|
+
}
|
|
654
|
+
/**
|
|
655
|
+
* Read and parse JSON file if exists, return null otherwise.
|
|
656
|
+
*
|
|
657
|
+
* @param filePath - Path to JSON file
|
|
658
|
+
* @returns Parsed JSON object or null if file doesn't exist or is invalid
|
|
659
|
+
*/
|
|
660
|
+
function readJsonFileIfExists(filePath) {
|
|
661
|
+
if (!node_fs.existsSync(filePath)) {
|
|
662
|
+
return null;
|
|
663
|
+
}
|
|
664
|
+
try {
|
|
665
|
+
const content = node_fs.readFileSync(filePath, { encoding: 'utf-8' });
|
|
666
|
+
return parse(content);
|
|
667
|
+
}
|
|
668
|
+
catch {
|
|
669
|
+
return null;
|
|
670
|
+
}
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
const fsWriteLogger = createScopedLogger('project-scope:fs:write');
|
|
674
|
+
/**
|
|
675
|
+
* Ensure directory exists, create recursively if not.
|
|
676
|
+
*
|
|
677
|
+
* @param dirPath - Directory path to ensure exists
|
|
678
|
+
*/
|
|
679
|
+
function ensureDir(dirPath) {
|
|
680
|
+
if (!node_fs.existsSync(dirPath)) {
|
|
681
|
+
fsWriteLogger.debug('Creating directory recursively', { path: dirPath });
|
|
682
|
+
node_fs.mkdirSync(dirPath, { recursive: true });
|
|
683
|
+
}
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* Write string content to file.
|
|
687
|
+
* Creates parent directories if needed.
|
|
688
|
+
*
|
|
689
|
+
* @param filePath - Absolute or relative path to the target file
|
|
690
|
+
* @param content - String content to write to the file
|
|
691
|
+
* @param options - Optional write configuration (encoding, mode)
|
|
692
|
+
* @throws {Error} If write fails
|
|
693
|
+
*
|
|
694
|
+
* @example
|
|
695
|
+
* ```typescript
|
|
696
|
+
* import { writeFileContent } from '@hyperfrontend/project-scope'
|
|
697
|
+
*
|
|
698
|
+
* // Write a simple text file
|
|
699
|
+
* writeFileContent('./output/data.txt', 'Hello, World!')
|
|
700
|
+
*
|
|
701
|
+
* // Write with custom encoding
|
|
702
|
+
* writeFileContent('./output/data.txt', 'Content', { encoding: 'utf-8' })
|
|
703
|
+
* ```
|
|
704
|
+
*/
|
|
705
|
+
function writeFileContent(filePath, content, options) {
|
|
706
|
+
try {
|
|
707
|
+
fsWriteLogger.debug('Writing file content', { path: filePath, size: content.length, encoding: options?.encoding ?? 'utf-8' });
|
|
708
|
+
ensureDir(node_path.dirname(filePath));
|
|
709
|
+
node_fs.writeFileSync(filePath, content, {
|
|
710
|
+
encoding: options?.encoding ?? 'utf-8',
|
|
711
|
+
mode: options?.mode,
|
|
712
|
+
});
|
|
713
|
+
fsWriteLogger.debug('File written successfully', { path: filePath });
|
|
714
|
+
}
|
|
715
|
+
catch (error) {
|
|
716
|
+
fsWriteLogger.warn('Failed to write file', { path: filePath, error: error instanceof Error ? error.message : String(error) });
|
|
717
|
+
throw createFileSystemError(`Failed to write file: ${filePath}`, 'FS_WRITE_ERROR', { path: filePath, operation: 'write', cause: error });
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* Write Buffer to file.
|
|
722
|
+
* Creates parent directories if needed.
|
|
723
|
+
*
|
|
724
|
+
* @param filePath - Absolute or relative path to the target file
|
|
725
|
+
* @param content - Buffer containing binary data to write
|
|
726
|
+
* @param options - Optional write configuration (mode)
|
|
727
|
+
* @throws {Error} If write fails
|
|
728
|
+
*/
|
|
729
|
+
function writeFileBuffer(filePath, content, options) {
|
|
730
|
+
try {
|
|
731
|
+
fsWriteLogger.debug('Writing file buffer', { path: filePath, size: content.length });
|
|
732
|
+
ensureDir(node_path.dirname(filePath));
|
|
733
|
+
node_fs.writeFileSync(filePath, content, { mode: options?.mode });
|
|
734
|
+
fsWriteLogger.debug('Buffer written successfully', { path: filePath });
|
|
735
|
+
}
|
|
736
|
+
catch (error) {
|
|
737
|
+
fsWriteLogger.warn('Failed to write buffer', { path: filePath, error: error instanceof Error ? error.message : String(error) });
|
|
738
|
+
throw createFileSystemError(`Failed to write file: ${filePath}`, 'FS_WRITE_ERROR', { path: filePath, operation: 'write', cause: error });
|
|
739
|
+
}
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* Write JSON data to file with formatting.
|
|
743
|
+
* Creates parent directories if needed.
|
|
744
|
+
*
|
|
745
|
+
* @param filePath - Absolute or relative path to the target JSON file
|
|
746
|
+
* @param data - Object or value to serialize as JSON
|
|
747
|
+
* @param options - Optional write configuration (indent, encoding, mode)
|
|
748
|
+
* @throws {Error} If write fails
|
|
749
|
+
*
|
|
750
|
+
* @example
|
|
751
|
+
* ```typescript
|
|
752
|
+
* import { writeJsonFile } from '@hyperfrontend/project-scope'
|
|
753
|
+
*
|
|
754
|
+
* // Write object to JSON file
|
|
755
|
+
* writeJsonFile('./config.json', { port: 3000, debug: true })
|
|
756
|
+
*
|
|
757
|
+
* // Write with custom indentation
|
|
758
|
+
* writeJsonFile('./config.json', data, { indent: 4 })
|
|
759
|
+
* ```
|
|
760
|
+
*/
|
|
761
|
+
function writeJsonFile(filePath, data, options) {
|
|
762
|
+
try {
|
|
763
|
+
fsWriteLogger.debug('Writing JSON file', { path: filePath, indent: options?.indent ?? 2 });
|
|
764
|
+
const indent = options?.indent ?? 2;
|
|
765
|
+
const content = stringify(data, null, indent) + '\n';
|
|
766
|
+
writeFileContent(filePath, content, options);
|
|
767
|
+
fsWriteLogger.debug('JSON file written successfully', { path: filePath });
|
|
768
|
+
}
|
|
769
|
+
catch (error) {
|
|
770
|
+
if (error?.code === 'FS_WRITE_ERROR') {
|
|
771
|
+
throw error;
|
|
772
|
+
}
|
|
773
|
+
fsWriteLogger.warn('Failed to write JSON file', { path: filePath, error: error instanceof Error ? error.message : String(error) });
|
|
774
|
+
throw createFileSystemError(`Failed to write JSON file: ${filePath}`, 'FS_WRITE_ERROR', {
|
|
775
|
+
path: filePath,
|
|
776
|
+
operation: 'write',
|
|
777
|
+
cause: error,
|
|
778
|
+
});
|
|
779
|
+
}
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
/**
|
|
783
|
+
* Get file stats with error handling.
|
|
784
|
+
*
|
|
785
|
+
* @param filePath - Path to file
|
|
786
|
+
* @param followSymlinks - Whether to follow symlinks (default: true)
|
|
787
|
+
* @returns File stats or null if path doesn't exist
|
|
788
|
+
*/
|
|
789
|
+
function getFileStat(filePath, followSymlinks = true) {
|
|
790
|
+
if (!node_fs.existsSync(filePath)) {
|
|
791
|
+
return null;
|
|
792
|
+
}
|
|
793
|
+
try {
|
|
794
|
+
const stat = followSymlinks ? node_fs.statSync(filePath) : node_fs.lstatSync(filePath);
|
|
795
|
+
return {
|
|
796
|
+
isFile: stat.isFile(),
|
|
797
|
+
isDirectory: stat.isDirectory(),
|
|
798
|
+
isSymlink: stat.isSymbolicLink(),
|
|
799
|
+
size: stat.size,
|
|
800
|
+
created: stat.birthtime,
|
|
801
|
+
modified: stat.mtime,
|
|
802
|
+
accessed: stat.atime,
|
|
803
|
+
mode: stat.mode,
|
|
804
|
+
};
|
|
805
|
+
}
|
|
806
|
+
catch {
|
|
807
|
+
return null;
|
|
808
|
+
}
|
|
809
|
+
}
|
|
810
|
+
/**
|
|
811
|
+
* Check if path is a file.
|
|
812
|
+
*
|
|
813
|
+
* @param filePath - Path to check
|
|
814
|
+
* @returns True if path is a file
|
|
815
|
+
*/
|
|
816
|
+
function isFile(filePath) {
|
|
817
|
+
const stats = getFileStat(filePath);
|
|
818
|
+
return stats?.isFile ?? false;
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* Check if path is a directory.
|
|
822
|
+
*
|
|
823
|
+
* @param dirPath - Path to check
|
|
824
|
+
* @returns True if path is a directory
|
|
825
|
+
*/
|
|
826
|
+
function isDirectory(dirPath) {
|
|
827
|
+
const stats = getFileStat(dirPath);
|
|
828
|
+
return stats?.isDirectory ?? false;
|
|
829
|
+
}
|
|
830
|
+
/**
|
|
831
|
+
* Check if path is a symbolic link.
|
|
832
|
+
*
|
|
833
|
+
* @param linkPath - Path to check
|
|
834
|
+
* @returns True if path is a symlink
|
|
835
|
+
*/
|
|
836
|
+
function isSymlink(linkPath) {
|
|
837
|
+
const stats = getFileStat(linkPath, false);
|
|
838
|
+
return stats?.isSymlink ?? false;
|
|
839
|
+
}
|
|
840
|
+
/**
|
|
841
|
+
* Check if path exists.
|
|
842
|
+
*
|
|
843
|
+
* @param filePath - Path to check
|
|
844
|
+
* @returns True if path exists
|
|
845
|
+
*/
|
|
846
|
+
function exists(filePath) {
|
|
847
|
+
return node_fs.existsSync(filePath);
|
|
848
|
+
}
|
|
849
|
+
|
|
850
|
+
const fsDirLogger = createScopedLogger('project-scope:fs:dir');
|
|
851
|
+
/**
|
|
852
|
+
* List immediate contents of a directory.
|
|
853
|
+
*
|
|
854
|
+
* @param dirPath - Absolute or relative path to the directory
|
|
855
|
+
* @returns Array of entries with metadata for each file/directory
|
|
856
|
+
* @throws {Error} If directory doesn't exist or isn't a directory
|
|
857
|
+
*
|
|
858
|
+
* @example
|
|
859
|
+
* ```typescript
|
|
860
|
+
* import { readDirectory } from '@hyperfrontend/project-scope'
|
|
861
|
+
*
|
|
862
|
+
* const entries = readDirectory('./src')
|
|
863
|
+
* for (const entry of entries) {
|
|
864
|
+
* console.log(entry.name, entry.isFile ? 'file' : 'directory')
|
|
865
|
+
* }
|
|
866
|
+
* ```
|
|
867
|
+
*/
|
|
868
|
+
function readDirectory(dirPath) {
|
|
869
|
+
fsDirLogger.debug('Reading directory', { path: dirPath });
|
|
870
|
+
if (!node_fs.existsSync(dirPath)) {
|
|
871
|
+
fsDirLogger.debug('Directory not found', { path: dirPath });
|
|
872
|
+
throw createFileSystemError(`Directory not found: ${dirPath}`, 'FS_NOT_FOUND', { path: dirPath, operation: 'readdir' });
|
|
873
|
+
}
|
|
874
|
+
if (!isDirectory(dirPath)) {
|
|
875
|
+
fsDirLogger.debug('Path is not a directory', { path: dirPath });
|
|
876
|
+
throw createFileSystemError(`Not a directory: ${dirPath}`, 'FS_NOT_A_DIRECTORY', { path: dirPath, operation: 'readdir' });
|
|
877
|
+
}
|
|
878
|
+
try {
|
|
879
|
+
const entries = node_fs.readdirSync(dirPath, { withFileTypes: true });
|
|
880
|
+
fsDirLogger.debug('Directory read complete', { path: dirPath, entryCount: entries.length });
|
|
881
|
+
return entries.map((entry) => ({
|
|
882
|
+
name: entry.name,
|
|
883
|
+
path: node_path.join(dirPath, entry.name),
|
|
884
|
+
isFile: entry.isFile(),
|
|
885
|
+
isDirectory: entry.isDirectory(),
|
|
886
|
+
isSymlink: entry.isSymbolicLink(),
|
|
887
|
+
}));
|
|
888
|
+
}
|
|
889
|
+
catch (error) {
|
|
890
|
+
fsDirLogger.warn('Failed to read directory', { path: dirPath, error: error instanceof Error ? error.message : String(error) });
|
|
891
|
+
throw createFileSystemError(`Failed to read directory: ${dirPath}`, 'FS_READ_ERROR', {
|
|
892
|
+
path: dirPath,
|
|
893
|
+
operation: 'readdir',
|
|
894
|
+
cause: error,
|
|
895
|
+
});
|
|
896
|
+
}
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* List directory contents recursively with depth tracking.
|
|
900
|
+
*
|
|
901
|
+
* @param dirPath - Root directory path to start traversal
|
|
902
|
+
* @param options - Configuration for depth limit, hidden files, and symlinks
|
|
903
|
+
* @returns Flat array of all entries found during traversal
|
|
904
|
+
*
|
|
905
|
+
* @example
|
|
906
|
+
* ```typescript
|
|
907
|
+
* import { readDirectoryRecursive } from '@hyperfrontend/project-scope'
|
|
908
|
+
*
|
|
909
|
+
* // List all files up to 3 levels deep
|
|
910
|
+
* const entries = readDirectoryRecursive('./src', { maxDepth: 3 })
|
|
911
|
+
*
|
|
912
|
+
* // Include hidden files
|
|
913
|
+
* const allEntries = readDirectoryRecursive('./project', { includeHidden: true })
|
|
914
|
+
* ```
|
|
915
|
+
*/
|
|
916
|
+
function readDirectoryRecursive(dirPath, options) {
|
|
917
|
+
const maxDepth = options?.maxDepth ?? Infinity;
|
|
918
|
+
const includeHidden = options?.includeHidden ?? false;
|
|
919
|
+
const followSymlinks = options?.followSymlinks ?? false;
|
|
920
|
+
fsDirLogger.debug('Starting recursive directory read', {
|
|
921
|
+
path: dirPath,
|
|
922
|
+
maxDepth: maxDepth === Infinity ? 'unlimited' : maxDepth,
|
|
923
|
+
includeHidden,
|
|
924
|
+
followSymlinks,
|
|
925
|
+
});
|
|
926
|
+
const results = [];
|
|
927
|
+
/**
|
|
928
|
+
* Recursively walk directories and collect entries.
|
|
929
|
+
*
|
|
930
|
+
* @param currentPath - Current directory being processed
|
|
931
|
+
* @param depth - Current depth level from the starting directory
|
|
932
|
+
*/
|
|
933
|
+
function walk(currentPath, depth) {
|
|
934
|
+
if (depth > maxDepth) {
|
|
935
|
+
fsDirLogger.debug('Max depth reached, skipping', { path: currentPath, depth, maxDepth });
|
|
936
|
+
return;
|
|
937
|
+
}
|
|
938
|
+
let entries;
|
|
939
|
+
try {
|
|
940
|
+
entries = readDirectory(currentPath);
|
|
941
|
+
}
|
|
942
|
+
catch {
|
|
943
|
+
// Skip inaccessible directories
|
|
944
|
+
fsDirLogger.debug('Skipping inaccessible directory', { path: currentPath });
|
|
945
|
+
return;
|
|
946
|
+
}
|
|
947
|
+
for (const entry of entries) {
|
|
948
|
+
// Skip hidden files/dirs if not included
|
|
949
|
+
if (!includeHidden && entry.name.startsWith('.')) {
|
|
950
|
+
continue;
|
|
951
|
+
}
|
|
952
|
+
results.push({ ...entry, depth });
|
|
953
|
+
// Recurse into directories
|
|
954
|
+
if (entry.isDirectory || (entry.isSymlink && followSymlinks && isDirectory(entry.path))) {
|
|
955
|
+
walk(entry.path, depth + 1);
|
|
956
|
+
}
|
|
957
|
+
}
|
|
958
|
+
}
|
|
959
|
+
walk(dirPath, 0);
|
|
960
|
+
fsDirLogger.debug('Recursive directory read complete', { path: dirPath, totalEntries: results.length });
|
|
961
|
+
return results;
|
|
962
|
+
}
|
|
963
|
+
/**
|
|
964
|
+
* Create a directory, optionally creating parent directories.
|
|
965
|
+
*
|
|
966
|
+
* @param dirPath - Path where the directory should be created
|
|
967
|
+
* @param options - Creation options
|
|
968
|
+
* @param options.recursive - Create parent directories if missing (default: true)
|
|
969
|
+
*/
|
|
970
|
+
function createDirectory(dirPath, options) {
|
|
971
|
+
const recursive = options?.recursive ?? true;
|
|
972
|
+
fsDirLogger.debug('Creating directory', { path: dirPath, recursive });
|
|
973
|
+
node_fs.mkdirSync(dirPath, { recursive });
|
|
974
|
+
}
|
|
975
|
+
/**
|
|
976
|
+
* Delete a directory from the filesystem.
|
|
977
|
+
*
|
|
978
|
+
* @param dirPath - Path to the directory to remove
|
|
979
|
+
* @param options - Removal configuration
|
|
980
|
+
* @param options.recursive - Delete directory contents recursively
|
|
981
|
+
* @param options.force - Ignore errors if directory doesn't exist
|
|
982
|
+
*/
|
|
983
|
+
function removeDirectory(dirPath, options) {
|
|
984
|
+
fsDirLogger.debug('Removing directory', { path: dirPath, recursive: options?.recursive, force: options?.force });
|
|
985
|
+
node_fs.rmSync(dirPath, {
|
|
986
|
+
recursive: options?.recursive ?? false,
|
|
987
|
+
force: options?.force ?? false,
|
|
988
|
+
});
|
|
989
|
+
}
|
|
990
|
+
|
|
991
|
+
/**
|
|
992
|
+
* Join path segments.
|
|
993
|
+
* Uses platform-specific separators (e.g., / or \).
|
|
994
|
+
*
|
|
995
|
+
* @param paths - Path segments to join
|
|
996
|
+
* @returns Joined path
|
|
997
|
+
*/
|
|
998
|
+
function join(...paths) {
|
|
999
|
+
return node_path.join(...paths);
|
|
1000
|
+
}
|
|
1001
|
+
|
|
1002
|
+
const fsTraversalLogger = createScopedLogger('project-scope:fs:traversal');
|
|
1003
|
+
/**
|
|
1004
|
+
* Generic upward directory traversal.
|
|
1005
|
+
* Name avoids similarity to fs.readdir/fs.readdirSync.
|
|
1006
|
+
*
|
|
1007
|
+
* @param startPath - Starting directory
|
|
1008
|
+
* @param predicate - Function to test each directory
|
|
1009
|
+
* @returns First matching directory or null
|
|
1010
|
+
*/
|
|
1011
|
+
function traverseUpward(startPath, predicate) {
|
|
1012
|
+
fsTraversalLogger.debug('Starting upward traversal', { startPath });
|
|
1013
|
+
let currentPath = node_path.resolve(startPath);
|
|
1014
|
+
const rootPath = node_path.parse(currentPath).root;
|
|
1015
|
+
while (currentPath !== rootPath) {
|
|
1016
|
+
if (predicate(currentPath)) {
|
|
1017
|
+
fsTraversalLogger.debug('Upward traversal found match', { startPath, foundPath: currentPath });
|
|
1018
|
+
return currentPath;
|
|
1019
|
+
}
|
|
1020
|
+
currentPath = node_path.dirname(currentPath);
|
|
1021
|
+
}
|
|
1022
|
+
// Check root directory
|
|
1023
|
+
if (predicate(rootPath)) {
|
|
1024
|
+
fsTraversalLogger.debug('Upward traversal found match at root', { startPath, foundPath: rootPath });
|
|
1025
|
+
return rootPath;
|
|
1026
|
+
}
|
|
1027
|
+
fsTraversalLogger.debug('Upward traversal found no match', { startPath });
|
|
1028
|
+
return null;
|
|
1029
|
+
}
|
|
1030
|
+
/**
|
|
1031
|
+
* Find directory containing any of the specified marker files.
|
|
1032
|
+
*
|
|
1033
|
+
* @param startPath - Starting directory
|
|
1034
|
+
* @param markers - Array of marker file names to search for
|
|
1035
|
+
* @returns First directory containing any marker, or null
|
|
1036
|
+
*/
|
|
1037
|
+
function locateByMarkers(startPath, markers) {
|
|
1038
|
+
fsTraversalLogger.debug('Locating by markers', { startPath, markers });
|
|
1039
|
+
const result = traverseUpward(startPath, (dir) => markers.some((marker) => exists(join(dir, marker))));
|
|
1040
|
+
if (result) {
|
|
1041
|
+
fsTraversalLogger.debug('Found directory with marker', { startPath, foundPath: result });
|
|
1042
|
+
}
|
|
1043
|
+
return result;
|
|
1044
|
+
}
|
|
1045
|
+
/**
|
|
1046
|
+
* Find directory where predicate returns true, starting from given path.
|
|
1047
|
+
*
|
|
1048
|
+
* @param startPath - Starting directory
|
|
1049
|
+
* @param test - Function to test if directory matches criteria
|
|
1050
|
+
* @returns Matching directory path or null
|
|
1051
|
+
*/
|
|
1052
|
+
function findUpwardWhere(startPath, test) {
|
|
1053
|
+
fsTraversalLogger.debug('Finding upward where condition met', { startPath });
|
|
1054
|
+
return traverseUpward(startPath, test);
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1057
|
+
exports.createDirectory = createDirectory;
|
|
1058
|
+
exports.createFileSystemError = createFileSystemError;
|
|
1059
|
+
exports.ensureDir = ensureDir;
|
|
1060
|
+
exports.exists = exists;
|
|
1061
|
+
exports.findUpwardWhere = findUpwardWhere;
|
|
1062
|
+
exports.getFileStat = getFileStat;
|
|
1063
|
+
exports.isDirectory = isDirectory;
|
|
1064
|
+
exports.isFile = isFile;
|
|
1065
|
+
exports.isSymlink = isSymlink;
|
|
1066
|
+
exports.locateByMarkers = locateByMarkers;
|
|
1067
|
+
exports.readDirectory = readDirectory;
|
|
1068
|
+
exports.readDirectoryRecursive = readDirectoryRecursive;
|
|
1069
|
+
exports.readFileBuffer = readFileBuffer;
|
|
1070
|
+
exports.readFileContent = readFileContent;
|
|
1071
|
+
exports.readFileIfExists = readFileIfExists;
|
|
1072
|
+
exports.readJsonFile = readJsonFile;
|
|
1073
|
+
exports.readJsonFileIfExists = readJsonFileIfExists;
|
|
1074
|
+
exports.removeDirectory = removeDirectory;
|
|
1075
|
+
exports.traverseUpward = traverseUpward;
|
|
1076
|
+
exports.writeFileBuffer = writeFileBuffer;
|
|
1077
|
+
exports.writeFileContent = writeFileContent;
|
|
1078
|
+
exports.writeJsonFile = writeJsonFile;
|
|
1079
|
+
//# sourceMappingURL=index.cjs.js.map
|