egoist/babel-plugin-markdown

Identify markdown by comments

Open

#4 aperta il 7 lug 2017

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)JavaScript (2 fork)user submission
enhancementhelp wanted

Metriche repository

Star
 (14 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

const html = `<!-- markdown -->
# hello
`

In this way eslint won't warn you about the undefined variable: markdown.

Guida contributor

Direzione di ricerca
Innanzitutto, esamina il codice sorgente del plugin (probabilmente index.js) per capire come attualmente rileva e trasforma il markdown nei file JavaScript. Quindi, implementa un controllo per i commenti HTML che contengono ' markdown ' (ad esempio `<! markdown >`) e tratta il contenuto all'interno come markdown. Rivedi i test esistenti nel repository per assicurarti che non ci siano regressioni. Considera se il rilevamento dei commenti dovrebbe essere configurabile. La modifica è localizzata ma richiede familiarità con la manipolazione dell'AST di Babel.
Tech stack
javascriptnodejs
Dominio
build system
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Richiede indagine
Prerequisiti
JavaScriptBabel
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50