Skip to content

SocketDev/socket-lib

@socketsecurity/lib

Socket Badge CI - SocketDev/socket-lib

Follow @SocketSecurity Follow @socket.dev on Bluesky

Core utilities, constants, and helper functions for Socket.dev security tools.

Installation

pnpm install @socketsecurity/lib

Features

  • Constants — Access Node.js, npm, and package manager constants
  • Type Definitions — Full TypeScript support with comprehensive type exports
  • Helper Utilities — File system, path, package, and process utilities
  • Environment Variables — Typed access to environment variables
  • Effects — Visual effects for CLI applications

Usage

Constants

Import Node.js and package manager constants:

import {
  NODE_MODULES,
  PACKAGE_JSON,
  PNPM_LOCK_YAML,
  NPM_REGISTRY_URL,
} from '@socketsecurity/lib/constants/packages'

Environment Variables

Access typed environment variables:

import { getEnv } from '@socketsecurity/lib/env/getters'
import { NODE_ENV } from '@socketsecurity/lib/env/node-env'

const env = getEnv('NODE_ENV')
console.log(NODE_ENV) // 'production' | 'development' | 'test'

For a complete list of available modules, see the package.json exports.

Type Definitions

All types are exported for TypeScript projects:

import type {
  PackageJson,
  TsConfig,
  LockFile,
} from '@socketsecurity/lib/types'

Utilities

Access utility modules for common operations:

// File system utilities
import { readJsonFile, writeJsonFile } from '@socketsecurity/lib/fs'

// Package utilities
import { parsePackageSpec } from '@socketsecurity/lib/packages'

// Path utilities
import { normalizePath } from '@socketsecurity/lib/paths'

// And many more...

See the exports map for all available utility modules.

License

MIT

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published