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

Document commands, their usage and documentation consistency #356

Open
1 of 4 tasks
BobbieGoede opened this issue Sep 12, 2024 · 0 comments
Open
1 of 4 tasks

Document commands, their usage and documentation consistency #356

BobbieGoede opened this issue Sep 12, 2024 · 0 comments

Comments

@BobbieGoede
Copy link
Member

BobbieGoede commented Sep 12, 2024

Besides the --help output, we don't really have a place that actually documents the commands provided by nuxt-module-build, and it seems like the things that are documented are a bit fragmented/inconsistent.

  • 1. In the readme package.json example, the deprecated implicit build usage is shown https://github.com/nuxt/module-builder#packagejson.

  • 2. Using nuxi build-module will always log a warning to specify the build command explicitly, but passing the build argument actually does not work (not sure if local issue).

  • 3. The stub argument is hinted at in the documentation for nuxi build-module (https://nuxt.com/docs/api/commands/build-module), but its function/purpose is not actually described.

  • 4. The module starter uses nuxt-module-build prepare which seems to do similar things to the nuxt-module-build build --stub according to its description.

I can fix point 1 and maybe point 2, but for 3 and 4 I'm honestly not sure 😅

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

No branches or pull requests

1 participant