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

docs: update README and add JSDoc #212

Closed
wants to merge 5 commits into from
Closed

Conversation

ineshbose
Copy link

@ineshbose ineshbose commented Dec 16, 2024

Also adds createDefineConfig, so we could close #84.

Additionally, the last commit is an addition to improve DX (that I believe Nuxt core/Content3 and possibly TW/i18n modules can also benefit from) - but I'm OK to leave it out as well. (let me write a quick test for this btw)

@@ -104,81 +112,7 @@ c12 merged config sources with [unjs/defu](https://github.com/unjs/defu) by belo

## Options

### `cwd`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be kept.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would maintaining JSDoc not more beneficial?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have automd generator for jsdocs. (see ufo for example is using it)

For c12, I am happy with current manual readme to have additional docs. We might in the future use jsdocs to auto maintain readme but not for now.

@@ -108,6 +113,11 @@ export async function loadConfig<
});
}

if (options.globalDefineConfigFn) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please seperate it it new PR

@pi0
Copy link
Member

pi0 commented Dec 16, 2024

Thanks but please create separate PRs 🙏🏼

@pi0 pi0 closed this Dec 16, 2024
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.

Document createDefineConfig
2 participants