Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweaked config.js to parse config passed into jsdoc-vuejs correctly. #204

Merged
merged 3 commits into from
Mar 27, 2019
Merged

Tweaked config.js to parse config passed into jsdoc-vuejs correctly. #204

merged 3 commits into from
Mar 27, 2019

Conversation

nealormsbee
Copy link
Contributor

@nealormsbee nealormsbee commented Mar 27, 2019

config.js was checking for the jsdoc-vuejs config against jsdoc/env, but configs are stored under jsdoc/env's conf property. So the jsdoc-vuejs template property was never picked up, and always fell back to the default jsdoc template.

@nealormsbee nealormsbee reopened this Mar 27, 2019
@Kocal
Copy link
Owner

Kocal commented Mar 27, 2019

What was the issue? 🤔

@nealormsbee
Copy link
Contributor Author

No issue so long as the template field of the jsdoc config file has the desired template.

But

const config = require('jsdoc/env');
const getTemplatePath = require('./lib/core/getTemplatePath');

config['jsdoc-vuejs'] = config['jsdoc-vuejs'] || {};

will always yield config['jsdoc-vuejs'] === {}, because the jsdoc env will never have a top-level jsdoc-vuejs key. It is always nested under conf.

There's no immediate issue with the tool, because the template option is picked up from the top-level config. But presumably you'll want to add things to the conf later and have them get picked up.

@Kocal
Copy link
Owner

Kocal commented Mar 27, 2019

Oh okay, I understand.

I will just wait for both AppVeyor and Travis and I will merge+release :)

@Kocal
Copy link
Owner

Kocal commented Mar 27, 2019

Well, forgot about AppVeyor... 😅

Repository owner deleted a comment from codecov-io Mar 27, 2019
@Kocal
Copy link
Owner

Kocal commented Mar 27, 2019

Aaaaah it's so looooong, I'm merging the PR and a release will come soon

image

@Kocal Kocal merged commit 038f730 into Kocal:master Mar 27, 2019
Kocal pushed a commit that referenced this pull request Mar 27, 2019
* Tweaked config.js to parse config passed into jsdoc-vuejs correctly.

* Adjusted to fix linting error

* chore(appveyor): don't record Cypress tests anymore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants