uber/piranha

PiranhaObjC: Use properties.json to specify configuration properties

Offen

#51 geöffnet am 15.06.2020

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Java (178 Forks)batch import
enhancementgood first issuehelp wantedlegacy-objc

Repository-Metriken

Stars
 (2.143 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfen Sie die aktuellen hartcodierten API Definitionen in https://github.com/uber/piranha/blob/master/objc/src/XPFlagRefactoring/XPFlagRefactoring.cpp#L40. Untersuchen Sie, wie eine JSON Datei (properties.json) geparst werden kann, die ein Array von methodProperties Objekten mit den Feldern methodName, flagType, returnType und argumentIndex enthält. Untersuchen Sie vorhandene JSON Parsing Bibliotheken im Projekt oder ziehen Sie die Verwendung eines schlanken C++ JSON Parsers in Betracht. Ersetzen Sie nach dem Parsen die hartcodierten Aufrufe durch die dynamisch geladenen Eigenschaften. Das Issue hat einen Kommentar, aber keine kürzliche Maintainer Aktivität; es könnte davon profitieren, die erwartete JSON Struktur und Integrationspunkte zu klären.
Tech Stack
objective ccpp
Domain
toolingapi
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JSONC++Objective C
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50