reactjs / reactjs/react-docgen

Escapable commas in CLI options?

Aperta
#962 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
3.8k
Fork
316
Merge medio
5h 7m
PR unite (30g)
4

Descrizione

The commander argument parser for the --ignore option:
https://github.com/reactjs/react-docgen/blob/f5d644a3041c227c4889059e787fcbaab57ec70e/packages/react-docgen-cli/src/commands/parse/command.ts#L26-L39
https://github.com/reactjs/react-docgen/blob/f5d644a3041c227c4889059e787fcbaab57ec70e/packages/react-docgen-cli/src/commands/parse/command.ts#L62-L67

... splits on a comma, which makes it impossible to use glob brace expansion for this option or commas in general for any option that also uses this argument parser.


Would supporting escapable commas be possible?


To avoid breaking changes you may need to make it opt-in (behind a new option --comma-escaping or similar.)

The problem seems common enough and has been solved different ways in different languages. Here is a rough first pass after a little (very little) research:

/**
 * Split on commas (","), unless they are escaped with a backslash("\,").
 *
 * Escaped commas are replaced with individual commas.
 */
export function splitOnComma(str: string): string[] {
  if (typeof str !== 'string') {
    const errorMessage = 'input must be a string'
    throw new TypeError(errorMessage)
  }
  const DELIMETER = ','
  const ESCAPE_CHAR = '\\'
  const ESCAPED_DELIMETER = ESCAPE_CHAR + DELIMETER
  const hasEscapedDelimeter = str.includes(ESCAPED_DELIMETER)

  // Negative Lookbehind: https://www.regular-expressions.info/lookaround.html
  const result = str.split(/,(?<!\\,)/)

  if (hasEscapedDelimeter) {
    return result.map((subStr) => subStr.replace(/\\,/gi, DELIMETER))
  }
  return result
}

I don't have experience with negative lookbehinds. I wrote the example to favor being excessively self-documenting. Refinements could include:

  • improved error message
  • reducing the number of lines needed
  • adding unit tests
  • if the build tools are configured for ES2021+, String.prototype.replaceAll could be used instead.
    • subStr.replaceAll(ESCAPED_DELIMETER, DELIMETER))
  • perform the replacement in fewer operations / general performance improvement

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalle definizioni di --ignore e dal flusso di parsing in packages/react-docgen-cli/src/commands/parse/command.ts, quindi confrontali con i typings dell’argument parser di Commander nelle righe collegate di typings/index.d.ts. Determina come abilitare le virgole con escape senza modificare la suddivisione esistente sulle virgole e verifica che --ignore accetti valori contenenti virgole, mentre i valori ordinari mantengano il comportamento attuale.

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

Valutazione

Stack tecnologico
typescript
Ambito
cli
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.