Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: allow caching readPackageJSON and readTSConfig #47

Merged
merged 2 commits into from
Nov 14, 2022
Merged

feat: allow caching readPackageJSON and readTSConfig #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cfdf70
perf: cache package.json + tsconfig.json results
danielroe Sep 26, 2022
f62cf5e
feat: support passing user cache
danielroe Sep 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 19 additions & 4 deletions src/index.ts
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@ export * from './types'
export * from './utils'

export type ResolveOptions = _ResolveOptions & FindFileOptions
export type ReadOptions = { cache?: boolean | Map<string, Record<string, any>> }

export function definePackageJSON (pkg: PackageJson): PackageJson {
return pkg
Expand All @@ -18,21 +19,35 @@ export function defineTSConfig (tsconfig: TSConfig): TSConfig {
return tsconfig
}

export async function readPackageJSON (id?: string, opts: ResolveOptions = {}): Promise<PackageJson> {
const FileCache = new Map<string, Record<string, any>>()

export async function readPackageJSON (id?: string, opts: ResolveOptions & ReadOptions = {}): Promise<PackageJson> {
const resolvedPath = await resolvePackageJSON(id, opts)
const cache = opts.cache && typeof opts.cache !== 'boolean' ? opts.cache : FileCache
if (opts.cache && cache.has(resolvedPath)) {
return cache.get(resolvedPath)!
}
const blob = await fsp.readFile(resolvedPath, 'utf-8')
return JSON.parse(blob) as PackageJson
const parsed = JSON.parse(blob) as PackageJson
cache.set(resolvedPath, parsed)
return parsed
}

export async function writePackageJSON (path: string, pkg: PackageJson): Promise<void> {
await fsp.writeFile(path, JSON.stringify(pkg, null, 2))
}

export async function readTSConfig (id?: string, opts: ResolveOptions = {}): Promise<TSConfig> {
export async function readTSConfig (id?: string, opts: ResolveOptions & ReadOptions = {}): Promise<TSConfig> {
const resolvedPath = await resolveTSConfig(id, opts)
const cache = opts.cache && typeof opts.cache !== 'boolean' ? opts.cache : FileCache
if (opts.cache && cache.has(resolvedPath)) {
return cache.get(resolvedPath)!
}
const blob = await fsp.readFile(resolvedPath, 'utf-8')
const jsonc = await import('jsonc-parser')
return jsonc.parse(blob) as TSConfig
const parsed = jsonc.parse(blob) as TSConfig
cache.set(resolvedPath, parsed)
return parsed
}

export async function writeTSConfig (path: string, tsconfig: TSConfig): Promise<void> {
Expand Down