LiquidDoc linters should report unused parameters
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Ambito
- tooling
Direzione di ricerca
Usa snippets/example.liquid come esempio comportamentale, quindi individua i controlli esistenti del linter LiquidDoc e il punto di ingresso che può ispezionare le chiamate agli snippet nell'intera codebase. Il lavoro è completo quando il nuovo controllo segnala i parametri documentati che non vengono mai passati, incluso il parametro style opzionale nell'esempio.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Is your feature request related to a problem? Please describe.
I would like to add a linter rule that detects parameters documented in Liquid files with {% doc %} that are never actually passed in any of the calls to the snippet across the codebase.
For example, consider this snippets/example.liquid:
{%- doc -%}
Renders a card for displaying various resource types (products, collections, articles, pages).
@param {object} resource - The resource to render
@param {string} [style] - The style of the card. Can be 'default' or 'overlay'
{%- enddoc -%}
...
This example has an optional style parameter, and there might be code related to it. However, if no one ever renders snippets/example.liquid with the style parameter, we should lint for it. This could be an opportunity to refactor and simplify snippets/example.liquid.
Describe the solution you'd like
I'd like a new linter check to cover the case described above.
- Lingua principale
- TypeScript
- Stelle
- 236
- Fork
- 100
- Merge medio
- 1g 18h
- PR unite (30g)
- 19
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Shopify/theme-tools
-
theme-graph CLI never calls getWebComponentMap, so custom-element references are never resolvedForse già presa @reginaldalfret l’ha presa 6 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
Shopify/theme-tools#1291 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
JSONMissingBlock false positive for app block when section supports both @app and @themeForse già presa @chippleh1392 l’ha presa 124 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
Shopify/theme-tools#1144 · 2 commenti · 8 reazioni ·
I maintainer di solito rispondono entro 1 giorno
-
HTML close-tag auto-insertion (`onTypeFormatting` on `>`) closes the wrong elementForse già presa @efegokdemir l’ha presa 4 giorni fa. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 38/100
Shopify/theme-tools#1327 ·
I maintainer di solito rispondono entro 1 giorno
-
theme-graph: parse failures silently produce an incomplete graph, causing false dead-code resultsForse già presa @efegokdemir l’ha presa 7 giorni fa. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
Shopify/theme-tools#1290 ·
I maintainer di solito rispondono entro 1 giorno
-
inserts extra ">" if: <label>text</label><textarea></textarea>Forse già presa @kwy404 l’ha presa 14 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
Shopify/theme-tools#1288 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di Shopify/theme-tools
Issue simili
-
chore v2
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
modelcontextprotocol/servers#5115 ·
I maintainer di solito rispondono entro 1 giorno
-
beginner bug good first issue
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
philaconvalley/website#168 ·
I maintainer di solito rispondono entro 1 giorno
-
bug frontend good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
oss-slu/lrda_mobile#294 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
hatchet-dev/hatchet#5179 ·
I maintainer di solito rispondono entro 1 giorno