Openlibrary: Lassen Sie uns unser JavaScript mit eslint lint!

Erstellt am 17. Okt. 2018  ·  5Kommentare  ·  Quelle: internetarchive/openlibrary

Stylelint bietet uns Schutz vor verschiedenen CSS-Problemen. Machen wir dasselbe für unser JS.
eslint ist am ausgereiftesten und bietet eine Liste von Regeln, die wir bei Bedarf anwenden

npm install eslint --save-dev

Fügen Sie in package.json einen neuen Befehl hinzu

"lint:js": "eslint openlibrary/plugins/openlibrary/js/"

.eslintrc.json hinzufügen

{
    "root": true,
    "env": {},
    "globals": {
    },
    "rules": {
        "no-extra-semi": "warn"
    }
}

Wir werden die Fehler vorerst so einstellen, dass sie warnen, und sobald die Konfiguration zusammengeführt ist, sollten wir uns mit jemandem abstimmen, um die Fixes auszuführen und zusammenzuführen, um Zusammenführungskonflikte zu vermeiden!

  • [ ] npm run lint:js zeigt mir Warnungen bezüglich der "no-extra-semi"-Regel an.
  • [ ] "npm run lint:js " passiert, wenn ich "npm run test" ausführe
  • [ ] Beheben Sie im Rahmen dieser Änderung keine Fehler!
Good First Issue Linting JavaScript 1 hacktoberfest

Alle 5 Kommentare

Hallo. Können Sie mich beauftragen, dieses Problem zu lösen?

Frage: Warum nicht eine der Voreinstellungen für eslint ? Wie https://standardjs.com oder https://github.com/airbnb/javascript

Langfristig würde ich es gerne tun, aber das Javascript ist in einem so schlechten Zustand, dass die Anwendung eines solchen Presets sehr verwirrend wäre (Codeüberprüfung, Rebase-Konflikte) und manuelle Arbeit (die meisten Presets können nicht automatisch repariert werden). Ich denke, das manuelle Hinzufügen von Regeln hilft uns, es Stück für Stück auf eine zusammenhängende und lehrreiche Weise anzugreifen (wir lernen Stück für Stück die Probleme in unserem Code kennen).

Ich dachte, wir könnten die Lints verwenden, um die häufigsten und dringendsten Probleme auszubügeln (die Lints, die Fehler im Code verursachen können) und dann später nach Belieben eine Voreinstellung (unserer Wahl) anwenden.

Macht das Sinn?

Sicher, das tut es. Die Codeform kann sehr schlecht sein.

Wenn dieser PR zusammengeführt wird, kann ich einige Probleme mit Linting beheben, nenne sie einfach.
Beginnt zum Beispiel mit no-extra-semi ;)

@tamtamchik Ich kann später ein Problem erstellen, aber alles, was unter "mögliche Fehler" steht und automatisch behoben werden kann, ist faires Spiel.

Wir sollten uns mit @mekarpeles abstimmen , um die Autofixes auszuführen und zu übergeben und eslint-Fehler zu machen, anstatt zu warnen.

Ich möchte, dass wir die tief hängenden Früchte loswerden!

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen