devsite/node_modules/package-json-from-dist/dist/commonjs/index.js

124 lines
4.4 KiB
JavaScript
Raw Normal View History

2024-07-08 01:49:38 +00:00
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.loadPackageJson = exports.findPackageJson = void 0;
const node_fs_1 = require("node:fs");
const node_path_1 = require("node:path");
const node_url_1 = require("node:url");
const NM = `${node_path_1.sep}node_modules${node_path_1.sep}`;
const DIST = `${node_path_1.sep}dist${node_path_1.sep}`;
/**
* Find the package.json file, either from a TypeScript file somewhere not
* in a 'dist' folder, or a built and/or installed 'dist' folder.
*
* Note: this *only* works if you build your code into `'./dist'`, and that the
* source path does not also contain `'dist'`! If you don't build into
* `'./dist'`, or if you have files at `./src/dist/dist.ts`, then this will
* not work properly!
*
* The default `pathFromSrc` option assumes that the calling code lives one
* folder below the root of the package. Otherwise, it must be specified.
*
* Example:
*
* ```ts
* // src/index.ts
* import { findPackageJson } from 'package-json-from-dist'
*
* const pj = findPackageJson(import.meta.url)
* console.log(`package.json found at ${pj}`)
* ```
*
* If the caller is deeper within the project source, then you must provide
* the appropriate fallback path:
*
* ```ts
* // src/components/something.ts
* import { findPackageJson } from 'package-json-from-dist'
*
* const pj = findPackageJson(import.meta.url, '../../package.json')
* console.log(`package.json found at ${pj}`)
* ```
*
* When running from CommmonJS, use `__filename` instead of `import.meta.url`
*
* ```ts
* // src/index.cts
* import { findPackageJson } from 'package-json-from-dist'
*
* const pj = findPackageJson(__filename)
* console.log(`package.json found at ${pj}`)
* ```
*/
const findPackageJson = (from, pathFromSrc = '../package.json') => {
const f = typeof from === 'object' || from.startsWith('file://') ?
(0, node_url_1.fileURLToPath)(from)
: from;
const __dirname = (0, node_path_1.dirname)(f);
const nms = __dirname.lastIndexOf(NM);
if (nms !== -1) {
// inside of node_modules. find the dist directly under package name.
const nm = __dirname.substring(0, nms + NM.length);
const pkgDir = __dirname.substring(nms + NM.length);
const pkgName = pkgDir.startsWith('@') ?
pkgDir.split(node_path_1.sep).slice(0, 2).join(node_path_1.sep)
: String(pkgDir.split(node_path_1.sep)[0]);
return (0, node_path_1.resolve)(nm, pkgName, 'package.json');
}
else {
// see if we are in a dist folder.
const d = __dirname.lastIndexOf(DIST);
if (d !== -1) {
return (0, node_path_1.resolve)(__dirname.substring(0, d), 'package.json');
}
else {
return (0, node_path_1.resolve)(__dirname, pathFromSrc);
}
}
};
exports.findPackageJson = findPackageJson;
/**
* Load the package.json file, either from a TypeScript file somewhere not
* in a 'dist' folder, or a built and/or installed 'dist' folder.
*
* Note: this *only* works if you build your code into `'./dist'`, and that the
* source path does not also contain `'dist'`! If you don't build into
* `'./dist'`, or if you have files at `./src/dist/dist.ts`, then this will
* not work properly!
*
* The default `pathFromSrc` option assumes that the calling code lives one
* folder below the root of the package. Otherwise, it must be specified.
*
* Example:
*
* ```ts
* // src/index.ts
* import { loadPackageJson } from 'package-json-from-dist'
*
* const pj = loadPackageJson(import.meta.url)
* console.log(`Hello from ${pj.name}@${pj.version}`)
* ```
*
* If the caller is deeper within the project source, then you must provide
* the appropriate fallback path:
*
* ```ts
* // src/components/something.ts
* import { loadPackageJson } from 'package-json-from-dist'
*
* const pj = loadPackageJson(import.meta.url, '../../package.json')
* console.log(`Hello from ${pj.name}@${pj.version}`)
* ```
*
* When running from CommmonJS, use `__filename` instead of `import.meta.url`
*
* ```ts
* // src/index.cts
* import { loadPackageJson } from 'package-json-from-dist'
*
* const pj = loadPackageJson(__filename)
* console.log(`Hello from ${pj.name}@${pj.version}`)
* ```
*/
const loadPackageJson = (from, pathFromSrc = '../package.json') => JSON.parse((0, node_fs_1.readFileSync)((0, exports.findPackageJson)(from, pathFromSrc), 'utf8'));
exports.loadPackageJson = loadPackageJson;
//# sourceMappingURL=index.js.map