From 8fef1c45f2b18cced32e8b0dddb4d86e95e35e9d Mon Sep 17 00:00:00 2001
From: Prescience <65471523+prescience-data@users.noreply.github.com>
Date: Fri, 23 Sep 2022 10:43:55 +1000
Subject: [PATCH] feat: disable lines-around-comment for type definitions

- waiting on https://github.com/typescript-eslint/typescript-eslint/pull/5327
---
 stack/eslint-config/.eslintrc.js              |  8 ++++++
 stack/eslint-config/overrides/index.js        |  1 +
 .../overrides/type-definitions.js             |  6 ++++
 stack/eslint-config/profile/node.js           | 28 +++++++++++++------
 .../rules/lines-around-comment.js             |  2 +-
 5 files changed, 36 insertions(+), 9 deletions(-)
 create mode 100644 stack/eslint-config/overrides/type-definitions.js

diff --git a/stack/eslint-config/.eslintrc.js b/stack/eslint-config/.eslintrc.js
index ef9bfb6..80ce055 100644
--- a/stack/eslint-config/.eslintrc.js
+++ b/stack/eslint-config/.eslintrc.js
@@ -5,5 +5,13 @@ module.exports = {
     "@rushstack/eslint-config/mixins/friendly-locals",
     "@rushstack/eslint-config/profile/web-app",
     "./profile/node.js"
+  ],
+  overrides: [
+    {
+      files: ["profile/*.js"],
+      rules: {
+        "lines-around-comment": "off"
+      }
+    }
   ]
 }
diff --git a/stack/eslint-config/overrides/index.js b/stack/eslint-config/overrides/index.js
index 1c9e61e..12c0e36 100644
--- a/stack/eslint-config/overrides/index.js
+++ b/stack/eslint-config/overrides/index.js
@@ -3,5 +3,6 @@ module.exports = {
   barrels: require("./barrels"),
   javascript: require("./javascript"),
   markdown: require("./markdown"),
+  typeDefinitions: require("./type-definitions"),
   typescript: require("./typescript")
 }
diff --git a/stack/eslint-config/overrides/type-definitions.js b/stack/eslint-config/overrides/type-definitions.js
new file mode 100644
index 0000000..1df64fe
--- /dev/null
+++ b/stack/eslint-config/overrides/type-definitions.js
@@ -0,0 +1,6 @@
+module.exports = {
+  files: ["**/types/*.ts", "**/types.ts"],
+  rules: {
+    "lines-around-comment": "off"
+  }
+}
diff --git a/stack/eslint-config/profile/node.js b/stack/eslint-config/profile/node.js
index bc36c4a..456bc6e 100644
--- a/stack/eslint-config/profile/node.js
+++ b/stack/eslint-config/profile/node.js
@@ -14,28 +14,33 @@ const {
   barrels,
   javascript,
   markdown,
+  typeDefinitions,
   typescript
 } = require("../overrides")
 
 const { when } = require("../utils")
 
 /**
- * Node Eslint Config
+ * NodeJS ESLint profile.
+ *
+ * @remarks
+ * This profile is intended for use within NodeJS applications.
+ * Rules may not be appropriate for browser applications.
  *
  * @public
  */
 module.exports = {
-  // Environment linter should expect.
+  /* Environment linter should expect. */
   env: {
     node: true
   },
-  // List of patterns to ignore.
+  /* List of patterns to ignore. */
   ignorePatterns,
-  // Default parser options for TypeScript.
+  /* Default parser options for TypeScript. */
   parserOptions,
-  // Third-party plugins to load.
+  /* Third-party plugins to load. */
   plugins,
-  // Main rules definitions across all included files.
+  /* Main rule definitions used across all matched files. */
   rules: {
     "@rushstack/no-new-null": "off",
     "@typescript-eslint/member-ordering": "error",
@@ -58,6 +63,13 @@ module.exports = {
     "simple-import-sort/imports": ["error", simpleImportSort],
     "tsdoc/syntax": "error"
   },
-  // Pattern specific overrides.
-  overrides: [anyInTypes, barrels, javascript, markdown, typescript]
+  /* Pattern specific overrides. */
+  overrides: [
+    anyInTypes,
+    barrels,
+    javascript,
+    markdown,
+    typeDefinitions,
+    typescript
+  ]
 }
diff --git a/stack/eslint-config/rules/lines-around-comment.js b/stack/eslint-config/rules/lines-around-comment.js
index 953284d..bebb003 100644
--- a/stack/eslint-config/rules/lines-around-comment.js
+++ b/stack/eslint-config/rules/lines-around-comment.js
@@ -1,7 +1,7 @@
 module.exports = {
   beforeBlockComment: true,
   afterBlockComment: false,
-  beforeLineComment: false,
+  beforeLineComment: true,
   afterLineComment: false,
   allowBlockStart: true,
   allowClassStart: true,