diff --git a/packages/jsdoc-core/lib/api.js b/packages/jsdoc-core/lib/api.js index 70d87222..5e9e029c 100644 --- a/packages/jsdoc-core/lib/api.js +++ b/packages/jsdoc-core/lib/api.js @@ -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); diff --git a/packages/jsdoc-tag/lib/dictionary.js b/packages/jsdoc-tag/lib/dictionary.js index 7119e735..d77d3ebd 100644 --- a/packages/jsdoc-tag/lib/dictionary.js +++ b/packages/jsdoc-tag/lib/dictionary.js @@ -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; diff --git a/packages/jsdoc-tag/test/specs/lib/dictionary.js b/packages/jsdoc-tag/test/specs/lib/dictionary.js index 7173dfca..9e4e9d71 100644 --- a/packages/jsdoc-tag/test/specs/lib/dictionary.js +++ b/packages/jsdoc-tag/test/specs/lib/dictionary.js @@ -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'); diff --git a/packages/jsdoc/test/helpers/jsdoc.js b/packages/jsdoc/test/helpers/jsdoc.js index 32ab9f39..05471829 100644 --- a/packages/jsdoc/test/helpers/jsdoc.js +++ b/packages/jsdoc/test/helpers/jsdoc.js @@ -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); }, }; diff --git a/packages/jsdoc/test/index.js b/packages/jsdoc/test/index.js index 5fd39f6b..43e9e31d 100644 --- a/packages/jsdoc/test/index.js +++ b/packages/jsdoc/test/index.js @@ -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 = {};