Merge pull request #97 from jeremyvii/implement-tsdoc

Implement tsdoc

Author: jeremyvii

.eslintrc.json

@@ -5,5 +5,8 @@
     },
     "search.exclude": {
         "out": true // set this to false to include "out" folder in search results
-    }
-}
+    },
+    "cSpell.words": [
+        "jeremyljackson"
+    ]
+}

.vscode/settings.json

@@ -38,15 +38,18 @@ you autocomplete multiple lines with the `/**` keybinding)
 
 Currently the following configuration settings have been implemented:
 
-| Title                    | Description                                                                     |
-|--------------------------|---------------------------------------------------------------------------------|
-| Align Tags               | Whether or not to automatically align the parameters, return, or variable tags. |
-| Block Comment Style      | Which doc block comment style to use (`default\|drupal`).                       |
-| Column Spacing           | Minimum number of spaces between columns.                                       |
-| New Lines Between Tags   | Whether or not to add new lines between tags.                                   |
-| Default return tag       | Whether or not to display a return tag.                                         |
-| \*SCSS Comment Close     | Type of block level comment closing to use.                                     |
-| \*SCSS Comment Open      | Type of block level comment opening to use.                                     |
-| \*SCSS Comment Separator | Type of block level separator closing to use.                                   |
+| Title                    | Description                                                                                                          |
+|--------------------------|----------------------------------------------------------------------------------------------------------------------|
+| Align Tags               | Whether or not to automatically align the parameters, return, or variable tags.                                      |
+| Block Comment Style      | Which doc block comment style to use (`default\|drupal\|tsdoc`).                                                     |
+| Column Spacing           | Minimum number of spaces between columns.                                                                            |
+| New Lines Between Tags   | Whether or not to add new lines between tags.                                                                        |
+| Default return tag       | Whether or not to display a return tag.                                                                              |
+| \*SCSS Comment Close     | Type of block level comment closing to use. **Deprecated: Use `vs-docblockr.commentClose` targeting SCSS instead**   |
+| \*SCSS Comment Open      | Type of block level comment opening to use. **Deprecated: Use `vs-docblockr.commentOpen` targeting SCSS instead**    |
+| \*SCSS Comment Separator | Type of block level separator closing to use. **Deprecated: Use `vs-docblockr.separator` targeting SCSS instead**    |
+| Comment Open             | Type of block level comment opening to use.                                                                          |
+| Comment Close            | Type of block level comment closing to use.                                                                          |
+| Separator                | Type of block level separator closing to use.                                                                        |
 
 \* *Note: VS DocBlockr does not currently support autocompletion of SASS blocks with `///`.*

README.md

@@ -0,0 +1,56 @@
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import tsDocEslint from 'eslint-plugin-tsdoc';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all
+});
+
+export default [
+  ...compat.extends(
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended'
+  ),
+  {
+    plugins: {
+      '@typescript-eslint': typescriptEslint,
+      'tsdoc': tsDocEslint,
+    },
+
+    languageOptions: {
+      parser: tsParser,
+    },
+
+    rules: {
+      semi: ['error', 'always'],
+      indent: ['error', 2],
+      'lines-between-class-members': ['error', 'always'],
+      '@typescript-eslint/member-ordering': ['error', {
+        default: {
+          order: 'alphabetically',
+
+          memberTypes: [
+            'public-static-field',
+            'public-instance-field',
+            'public-constructor',
+            'private-static-field',
+            'private-instance-field',
+            'private-constructor',
+            'public-instance-method',
+            'protected-instance-method',
+            'private-instance-method',
+          ],
+        },
+      }],
+      'tsdoc/syntax': 'error',
+    },
+  },
+];