nuxt / nuxt/module-builder

Document commands, their usage and documentation consistency

Open
#356 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
TypeScript
Stars
275
Forks
35
Avg merge
4h 42m
Merged PRs (30d)
6

Description

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 😅

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README package.json example and the linked nuxi build-module documentation, then compare the module starter's nuxt-module-build prepare usage with the documented build --stub behavior. Confirm the command behavior before updating the command documentation, describing stub and prepare, and resolving the listed consistency issues.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxt
Domain
build-system, cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.