callstack / callstack/component-docs

Unknown argument error when executing CLI with pages glob

Aperta
#48 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
TypeScript
Stelle
141
Fork
12
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## Environment

- MacOS 10.15.7
- zsh shell
- Node.js 12.18.4
- yarn 1.22.5

## Description

When I worked on [this PR](https://github.com/callstack/linaria/pull/320), and upgraded component-docs to then-latest version 0.23.0, I notice that the npm script `component-docs serve "docs/*.{md,mdx}"` now return this error:

```
$ component-docs serve "docs/*.{md,mdx}"
...
Unknown argument: docs/*.{md,mdx}
```

Event after recent update to 0.24.0, the issue still persists, so I have to resort to component-docs.config.js to define the pages collection.

If pages glob argument is no longer supported in recent update, I think it should be reflected in README to avoid confusion.

## Reproducible Demo

Just run below command and observe the error:

```
npx component-docs serve "example/**/*.md"
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dal punto di ingresso della CLI `component-docs serve` e ispeziona i riferimenti correlati in README e `component-docs.config.js`. Riproduci il problema con `npx component-docs serve "example/**/*.md"`; il lavoro è completato quando il comportamento del glob è stato corretto oppure il README spiega chiaramente la configurazione necessaria.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
node.js, typescript
Ambito
cli, documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.