summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Bruhin <git@the-compiler.org>2017-12-15 23:26:18 +0100
committerFlorian Bruhin <git@the-compiler.org>2017-12-15 23:26:18 +0100
commitd03e3147626e70723d8156e833617f02fc1522f9 (patch)
tree32f084c42010f5d07557aca0b339008e0c3ac362
parentb8a5c04b69b2d5d4ac7989becb962dd5d134985f (diff)
downloadqutebrowser-d03e3147626e70723d8156e833617f02fc1522f9.tar.gz
qutebrowser-d03e3147626e70723d8156e833617f02fc1522f9.zip
Explain eslint philosophy
-rw-r--r--qutebrowser/javascript/.eslintrc.yaml12
1 files changed, 12 insertions, 0 deletions
diff --git a/qutebrowser/javascript/.eslintrc.yaml b/qutebrowser/javascript/.eslintrc.yaml
index b29deaa75..6fdd16639 100644
--- a/qutebrowser/javascript/.eslintrc.yaml
+++ b/qutebrowser/javascript/.eslintrc.yaml
@@ -1,3 +1,15 @@
+# qutebrowser's way of using eslint is perhaps a bit untypical: We turn on *all*
+# the checks eslint has to offer, and then selectively disable/reconfigure the
+# ones which got in the way below.
+#
+# This makes eslint much stricter (which is good). However, it means you might
+# run into a case where you totally disagree with what it says, because some
+# check is not useful or desired for qutebrowser, but nobody did run into it
+# yet.
+#
+# In those cases, it's absolutely okay to modify this config as part of your PR.
+# See it as a way to fine-tune eslint rather than a rigid style guide.
+
env:
browser: true