@vltpkg/package-json - npm Package Compare versions

+28

dist/index.d.ts

		import type { NormalizedManifest } from '@vltpkg/types';
		export declare class PackageJson {
		#private;
		/**
		* Reads and parses contents of a `package.json` file at a directory `dir`.
		* `reload` will optionally skip reading from the cache when set to `true`.
		*/
		read(dir: string, { reload }?: {
		reload?: boolean;
		}): NormalizedManifest;
		/**
		* Optionally reads and parses contents of a `package.json` file at a
		* directory `dir`. Returns `undefined` if it could not be read.
		*/
		maybeRead(dir: string, { reload }?: {
		reload?: boolean;
		}): NormalizedManifest \| undefined;
		write(dir: string, manifest: NormalizedManifest, indent?: number): void;
		save(manifest: NormalizedManifest): void;
		fix(manifest: NormalizedManifest): void;
		/**
		* Walks up the directory tree from the current working directory
		* and returns the path to the first `package.json` file found.
		* Returns undefined if no package.json is found.
		*/
		find(cwd?: string, home?: string): string \| undefined;
		}
		//# sourceMappingURL=index.d.ts.map

+1

dist/index.d.ts.map

{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAgBvD,qBAAa,WAAW;;IAgBtB;;;OAGG;IACH,IAAI,CACF,GAAG,EAAE,MAAM,EACX,EAAE,MAAM,EAAE,GAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAO,GACpC,kBAAkB;IAsCrB;;;OAGG;IACH,SAAS,CACP,GAAG,EAAE,MAAM,EACX,EAAE,MAAM,EAAE,GAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAO,GACpC,kBAAkB,GAAG,SAAS;IAQjC,KAAK,CACH,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,kBAAkB,EAC5B,MAAM,CAAC,EAAE,MAAM,GACd,IAAI;IA6BP,IAAI,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAcxC,GAAG,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAcvC;;;;OAIG;IACH,IAAI,CACF,GAAG,GAAE,MAAsB,EAC3B,IAAI,GAAE,MAAkB,GACvB,MAAM,GAAG,SAAS;CAWtB"}

+132

dist/index.js

		import { error } from '@vltpkg/error-cause';
		import { asManifest, longDependencyTypes, normalizeManifest, } from '@vltpkg/types';
		import { readFileSync, writeFileSync, lstatSync } from 'node:fs';
		import { resolve } from 'node:path';
		import { homedir } from 'node:os';
		import { parse, stringify } from 'polite-json';
		import { walkUp } from 'walk-up-path';
		const exists = (path) => {
		try {
		lstatSync(path);
		return true;
		}
		catch {
		return false;
		}
		};
		export class PackageJson {
		/**
		* cache of `package.json` loads
		*/
		#cache = new Map();
		/**
		* cache of `package.json` paths by manifest
		*/
		#pathCache = new Map();
		/**
		* cache of load errors
		*/
		#errCache = new Map();
		/**
		* Reads and parses contents of a `package.json` file at a directory `dir`.
		* `reload` will optionally skip reading from the cache when set to `true`.
		*/
		read(dir, { reload } = {}) {
		const cachedPackageJson = !reload && this.#cache.get(dir);
		if (cachedPackageJson) {
		return cachedPackageJson;
		}
		const filename = dir.endsWith('package.json') ?
		resolve(dir)
		: resolve(dir, 'package.json');
		const fail = (err) => error('Could not read package.json file', err, this.read);
		const cachedError = !reload && this.#errCache.get(dir);
		if (cachedError) {
		throw fail(cachedError);
		}
		try {
		const res = normalizeManifest(asManifest(parse(readFileSync(filename, { encoding: 'utf8' }))));
		this.#cache.set(dir, res);
		this.#pathCache.set(res, dir);
		return res;
		}
		catch (err) {
		const ec = {
		path: filename,
		cause: err,
		};
		this.#errCache.set(dir, ec);
		throw fail(ec);
		}
		}
		/**
		* Optionally reads and parses contents of a `package.json` file at a
		* directory `dir`. Returns `undefined` if it could not be read.
		*/
		maybeRead(dir, { reload } = {}) {
		try {
		return this.read(dir, { reload });
		}
		catch {
		return undefined;
		}
		}
		write(dir, manifest, indent) {
		const filename = dir.endsWith('package.json') ?
		resolve(dir)
		: resolve(dir, 'package.json');
		this.fix(manifest);
		try {
		// This assumes kIndent and kNewline are already present on the manifest because we would
		// only write a package.json after reading it which will set those properties.
		writeFileSync(filename, stringify(manifest, undefined, indent));
		this.#cache.set(dir, manifest);
		this.#pathCache.set(manifest, dir);
		}
		catch (err) {
		// If there was an error writing to this package.json then also delete it from our cache
		// just in case a future read would get stale data.
		this.#cache.delete(dir);
		this.#pathCache.delete(manifest);
		throw error('Could not write package.json file', {
		path: filename,
		cause: err,
		}, this.write);
		}
		}
		save(manifest) {
		const dir = this.#pathCache.get(manifest);
		if (!dir) {
		throw error('Could not save manifest', {
		manifest,
		}, this.save);
		}
		this.write(dir, manifest);
		}
		fix(manifest) {
		for (const depType of longDependencyTypes) {
		const deps = manifest[depType];
		if (deps) {
		// should sort dependencies by name
		manifest[depType] = Object.fromEntries(Object.entries(deps).sort(([a], [b]) => a.localeCompare(b, 'en')));
		}
		}
		}
		/**
		* Walks up the directory tree from the current working directory
		* and returns the path to the first `package.json` file found.
		* Returns undefined if no package.json is found.
		*/
		find(cwd = process.cwd(), home = homedir()) {
		for (const dir of walkUp(cwd)) {
		// don't look in home directory
		if (dir === home)
		break;
		const packageJsonPath = resolve(dir, 'package.json');
		if (exists(packageJsonPath)) {
		return packageJsonPath;
		}
		}
		}
		}
		//# sourceMappingURL=index.js.map

+1

dist/index.js.map

+5

-19

package.json

		{
		"name": "@vltpkg/package-json",
		"description": "Manage reading package.json files",
		"version": "1.0.0-rc.10",
		"version": "1.0.0-rc.11",
		"repository": {
		@@ -11,18 +11,7 @@ "type": "git",
		"author": "vlt technology inc. <support@vlt.sh> (http://vlt.sh)",
		"tshy": {
		"selfLink": false,
		"liveDev": true,
		"dialects": [
		"esm"
		],
		"exports": {
		"./package.json": "./package.json",
		".": "./src/index.ts"
		}
		},
		"dependencies": {
		"polite-json": "^5.0.0",
		"walk-up-path": "^4.0.0",
		"@vltpkg/error-cause": "1.0.0-rc.10",
		"@vltpkg/types": "1.0.0-rc.10"
		"@vltpkg/error-cause": "1.0.0-rc.11",
		"@vltpkg/types": "1.0.0-rc.11"
		},
		@@ -35,3 +24,2 @@ "devDependencies": {
		"tap": "^21.5.0",
		"tshy": "^3.1.0",
		"typedoc": "~0.27.9",
		@@ -49,3 +37,3 @@ "typescript": "5.7.3",
		"prettier": "../../.prettierrc.js",
		"module": "./dist/esm/index.js",
		"module": "./dist/index.js",
		"type": "module",
		@@ -56,4 +44,3 @@ "exports": {
		"import": {
		"types": "./dist/esm/index.d.ts",
		"default": "./dist/esm/index.js"
		"default": "./dist/index.js"
		}
		@@ -73,5 +60,4 @@ }
		"posttest": "tsc --noEmit",
		"tshy": "tshy",
		"typecheck": "tsc --noEmit"
		}
		}

-28

dist/esm/index.d.ts

		import type { NormalizedManifest } from '@vltpkg/types';
		export declare class PackageJson {
		#private;
		/**
		* Reads and parses contents of a `package.json` file at a directory `dir`.
		* `reload` will optionally skip reading from the cache when set to `true`.
		*/
		read(dir: string, { reload }?: {
		reload?: boolean;
		}): NormalizedManifest;
		/**
		* Optionally reads and parses contents of a `package.json` file at a
		* directory `dir`. Returns `undefined` if it could not be read.
		*/
		maybeRead(dir: string, { reload }?: {
		reload?: boolean;
		}): NormalizedManifest \| undefined;
		write(dir: string, manifest: NormalizedManifest, indent?: number): void;
		save(manifest: NormalizedManifest): void;
		fix(manifest: NormalizedManifest): void;
		/**
		* Walks up the directory tree from the current working directory
		* and returns the path to the first `package.json` file found.
		* Returns undefined if no package.json is found.
		*/
		find(cwd?: string, home?: string): string \| undefined;
		}
		//# sourceMappingURL=index.d.ts.map

-1

dist/esm/index.d.ts.map

{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAgBvD,qBAAa,WAAW;;IAgBtB;;;OAGG;IACH,IAAI,CACF,GAAG,EAAE,MAAM,EACX,EAAE,MAAM,EAAE,GAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAO,GACpC,kBAAkB;IAsCrB;;;OAGG;IACH,SAAS,CACP,GAAG,EAAE,MAAM,EACX,EAAE,MAAM,EAAE,GAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAA;KAAO,GACpC,kBAAkB,GAAG,SAAS;IAQjC,KAAK,CACH,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,kBAAkB,EAC5B,MAAM,CAAC,EAAE,MAAM,GACd,IAAI;IA6BP,IAAI,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAcxC,GAAG,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAcvC;;;;OAIG;IACH,IAAI,CACF,GAAG,GAAE,MAAsB,EAC3B,IAAI,GAAE,MAAkB,GACvB,MAAM,GAAG,SAAS;CAWtB"}

-132

dist/esm/index.js

		import { error } from '@vltpkg/error-cause';
		import { asManifest, longDependencyTypes, normalizeManifest, } from '@vltpkg/types';
		import { readFileSync, writeFileSync, lstatSync } from 'node:fs';
		import { resolve } from 'node:path';
		import { homedir } from 'node:os';
		import { parse, stringify } from 'polite-json';
		import { walkUp } from 'walk-up-path';
		const exists = (path) => {
		try {
		lstatSync(path);
		return true;
		}
		catch {
		return false;
		}
		};
		export class PackageJson {
		/**
		* cache of `package.json` loads
		*/
		#cache = new Map();
		/**
		* cache of `package.json` paths by manifest
		*/
		#pathCache = new Map();
		/**
		* cache of load errors
		*/
		#errCache = new Map();
		/**
		* Reads and parses contents of a `package.json` file at a directory `dir`.
		* `reload` will optionally skip reading from the cache when set to `true`.
		*/
		read(dir, { reload } = {}) {
		const cachedPackageJson = !reload && this.#cache.get(dir);
		if (cachedPackageJson) {
		return cachedPackageJson;
		}
		const filename = dir.endsWith('package.json') ?
		resolve(dir)
		: resolve(dir, 'package.json');
		const fail = (err) => error('Could not read package.json file', err, this.read);
		const cachedError = !reload && this.#errCache.get(dir);
		if (cachedError) {
		throw fail(cachedError);
		}
		try {
		const res = normalizeManifest(asManifest(parse(readFileSync(filename, { encoding: 'utf8' }))));
		this.#cache.set(dir, res);
		this.#pathCache.set(res, dir);
		return res;
		}
		catch (err) {
		const ec = {
		path: filename,
		cause: err,
		};
		this.#errCache.set(dir, ec);
		throw fail(ec);
		}
		}
		/**
		* Optionally reads and parses contents of a `package.json` file at a
		* directory `dir`. Returns `undefined` if it could not be read.
		*/
		maybeRead(dir, { reload } = {}) {
		try {
		return this.read(dir, { reload });
		}
		catch {
		return undefined;
		}
		}
		write(dir, manifest, indent) {
		const filename = dir.endsWith('package.json') ?
		resolve(dir)
		: resolve(dir, 'package.json');
		this.fix(manifest);
		try {
		// This assumes kIndent and kNewline are already present on the manifest because we would
		// only write a package.json after reading it which will set those properties.
		writeFileSync(filename, stringify(manifest, undefined, indent));
		this.#cache.set(dir, manifest);
		this.#pathCache.set(manifest, dir);
		}
		catch (err) {
		// If there was an error writing to this package.json then also delete it from our cache
		// just in case a future read would get stale data.
		this.#cache.delete(dir);
		this.#pathCache.delete(manifest);
		throw error('Could not write package.json file', {
		path: filename,
		cause: err,
		}, this.write);
		}
		}
		save(manifest) {
		const dir = this.#pathCache.get(manifest);
		if (!dir) {
		throw error('Could not save manifest', {
		manifest,
		}, this.save);
		}
		this.write(dir, manifest);
		}
		fix(manifest) {
		for (const depType of longDependencyTypes) {
		const deps = manifest[depType];
		if (deps) {
		// should sort dependencies by name
		manifest[depType] = Object.fromEntries(Object.entries(deps).sort(([a], [b]) => a.localeCompare(b, 'en')));
		}
		}
		}
		/**
		* Walks up the directory tree from the current working directory
		* and returns the path to the first `package.json` file found.
		* Returns undefined if no package.json is found.
		*/
		find(cwd = process.cwd(), home = homedir()) {
		for (const dir of walkUp(cwd)) {
		// don't look in home directory
		if (dir === home)
		break;
		const packageJsonPath = resolve(dir, 'package.json');
		if (exists(packageJsonPath)) {
		return packageJsonPath;
		}
		}
		}
		}
		//# sourceMappingURL=index.js.map

-1

dist/esm/index.js.map

-3

dist/esm/package.json

		{
		"type": "module"
		}

@vltpkg/package-json - npm Package Compare versions

New alerts

Improved metrics

Worsened metrics

Dependency changes