Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
pkg-types
Advanced tools
Changelog
Readme
Node.js utilities and TypeScript definitions for
package.json
andtsconfig.json
\⍩⃝/
# npm
npm i pkg-types
# yarn
yarn add pkg-types
readPackageJSON
import { readPackageJSON } from 'pkg-types'
const pkg = await readPackageJSON('path/to/package.json')
writePackageJSON
import { writePackageJSON } from 'pkg-types'
await writePackageJSON('path/to/package.json', pkg)
resolvePackageJSON
import { resolvePackageJSON } from 'pkg-types'
const filename = await resolvePackageJSON()
// or
const packageJson = await resolvePackageJSON('/fully/resolved/path/to/folder')
readPackageJSON
import { readPackageJSON } from 'pkg-types'
const filename = await readPackageJSON()
// or
const packageJson = await readPackageJSON('/fully/resolved/path/to/folder')
readTSConfig
import { readTSConfig } from 'pkg-types'
const pkg = await readTSConfig('path/to/tsconfig.json')
writeTSConfig
import { writeTSConfig } from 'pkg-types'
await writeTSConfig('path/to/tsconfig.json', tsconfig)
resolveTSConfig
import { resolveTSConfig } from 'pkg-types'
const filename = await resolveTSConfig()
// or
const tsconfig = await resolveTSConfig('/fully/resolved/path/to/folder')
readTSConfig
import { readTSConfig } from 'pkg-types'
const filename = await readTSConfig()
// or
const tsconfig = await readTSConfig('/fully/resolved/path/to/folder')
resolveFile
import { resolveFile } from 'pkg-types'
const filename = await resolveFile('README.md', {
startingFrom: id,
rootPattern: /^node_modules$/,
matcher: filename => filename.endsWith('.md'),
})
resolveLockFile
Find path to the lock file (yarn.lock
, package-lock.json
, pnpm-lock.yaml
, npm-shrinkwrap.json
) or throws an error.
import { resolveLockFile } from 'pkg-types'
const lockfile = await resolveLockFile('.')
findWorkspaceDir
Try to detect workspace dir by in order:
.git
directorypackage.json
fileIf fails, throws an error.
import { findWorkspaceDir } from 'pkg-types'
const workspaceDir = await findWorkspaceDir('.')
Note: In order to make types working, you need to install typescript
as a devDependency.
You can directly use typed interfaces:
import type { TSConfig, PackageJSON } from 'pkg-types'
You can also use define utils for type support for using in plain .js
files and auto-complete in IDE.
import type { definePackageJSON } from 'pkg-types'
const pkg = definePackageJSON({})
import type { defineTSConfig } from 'pkg-types'
const pkg = defineTSConfig({})
MIT - Made with 💛
FAQs
Node.js utilities and TypeScript definitions for `package.json` and `tsconfig.json`
We found that pkg-types demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).