uber/piranha

PiranhaObjC: Use properties.json to specify configuration properties

Aperta

#51 aperta il 15 giu 2020

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Java (178 fork)batch import
enhancementgood first issuehelp wantedlegacy-objc

Metriche repository

Star
 (2143 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Currently PiranhaObjC APIs are hardcoded. See here. Introduce a configuration json file that contains an array of methodProperties with methodName, flagType, returnType and argumentIndex. See below.

{ "methodProperties": [ { "methodName": "isToggleEnabled", "flagType": "treated", "returnType": "boolean", "argumentIndex": 0 }, ... ], }

This properties file will be parsed and the listed APIs will be used for refactoring.

Guida contributor

Direzione di ricerca
Rivedere le definizioni API attualmente hardcoded in https://github.com/uber/piranha/blob/master/objc/src/XPFlagRefactoring/XPFlagRefactoring.cpp#L40. Indagare su come analizzare un file JSON (properties.json) contenente un array di oggetti methodProperties con i campi methodName, flagType, returnType e argumentIndex. Esaminare le librerie di parsing JSON esistenti nel progetto o considerare l'uso di un parser JSON C++ leggero. Dopo il parsing, sostituire le chiamate hardcoded con le proprietà caricate dinamicamente. L'issue ha un commento ma nessuna attività recente del maintainer; potrebbe trarre beneficio dal chiarire la struttura JSON prevista e i punti di integrazione.
Tech stack
objective ccpp
Dominio
toolingapi
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JSONC++Objective C
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50