66
77** Core infrastructure library for Socket.dev security tools** β utilities, constants, and helpers with zero dependencies.
88
9- ## π― Quick Start
9+ ## Quick Start
1010
1111``` bash
1212pnpm add @socketsecurity/lib
@@ -28,19 +28,19 @@ spinner.stop()
2828
2929```
3030@socketsecurity/lib
31- βββ π¨ Visual Effects β Spinners, shimmer, themes, logger
32- βββ π File System β fs, paths, globs, temp files
33- βββ π¦ Package Management β npm, pnpm, yarn utilities
34- βββ π§ Process & Spawn β Safe process spawning, IPC
35- βββ π Environment β 68 typed env getters (CI, paths, etc)
36- βββ π― Constants β Node.js, npm, platform constants
37- βββ π§© Utilities β Arrays, objects, strings, promises
38- βββ π Types β Full TypeScript definitions
31+ βββ Visual Effects β Spinners, shimmer, themes, logger
32+ βββ File System β fs, paths, globs, temp files
33+ βββ Package Management β npm, pnpm, yarn utilities
34+ βββ Process & Spawn β Safe process spawning, IPC
35+ βββ Environment β 68 typed env getters (CI, paths, etc)
36+ βββ Constants β Node.js, npm, platform constants
37+ βββ Utilities β Arrays, objects, strings, promises
38+ βββ Types β Full TypeScript definitions
3939```
4040
4141## π‘ Key Features
4242
43- ### π¨ Visual Effects
43+ ### Visual Effects
4444
4545** Themed spinners and text effects:**
4646
@@ -57,7 +57,7 @@ spinner.start()
5757
5858π [ ** Theme System Docs** ] ( ./docs/themes.md )
5959
60- ### π File System
60+ ### File System
6161
6262** Safe, typed file operations:**
6363
@@ -68,7 +68,7 @@ const pkg = await readJsonFile<PackageJson>('./package.json')
6868await writeJsonFile (' ./output.json' , { data: pkg })
6969```
7070
71- ### π¦ Package Management
71+ ### Package Management
7272
7373** Parse and validate package specs:**
7474
@@ -79,7 +79,7 @@ const spec = parsePackageSpec('lodash@^4.17.0')
7979// { name: 'lodash', version: '^4.17.0', type: 'range', ... }
8080```
8181
82- ### π Environment Variables
82+ ### Environment Variables
8383
8484** 68 typed environment getters:**
8585
@@ -93,7 +93,7 @@ if (getCI()) {
9393}
9494```
9595
96- ### π― Constants
96+ ### Constants
9797
9898** Access platform and Node.js constants:**
9999
@@ -107,7 +107,7 @@ import {
107107import { DARWIN , WIN32 } from ' @socketsecurity/lib/constants/platform'
108108```
109109
110- ## π Common Patterns
110+ ## Common Patterns
111111
112112### Spinner with Progress
113113
@@ -156,7 +156,7 @@ const result = await timeout(fetchData(), 5000)
156156const data = await retry (() => fetchData (), { maxAttempts: 3 })
157157```
158158
159- ## ποΈ Module Organization
159+ ## Module Organization
160160
161161** 120+ granular exports** organized by category:
162162
@@ -198,7 +198,7 @@ const data = await retry(() => fetchData(), { maxAttempts: 3 })
198198 ββ utils β Color resolution, theme creation
199199```
200200
201- ## π Documentation
201+ ## Documentation
202202
203203| Doc | Description |
204204| -----| -------------|
@@ -207,7 +207,7 @@ const data = await retry(() => fetchData(), { maxAttempts: 3 })
207207| [ ** Build Architecture** ] ( ./docs/build.md ) | Vendored dependencies, build system |
208208| [ ** CLAUDE.md** ] ( ./CLAUDE.md ) | Coding standards and patterns |
209209
210- ## ποΈ Architecture
210+ ## Architecture
211211
212212```
213213βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
@@ -230,7 +230,7 @@ const data = await retry(() => fetchData(), { maxAttempts: 3 })
230230βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
231231```
232232
233- ## π οΈ Development
233+ ## Development
234234
235235``` bash
236236# Setup
@@ -252,7 +252,7 @@ pnpm run lint # Lint code
252252pnpm run fix # Auto-fix issues
253253```
254254
255- ## π Stats
255+ ## Stats
256256
257257- ** 183** TypeScript modules
258258- ** 120+** granular exports
@@ -261,15 +261,15 @@ pnpm run fix # Auto-fix issues
261261- ** 4600+** tests passing
262262- ** Zero** runtime dependencies
263263
264- ## π€ Contributing
264+ ## Contributing
265265
266266See [ CLAUDE.md] ( ./CLAUDE.md ) for:
267267- Code style and patterns
268268- Path alias usage
269269- Testing guidelines
270270- Build system details
271271
272- ## π License
272+ ## License
273273
274274MIT
275275
0 commit comments