History

Fabien "egg" O'Carroll 104f84f252 Added eslint rule for file naming convention As discussed with the product team we want to enforce kebab-case file names for all files, with the exception of files which export a single class, in which case they should be PascalCase and reflect the class which they export. This will help find classes faster, and should push better naming for them too. Some files and packages have been excluded from this linting, specifically when a library or framework depends on the naming of a file for the functionality e.g. Ember, knex-migrator, adapter-manager		2023-05-09 12:34:34 -04:00
..
lib	Added eslint rule for file naming convention	2023-05-09 12:34:34 -04:00
test	Added getBackupFilePath to settings-path-manager module	2021-09-30 20:14:21 +02:00
.eslintrc.js	Added settings-path-manager module	2021-09-30 19:22:09 +02:00
index.js	Added eslint rule for file naming convention	2023-05-09 12:34:34 -04:00
package.json	Update dependency date-fns to v2.30.0	2023-05-01 15:00:19 +02:00
README.md	Tidied up package README and LICENSE files	2022-07-26 15:22:10 +02:00

README.md

Settings Path Manager

A library which helps locating configuration paths in Ghost. For example configs for dynamic routes or redirects.

Usage

Example use in to create routes.yaml configuration files:

const config = require('../shared/config'); // or whatever place the storage folders are configured at

const settingsPathManager = new SettingsPathManager({
    type: 'routes',
    paths: [config.getContentPath('settings')]
});

const filePath = settingsPathManager.getDefaultFilePath();

console.log(config.getContentPath('settings')); // -> '/content/data/'
console.log(filePath); // -> '/content/data/routes.yaml'