1
0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-22 10:21:36 +03:00
Ghost/ghost/package-json/lib/parse.js
Hannah Wolfe 1daa6eda61 Improved typing in package-json
- fixed type warnings
- introduced explicit use of bluebird to help with type warnings and also make it clear when we're actually using Bluebird features
2021-06-09 15:44:04 +01:00

61 lines
1.7 KiB
JavaScript

const fs = require('fs-extra');
const errors = require('@tryghost/errors');
const tpl = require('@tryghost/tpl');
const messages = {
couldNotReadPackage: 'Could not read package.json file',
nameOrVersionMissing: '"name" or "version" is missing from theme package.json file.',
willBeRequired: 'This will be required in future. Please see {url}',
themeFileIsMalformed: 'Theme package.json file is malformed'
};
/**
* Parse package.json and validate it has
* all the required fields
*
* @param {string} path
* @returns {Promise<object>}
*/
async function parse(path) {
let source;
let json;
try {
source = await fs.readFile(path, {encoding: 'utf8'});
} catch (readError) {
const err = new errors.IncorrectUsageError();
err.message = tpl(messages.couldNotReadPackage);
err.context = path;
err.err = readError;
return Promise.reject(err);
}
try {
json = JSON.parse(source);
} catch (parseError) {
const err = new errors.IncorrectUsageError();
err.message = tpl(messages.themeFileIsMalformed);
err.context = path;
err.err = parseError;
err.help = tpl(messages.willBeRequired, {url: 'https://ghost.org/docs/themes/'});
return Promise.reject(err);
}
const hasRequiredKeys = json.name && json.version;
if (!hasRequiredKeys) {
const err = new errors.IncorrectUsageError();
err.message = tpl(messages.nameOrVersionMissing);
err.context = path;
err.help = tpl(messages.willBeRequired, {url: 'https://ghost.org/docs/themes/'});
return Promise.reject(err);
}
return json;
}
module.exports = parse;