Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Node.js utilities and TypeScript definitions for `package.json` and `tsconfig.json`
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'),
})
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`
The npm package pkg-types receives a total of 5,448,567 weekly downloads. As such, pkg-types popularity was classified as popular.
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
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.