archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

refactor(jsdoc-core): rename default config object

Browse Source
This commit is contained in:
Jeff Williams 2023-12-27 12:09:18 -08:00
parent 5a6998bce7
commit 5b11762b35
No known key found for this signature in database
2 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
packages/jsdoc-core/lib/config.js
View File

@ -13,6 +13,7 @@
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* Manages configuration settings for JSDoc.
*
@ -25,7 +26,7 @@ import stripJsonComments from 'strip-json-comments';
const MODULE_NAME = 'jsdoc';
export const defaults = {
export const defaultConfig = {
// TODO(hegemonic): Integrate CLI options with other options.
opts: {
destination: './out',
@ -122,5 +123,5 @@ export async function load(filepath) {
loaded = (await explorer.search()) ?? {};
}
return new Config(loaded.filepath, _.defaultsDeep({}, loaded.config, defaults));
return new Config(loaded.filepath, _.defaultsDeep({}, loaded.config, defaultConfig));
}

31
packages/jsdoc-core/test/specs/lib/config.js
View File

@ -13,6 +13,7 @@
See the License for the specific language governing permissions and
limitations under the License.
*/
import mockFs from 'mock-fs'; // eslint-disable-line simple-import-sort/imports
import { defaultLoaders } from 'cosmiconfig';
@ -104,13 +105,13 @@ describe('@jsdoc/core/lib/config', () => {
const conf = await config.load();
expect(conf.config).toEqual(config.defaults);
expect(conf.config).toEqual(config.defaultConfig);
});
it('provides the default config if there is no user config', async () => {
const conf = await config.load();
expect(conf.config).toEqual(config.defaults);
expect(conf.config).toEqual(config.defaultConfig);
});
it('merges nested defaults with nested user settings as expected', async () => {
@ -120,68 +121,68 @@ describe('@jsdoc/core/lib/config', () => {
const conf = await config.load();
expect(conf.config.tags.allowUnknownTags).toBe(config.defaults.tags.allowUnknownTags);
expect(conf.config.tags.allowUnknownTags).toBe(config.defaultConfig.tags.allowUnknownTags);
expect(conf.config.tags.foo).toBe('bar');
});
});
describe('defaults', () => {
const { defaults } = config;
describe('defaultConfig', () => {
const { defaultConfig } = config;
it('is an object', () => {
expect(defaults).toBeObject();
expect(defaultConfig).toBeObject();
});
describe('plugins', () => {
it('is an array', () => {
expect(defaults.plugins).toBeArray();
expect(defaultConfig.plugins).toBeArray();
});
});
describe('sourceFiles', () => {
it('is an empty array', () => {
expect(defaults.sourceFiles).toBeEmptyArray();
expect(defaultConfig.sourceFiles).toBeEmptyArray();
});
});
describe('sourceType', () => {
it('is a string', () => {
expect(defaults.sourceType).toBeString();
expect(defaultConfig.sourceType).toBeString();
});
});
describe('tags', () => {
it('is an object', () => {
expect(defaults.tags).toBeObject();
expect(defaultConfig.tags).toBeObject();
});
describe('allowUnknownTags', () => {
it('is a boolean', () => {
expect(defaults.tags.allowUnknownTags).toBeBoolean();
expect(defaultConfig.tags.allowUnknownTags).toBeBoolean();
});
});
describe('dictionaries', () => {
it('is an array of strings', () => {
expect(defaults.tags.dictionaries).toBeArrayOfStrings();
expect(defaultConfig.tags.dictionaries).toBeArrayOfStrings();
});
});
});
describe('templates', () => {
it('is an object', () => {
expect(defaults.templates).toBeObject();
expect(defaultConfig.templates).toBeObject();
});
describe('cleverLinks', () => {
it('is a boolean', () => {
expect(defaults.templates.cleverLinks).toBeBoolean();
expect(defaultConfig.templates.cleverLinks).toBeBoolean();
});
});
describe('monospaceLinks', () => {
it('is a boolean', () => {
expect(defaults.templates.monospaceLinks).toBeBoolean();
expect(defaultConfig.templates.monospaceLinks).toBeBoolean();
});
});
});