Merge pull request #64 from xmtp/gen-docs

Generate docs with typedoc
xmtp · Feb 15, 2022 · fbfff3e · fbfff3e
2 parents 6b7e8e8 + 7f1c135
commit fbfff3e
Show file tree

Hide file tree

Showing 10 changed files with 300 additions and 42 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -6,14 +6,28 @@ module.exports = {
     'prettier',
     'plugin:@typescript-eslint/recommended',
     'eslint-config-prettier',
+    'plugin:jsdoc/recommended',
   ],
   parserOptions: {
     sourceType: 'module',
     warnOnUnsupportedTypeScriptVersion: false,
   },
   rules: {
     'prettier/prettier': 'error',
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-description': 'off',
+    'jsdoc/require-param': 'off',
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-returns': 'off',
   },
-  plugins: ['@typescript-eslint', 'prettier'],
-  ignorePatterns: ['dist', 'node_modules', 'examples', 'scripts', 'src/types'],
+  plugins: ['@typescript-eslint', 'prettier', 'jsdoc'],
+  ignorePatterns: [
+    'dist',
+    'node_modules',
+    'examples',
+    'scripts',
+    'src/types',
+    'docs',
+    'tmp',
+  ],
 }
diff --git a/.gitignore b/.gitignore
@@ -116,3 +116,7 @@ dist
 .yarn/install-state.gz
 .pnp.*
 scratch
+
+# generated docs
+docs/
+tmp/
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-^16.9
+16.9
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,4 @@
 dist
 coverage
+docs
+tmp
-Original file line number
+Diff line change
@@ Expand Up / @@ -116,3 +116,7 @@ dist @@
     .yarn/install-state.gz
     .pnp.*
     scratch
+    # generated docs
+    docs/
+    tmp/