google/closure-compiler

Add an @pure annotation

Open

#2.395 geöffnet am 31. März 2017

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (1.197 Forks)batch import
feathelp wanted

Repository-Metriken

Stars
 (7.176 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 3T 4h) (1 gemergte PR in 30 T)

Beschreibung

I'd like to have an annotation to declare an intent that a function will not have side effects. In the presence of this annotation, I'd like the compiler to warn me if the function has side effects.

In a lot of code, you have simple helper methods that are intended to be side-effect free. It's very easy for a side effect to be accidentally introduced at a later time. I'd like to have a warning issued for this so the developer can correct it.

Contributor Guide

Research-Richtung
Untersuche, wie vorhandene Annotationen wie @const und @nosideeffects im Closure Compiler implementiert sind. Verstehe das Warnsystem und wie Nebenwirkungen erkannt werden. Entwerfe dann die @pure Annotation und die entsprechende Warnlogik.
Tech Stack
java
Domain
tooling
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
Javacompiler design
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40