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: rename Dictionary.fromConfig() to Dictionary.fromEnv()

Browse Source
This commit is contained in:
Jeff Williams 2024-12-07 14:30:05 -08:00
parent ac9ea1a172
commit 3652d69bc5
No known key found for this signature in database
5 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/jsdoc-core/lib/api.js
View File

@ -179,7 +179,7 @@ export default class Api {
let packageDocs;
let docletStore;
this.env.tags = Dictionary.fromConfig(this.env);
this.env.tags = Dictionary.fromEnv(this.env);
parser = await this.#createParser();
docletStore = parser.parse(filepaths ?? this.env.sourceFiles, options.encoding);

11
packages/jsdoc-tag/lib/dictionary.js
View File

@ -103,11 +103,10 @@ export class Dictionary {
this._tagSynonyms[synonym.toLowerCase()] = this.normalize(title);
}
static fromConfig(deps) {
static fromEnv(env) {
const dict = new Dictionary();
const env = deps.get('env');
const log = deps.get('log');
let dictionaries = env.conf.tags.dictionaries;
const { conf, log } = env;
let dictionaries = conf.tags.dictionaries;
let tagDefs;
if (!dictionaries) {
@ -121,7 +120,7 @@ export class Dictionary {
.reverse()
.forEach((dictName) => {
try {
tagDefs = definitions[DEFINITIONS[dictName]](deps);
tagDefs = definitions[DEFINITIONS[dictName]](env);
} catch (e) {
log.error(
'The configuration setting "tags.dictionaries" contains ' +
@ -134,7 +133,7 @@ export class Dictionary {
dict.defineTags(tagDefs);
});
dict.defineTags(definitions.getInternalTags(deps));
dict.defineTags(definitions.getInternalTags());
}
return dict;

14
packages/jsdoc-tag/test/specs/lib/dictionary.js
View File

@ -131,7 +131,7 @@ describe('@jsdoc/tag/lib/dictionary', () => {
function defineTags() {
env.conf.tags.dictionaries = undefined;
jsdoc.env = env;
Dictionary.fromConfig(jsdoc.deps);
Dictionary.fromEnv(jsdoc.env);
}
expect(jsdoc.didLog(defineTags, 'error')).toBeTrue();
@ -141,7 +141,7 @@ describe('@jsdoc/tag/lib/dictionary', () => {
function defineTags() {
env.conf.tags.dictionaries = ['jsmarmoset'];
jsdoc.env = env;
Dictionary.fromConfig(jsdoc.deps);
Dictionary.fromEnv(jsdoc.env);
}
expect(jsdoc.didLog(defineTags, 'error')).toBeTrue();
@ -150,7 +150,7 @@ describe('@jsdoc/tag/lib/dictionary', () => {
it('adds both JSDoc and Closure tags by default', () => {
env.conf.tags.dictionaries = dictionaryConfig.slice();
jsdoc.env = env;
testDictionary = Dictionary.fromConfig(jsdoc.deps);
testDictionary = Dictionary.fromEnv(jsdoc.env);
expect(testDictionary.lookup(JSDOC_TAGNAME)).toBeObject();
expect(testDictionary.lookup(CLOSURE_TAGNAME)).toBeObject();
@ -159,7 +159,7 @@ describe('@jsdoc/tag/lib/dictionary', () => {
it('adds only the JSDoc tags if requested', () => {
env.conf.tags.dictionaries = ['jsdoc'];
jsdoc.env = env;
testDictionary = Dictionary.fromConfig(jsdoc.deps);
testDictionary = Dictionary.fromEnv(jsdoc.env);
expect(testDictionary.lookup(JSDOC_TAGNAME)).toBeObject();
expect(testDictionary.lookup(CLOSURE_TAGNAME)).toBeFalse();
@ -168,7 +168,7 @@ describe('@jsdoc/tag/lib/dictionary', () => {
it('adds only the Closure tags if requested', () => {
env.conf.tags.dictionaries = ['closure'];
jsdoc.env = env;
testDictionary = Dictionary.fromConfig(jsdoc.deps);
testDictionary = Dictionary.fromEnv(jsdoc.env);
expect(testDictionary.lookup(JSDOC_TAGNAME)).toBeFalse();
expect(testDictionary.lookup(CLOSURE_TAGNAME)).toBeObject();
@ -177,7 +177,7 @@ describe('@jsdoc/tag/lib/dictionary', () => {
it('prefers tagdefs from the first dictionary on the list', () => {
env.conf.tags.dictionaries = ['closure', 'jsdoc'];
jsdoc.env = env;
testDictionary = Dictionary.fromConfig(jsdoc.deps);
testDictionary = Dictionary.fromEnv(jsdoc.env);
expect(testDictionary.lookup('deprecated').synonyms).not.toBeDefined();
});
@ -185,7 +185,7 @@ describe('@jsdoc/tag/lib/dictionary', () => {
it('adds tag synonyms', () => {
env.conf.tags.dictionaries = ['jsdoc'];
jsdoc.env = env;
testDictionary = Dictionary.fromConfig(jsdoc.deps);
testDictionary = Dictionary.fromEnv(jsdoc.env);
expect(testDictionary.lookup('extends')).toBeObject();
expect(testDictionary.normalize('extends')).toBe('augments');

4
packages/jsdoc/test/helpers/jsdoc.js
View File

@ -90,13 +90,13 @@ const helpers = {
}
config.tags.dictionaries = dictionaryNames;
jsdoc.env.tags = Dictionary.fromConfig(jsdoc.env);
jsdoc.env.tags = Dictionary.fromEnv(jsdoc.env);
},
restoreTagDictionary: () => {
const { config } = jsdoc.env;
config.tags.dictionaries = originalDictionaries.slice();
jsdoc.env.tags = Dictionary.fromConfig(jsdoc.env);
jsdoc.env.tags = Dictionary.fromEnv(jsdoc.env);
},
};

2
packages/jsdoc/test/index.js
View File

@ -57,7 +57,7 @@ export default function test() {
});
env.conf = DEFAULT_CONFIG;
env.tags = Dictionary.fromConfig(env);
env.tags = Dictionary.fromEnv(env);
// Make JSDoc environment available to all tests.
if (!global.jsdoc) {
global.jsdoc = {};