Document commands, their usage and documentation consistency
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 38/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- nuxt
- Área
- build-system, cli, documentation
Línea de trabajo
Comienza con el ejemplo de README package.json y la documentación enlazada de nuxi build-module; después, compara el uso de nuxt-module-build prepare en el starter del módulo con el comportamiento documentado de build --stub. Confirma el comportamiento del comando antes de actualizar la documentación del comando, describir stub y prepare y resolver los problemas de coherencia indicados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.jsonexample, the deprecated implicit build usage is shown https://github.com/nuxt/module-builder#packagejson. -
2. Using
nuxi build-modulewill always log a warning to specify thebuildcommand explicitly, but passing thebuildargument 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 preparewhich seems to do similar things to thenuxt-module-build build --stubaccording to its description.
I can fix point 1 and maybe point 2, but for 3 and 4 I'm honestly not sure 😅
- Lenguaje dominante
- TypeScript
- Estrellas
- 276
- Forks
- 35
- Merge medio
- 2 h 46 min
- PR fusionados (30 d)
- 2
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de nuxt/module-builder
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
nuxt/module-builder#801 ·
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
nuxt/module-builder#764 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
nuxt/module-builder#754 ·
-
Conflict between folder structure in readme (src/runtime) and TypeScript config (src/module/runtime)Posiblemente ocupada @dword-design la tomó hace 140 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
nuxt/module-builder#749 ·
-
Tsdown/obuild migrationQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
nuxt/module-builder#726 · 1 comentario · 1 reacción ·
Todos los issues de nuxt/module-builder
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
phivk/rubiks-lab#33 ·
Los mantenedores suelen responder en 1 día
-
BUG:Edit Album strips spaces from the password so albums with a leading/trailing space in the password can't be editedPosiblemente ocupada @ManyaJain111 la tomó hoy. Abiertobug enhancement possible-duplicate
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
AOSSIE-Org/PictoPy#1637 · 4 comentarios ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
chaitin/MonkeyCode#1437 ·
Los mantenedores suelen responder en 1 día
-
rtdb-info-connected-order test: unhandled 'connection is closed' rejection fails the CLI suiteAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
area:cards enhancement migration ready-for-agent
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
fil-donadoni/tolaria#6309 ·
Los mantenedores suelen responder en 1 día