Escapable commas in CLI options?
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- typescript
- Área
- cli
Línea de trabajo
Comienza con las definiciones de --ignore y el flujo de análisis en packages/react-docgen-cli/src/commands/parse/command.ts; después, compáralos con los typings del analizador de argumentos de Commander en las líneas enlazadas de typings/index.d.ts. Determina cómo se deben habilitar las comas escapadas sin cambiar la división actual por comas y verifica que --ignore acepte valores que contengan comas, mientras que los valores ordinarios conserven su comportamiento actual.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.replaceAllcould be used instead.subStr.replaceAll(ESCAPED_DELIMETER, DELIMETER))
- perform the replacement in fewer operations / general performance improvement
- Lenguaje dominante
- TypeScript
- Estrellas
- 3.8k
- Forks
- 316
- Merge medio
- 5 h 7 min
- PR fusionados (30 d)
- 4
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 reactjs/react-docgen
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
reactjs/react-docgen#1102 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
reactjs/react-docgen#1134 ·
-
Typescript Status Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
reactjs/react-docgen#1005 · 4 reacciones ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
reactjs/react-docgen#997 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 42/100
reactjs/react-docgen#994 · 1 comentario ·
Todos los issues de reactjs/react-docgen
Issues similares
-
Type/Bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
OpenNSW/nsw-srilanka#497 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
0xMiden/bridge-portal#132 ·
-
react-doctor severity:warning tech-debt
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
digidem/comapeo-cloud-app#403 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100