Skip to content

Commit a0cefcd

Browse files
committed
docs: add missing @fileoverview headers to 26 modules
Brings every module under src/ (excluding external/ and types/) to @fileoverview coverage. Files updated span constants/, env/, argv/, and the core git.ts, ipc.ts, promise-queue.ts, utils/get-ipc.ts. Each header is a short 2-4 line summary describing what the module is for and what belongs in it, modeled after the existing style in src/spawn.ts and src/http-request.ts. ipc.ts absorbed its previous prose-heavy leading comment into a concise @fileoverview block.
1 parent 657652f commit a0cefcd

26 files changed

+92
-65
lines changed

src/argv/flags.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
/**
2-
* Common flag utilities for Socket CLI applications.
3-
* Provides consistent flag checking across all Socket projects.
2+
* @fileoverview Common flag utilities for Socket CLI applications.
3+
* Provides consistent flag checking (quiet, silent, verbose, debug, dry-run,
4+
* etc.) across Socket projects, accepting either parsed flag objects or raw
5+
* argv arrays.
46
*/
57

68
/**

src/argv/parse.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/**
2-
* Argument parsing utilities for CLI applications.
3-
* Uses yargs-parser internally for robust argument parsing with Node.js parseArgs-compatible API.
2+
* @fileoverview Argument parsing utilities for CLI applications.
3+
* Wraps the vendored yargs-parser with a Node.js parseArgs-compatible surface
4+
* for booleans, strings, arrays, aliases, defaults, and coercion.
45
*/
56

67
import process from 'node:process'

src/constants/agents.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/**
2-
* Package manager agent constants.
3-
* Agent names, lockfile names, registry URLs, and configuration field names.
2+
* @fileoverview Package manager agent constants.
3+
* Exports agent names (npm/pnpm/yarn/bun/vlt/npx), lockfile names, registry
4+
* URLs, and resolved npm binary paths used across Socket tooling.
45
*/
56

67
import which from '../external/which'

src/constants/core.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
/**
2-
* Core primitives and fundamental constants.
3-
* Goal: Minimize this module by finding proper semantic homes for all constants.
2+
* @fileoverview Core primitives and fundamental constants.
3+
* Holds sentinels, unknown/empty tokens, the internals symbol, and a few
4+
* shared env-var name strings. Intentionally kept small - prefer moving
5+
* constants to a more specific `src/constants/*` module when possible.
46
*/
57

68
// Internal implementation symbol.

src/constants/encoding.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
/**
2-
* Character encodings and character codes.
2+
* @fileoverview Character encoding and character code constants.
3+
* Exports the default UTF-8 encoding name and numeric char codes for common
4+
* ASCII characters used by path and parsing utilities.
35
*/
46

57
// Encoding.

src/constants/github.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
/**
2-
* GitHub APIs and cache configuration.
2+
* @fileoverview GitHub API and cache constants.
3+
* Provides the GitHub REST API base URL and the cache subdirectory name used
4+
* for persisting GitHub responses.
35
*/
46

57
// GitHub API.

src/constants/licenses.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
/**
2-
* License identifiers and copy-left license sets.
2+
* @fileoverview License identifier constants.
3+
* Exports common SPDX license strings (MIT, UNLICENSED) and a lazily-built
4+
* set of copy-left SPDX identifiers used when classifying package licenses.
35
*/
46

57
// License identifiers.

src/constants/node.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
/**
2-
* Node.js runtime: versions, features, flags, and capabilities.
2+
* @fileoverview Node.js runtime version and capability helpers.
3+
* Provides getters for the current Node version (major/minor/patch), the
4+
* maintained-versions list, and feature-detection flags for APIs that vary
5+
* across Node releases.
36
*/
47

58
import process from 'node:process'

src/constants/packages.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
/**
2-
* Package metadata, defaults, extensions, and lifecycle scripts.
2+
* @fileoverview Package metadata, defaults, extensions, and lifecycle helpers.
3+
* Exposes lazily-memoized accessors for package defaults (Node range, Socket
4+
* categories), the pacote cache path, lifecycle script names, and known
5+
* package extensions used during manifest processing.
36
*/
47

58
import { getNpmLifecycleEvent as getNpmLifecycleEventEnv } from '../env/npm'

src/constants/process.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
/**
2-
* Process control: abort signals and UI utilities.
2+
* @fileoverview Process control helpers.
3+
* Lazily creates and exposes a shared `AbortController` and its `AbortSignal`
4+
* so cooperating modules can coordinate cancellation from a single source.
35
*/
46

57
// Abort controller and signal.

0 commit comments

Comments
 (0)