[Feature] Add jsdoc-format converter (#238)

* Add jsdoc-format converter

* Replace jsdoc format rule with check indentation

* Add notice for multiline comments in jsdoc rule

* Provide jsdoc format notice closer to TSLint docs

Author: KingDarBoja

src/rules/converters/jsdoc-format.ts

@@ -0,0 +1,22 @@
+import { RuleConverter, ConvertedRuleChanges } from "../converter";
+
+export const JSDocNoticeMsg =
+    "ESLint does not support enforcing the first line of multiline JSDoc comments be empty.";
+
+export const convertJSDocFormat: RuleConverter = () => {
+    const ruleNames = [
+        "jsdoc/check-alignment",
+        "jsdoc/check-indentation",
+        "jsdoc/newline-after-description",
+    ];
+
+    const mappedRuleNames: ConvertedRuleChanges[] = ruleNames.map(ruleName => {
+        return { ruleName };
+    });
+
+    return {
+        rules: [...mappedRuleNames],
+        notices: [JSDocNoticeMsg],
+        plugins: ["eslint-plugin-jsdoc"],
+    };
+};

src/rules/converters/tests/jsdoc-format.test.ts

@@ -0,0 +1,25 @@
+import { convertJSDocFormat, JSDocNoticeMsg } from "../jsdoc-format";
+
+describe(convertJSDocFormat, () => {
+    test("conversion without arguments", () => {
+        const result = convertJSDocFormat({
+            ruleArguments: [],
+        });
+
+        expect(result).toEqual({
+            rules: [
+                {
+                    ruleName: "jsdoc/check-alignment",
+                },
+                {
+                    ruleName: "jsdoc/check-indentation",
+                },
+                {
+                    ruleName: "jsdoc/newline-after-description",
+                },
+            ],
+            notices: [JSDocNoticeMsg],
+            plugins: ["eslint-plugin-jsdoc"],
+        });
+    });
+});

src/rules/rulesConverters.ts

@@ -23,6 +23,7 @@ import { convertIncrementDecrement } from "./converters/increment-decrement";
 import { convertIndent } from "./converters/indent";
 import { convertInterfaceName } from "./converters/interface-name";
 import { convertInterfaceOverTypeLiteral } from "./converters/interface-over-type-literal";
+import { convertJSDocFormat } from "./converters/jsdoc-format";
 import { convertLabelPosition } from "./converters/label-position";
 import { convertLinebreakStyle } from "./converters/linebreak-style";
 import { convertMaxClassesPerFile } from "./converters/max-classes-per-file";
@@ -162,6 +163,7 @@ export const rulesConverters = new Map([
     ["indent", convertIndent],
     ["interface-name", convertInterfaceName],
     ["interface-over-type-literal", convertInterfaceOverTypeLiteral],
+    ["jsdoc-format", convertJSDocFormat],
     ["label-position", convertLabelPosition],
     ["linebreak-style", convertLinebreakStyle],
     ["max-classes-per-file", convertMaxClassesPerFile],