Mention `^js` annotation in Externs Guide

Offen
#260 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
javascript
Bereich
documentation

Rechercherichtung

Beginne mit dem Abschnitt „externs inference“ im externs guide, insbesondere mit seiner Erörterung der Anmerkungen zu ^js/Foo.Bar. Überprüfe, wie die einfachere ^js-Anmerkung beschrieben wird und ob sie die standardmäßige Empfehlung sein sollte; als erledigt gilt die Aufgabe, wenn der Guide die unterstützte Form und die Empfehlung klar dokumentiert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

major

The externs guide mentions type annotations like ^js/Foo.Bar.

Although it doesn't mention it, it's also possible to simply use ^js. (In fact anything like ^js/asdf will work, too.)

Should ^js be the default recommendation? Oftentimes you don't know the correct type of JS objects you're getting back from an NPM lib. Even if you do, using a generic annotation seems to have the same effect, so not sure there are any downsides to simply using ^js everywhere.

Vorherrschende Sprache
Shell
Sterne
107
Forks
130
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus clojure/clojurescript-site

Alle Issues in clojure/clojurescript-site

Ähnliche Issues

Weitere Issues zu Shell/Bash

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.