intellij-rust/intellij-rust

Highlight unsafe operations inside `unsafe` blocks

Offen

#3.013 geöffnet am 05.11.2018

Auf GitHub ansehenContributor Guide
 (10 Kommentare) (5 Reaktionen) (0 zugewiesene Personen)Kotlin (376 Forks)batch import
E-mediumfeaturehelp wanted

Repository-Metriken

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

Beschreibung

Only some operations are actually unsafe inside an unsafe block (calls to unsafe fn's, raw pointer dereference). It would be cool to highlight such operations!

See https://github.com/rust-analyzer/rust-analyzer/issues/190 for details.

I personally think this would be a rather important thing to add for folks who work with unsafe code a lot.

Unsafe operations:

  • Dereference a raw pointer #3080
  • Call an unsafe function or method #3080
  • Access or modify a mutable static variable #3080
  • Implement an unsafe trait
  • Access fields of unions

Contributor Guide

Research-Richtung
Das Issue fordert die Hervorhebung von unsicheren Operationen innerhalb von unsafe Blöcken in Rust Code im IntelliJ Rust Plugin. Das Plugin hebt bereits das Dereferenzieren von Rohzeigern, das Aufrufen von unsafe Funktionen und den Zugriff auf mutable statics (implementiert in PR #3080) hervor. Die verbleibenden Aufgaben sind die Implementierung der Hervorhebung für unsafe Trait Implementierungen und den Zugriff auf Felder von Unions. Beitragende sollten die bestehende Hervorhebungsimplementierung im Inspektionscode des Plugins untersuchen, wahrscheinlich in den Paketen 'org.rust.lang.core.psi' oder 'org.rust.ide.inspections', und sie erweitern, um die fehlenden Fälle abzudecken. Die Testinfrastruktur des Plugins sollte ebenfalls untersucht werden, um Tests für die neuen Hervorhebungen hinzuzufügen.
Tech Stack
rust
Domain
developer experience
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.
Halber Tag
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
Rust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40