mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-03 23:00:14 -05:00
63642fd8ad
closes #9528 These code changes introduce a YAML parser which will load and parse YAML files from the `/content/settings` directory. There are three major parts involved: 1. `ensure-settings.js`: this fn takes care that on bootstrap, the supported files are present in the `/content/settings` directory. If the files are not present, they get copied back from our default files. The default files to copy from are located in `core/server/services/settings`. 2. `loader.js`: the settings loader reads the requested `yaml` file from the disk and passes it to the yaml parser, which returns a `json` object of the file. The settings loader throws an error, if the file is not accessible, e. g. because of permission errors. 3. `yaml-parser`: gets passed a `yaml` file and returns a `json` object. If the file is not parseable, it returns a clear error that contains the information, what and where the parsing error occurred (e. g. line number and reason). - added a `get()` fn to settings services, that returns the settings object that's asked for. e. g. `settings.get('routes').then(()...` will return the `routes` settings. - added a `getAll()` fn to settings services, that returns all available settings in an object. The object looks like: `{routes: {routes: {}, collections: {}, resources: {}}, globals: {value: {}}`, assuming that we have to supported settings `routes` and `globals`. Further additions: - config `contentPath` for `settings` - config overrides for default `yaml` files location in `/core/server/services/settings` **Important**: These code changes are in preparation for Dynamic Routing and not yet used. The process of copying the supported `yaml` files (in this first step, the `routes.yaml` file) is not yet activated.
41 lines
1.4 KiB
JavaScript
41 lines
1.4 KiB
JavaScript
'use strict';
|
|
|
|
const fs = require('fs-extra'),
|
|
path = require('path'),
|
|
debug = require('ghost-ignition').debug('services:settings:settings-loader'),
|
|
common = require('../../lib/common'),
|
|
config = require('../../config'),
|
|
yamlParser = require('./yaml-parser');
|
|
|
|
/**
|
|
* Reads the desired settings YAML file and passes the
|
|
* file to the YAML parser which then returns a JSON object.
|
|
* @param {String} setting the requested settings as defined in setting knownSettings
|
|
* @returns {Promise<Object>} settingsFile
|
|
*/
|
|
module.exports = function loadSettings(setting) {
|
|
// we only support the `yaml` file extension. `yml` will be ignored.
|
|
const fileName = `${setting}.yaml`;
|
|
const contentPath = config.getContentPath('settings');
|
|
const filePath = path.join(contentPath, fileName);
|
|
|
|
return fs.readFile(filePath, 'utf8')
|
|
.then((file) => {
|
|
debug('settings file found for', setting);
|
|
|
|
// yamlParser returns a JSON object
|
|
const parsed = yamlParser(file, fileName);
|
|
|
|
return parsed;
|
|
}).catch((error) => {
|
|
if (common.errors.utils.isIgnitionError(error)) {
|
|
throw error;
|
|
}
|
|
|
|
throw new common.errors.GhostError({
|
|
message: common.i18n.t('errors.services.settings.loader', {setting: setting, path: contentPath}),
|
|
context: filePath,
|
|
err: error
|
|
});
|
|
});
|
|
};
|