- Linting (ESLint): Add rules to check for file-level tags

2020-01-01 01:15:16 +08:00
parent 63ba8f39a1
commit cc6937ce96
13 changed files with 49 additions and 9 deletions
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -201,6 +201,34 @@ module.exports = {
    }],
    "unicorn/prefer-query-selector": "off",
    "unicorn/prefer-node-append": "off",
-    "unicorn/no-zero-fractions": "off"
+    "unicorn/no-zero-fractions": "off",
+    "jsdoc/require-file-overview": ["error", {
+      tags: {
+        file: {
+          "initialCommentsOnly": true,
+          "preventDuplicates": true,
+        },
+        license: {
+          "initialCommentsOnly": true,
+          "preventDuplicates": true,
+        },
+        copyright: {
+          "initialCommentsOnly": true,
+          "preventDuplicates": true,
+        },
+        author: {
+          "initialCommentsOnly": true,
+          "preventDuplicates": true,
+        },
+        module: {
+          "initialCommentsOnly": true,
+          "preventDuplicates": true,
+        },
+        exports: {
+          "initialCommentsOnly": true,
+          "preventDuplicates": true,
+        }
+      }
+    }]
  }
 };