0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-03 23:00:14 -05:00
ghost/core/frontend/services/settings/yaml-parser.js
Hannah Wolfe 22e13acd65 Updated var declarations to const/let and no lists
- All var declarations are now const or let as per ES6
- All comma-separated lists / chained declarations are now one declaration per line
- This is for clarity/readability but also made running the var-to-const/let switch smoother
- ESLint rules updated to match

How this was done:

- npm install -g jscodeshift
- git clone https://github.com/cpojer/js-codemod.git
- git clone git@github.com:TryGhost/Ghost.git shallow-ghost
- cd shallow-ghost
- jscodeshift -t ../js-codemod/transforms/unchain-variables.js . -v=2
- jscodeshift -t ../js-codemod/transforms/no-vars.js . -v=2
- yarn
- yarn test
- yarn lint / fix various lint errors (almost all indent) by opening files and saving in vscode
- grunt test-regression
- sorted!
2020-04-29 16:51:13 +01:00

30 lines
1.2 KiB
JavaScript

const yaml = require('js-yaml');
const debug = require('ghost-ignition').debug('frontend:services:settings:yaml-parser');
const common = require('../../../server/lib/common');
/**
* Takes a YAML file, parses it and returns a JSON Object
* @param {YAML} file the YAML file utf8 encoded
* @param {String} fileName the name of the file incl. extension
* @returns {Object} parsed
*/
module.exports = function parseYaml(file, fileName) {
try {
const parsed = yaml.safeLoad(file);
debug('YAML settings file parsed:', fileName);
return parsed;
} catch (error) {
// CASE: parsing failed, `js-yaml` tells us exactly what and where in the
// `reason` property as well as in the message.
// As the file uploaded is invalid, the person uploading must fix this - it's a 4xx error
throw new common.errors.IncorrectUsageError({
message: common.i18n.t('errors.services.settings.yaml.error', {file: fileName, context: error.reason}),
code: 'YAML_PARSER_ERROR',
context: error.message,
err: error,
help: common.i18n.t('errors.services.settings.yaml.help', {file: fileName})
});
}
};