feat: add jsdoc config

.github/workflows/release.yml

@@ -29,8 +29,6 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
           registry-url: 'https://registry.npmjs.org'
         if: ${{ steps.release.outputs.release_created }}
-      - run: npm install
-        if: ${{ steps.release.outputs.release_created }}
       - run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_BOT_TOKEN }}

eslintrc.test.yml

@@ -0,0 +1 @@
+extends: ['./index.js', './jsdoc.js']

jsdoc.js

@@ -0,0 +1,12 @@
+'use strict';
+
+module.exports = {
+  plugins: ['jsdoc'],
+  extends: ['plugin:jsdoc/recommended'],
+  rules: {
+    'jsdoc/require-asterisk-prefix': 'warn',
+    'jsdoc/require-description': 'warn',
+    'jsdoc/require-description-complete-sentence': 'warn',
+    'jsdoc/require-hyphen-before-param-description': 'warn',
+  },
+};

package.json

@@ -4,7 +4,8 @@
   "description": "Shared ESLint config for cheminfo and ml.js projects",
   "main": "index.js",
   "files": [
-    "index.js"
+    "index.js",
+    "jsdoc.js"
   ],
   "scripts": {
     "test": "node test/test.js"
@@ -23,12 +24,14 @@
   "peerDependencies": {
     "eslint": "^8.0.1",
     "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-jest": "^25.2.1"
+    "eslint-plugin-jest": "^25.2.1",
+    "eslint-plugin-jsdoc": "^36.1.1"
   },
   "devDependencies": {
     "eslint": "8.0.1",
     "eslint-plugin-import": "2.25.2",
     "eslint-plugin-jest": "25.2.1",
+    "eslint-plugin-jsdoc": "36.1.1",
     "prettier": "^2.4.1"
   }
 }

test/ok.js

@@ -9,6 +9,11 @@ b = 2;
 c = a + b;
 useIt(c);
 
+/**
+ * This is function a.
+ *
+ * @returns {void}
+ */
 function A() {
   this.x = 1;
 }
@@ -23,9 +28,10 @@ useIt(/abc/);
 })();
 
 /**
- * Checks a
- * @param {string} a
- * @return {string}
+ * Checks a.
+ *
+ * @param {string} a - Some string.
+ * @returns {string} - The value of a.
  */
 function check(a) {
   return a;
@@ -35,7 +41,12 @@ check('test');
 let bigint = new BigInt64Array(1);
 useIt(bigint);
 
-// use this function to mark a variable as used
+/**
+ * Use this function to mark a variable as used.
+ *
+ * @param  {...any} vals - The values to use.
+ * @returns {any} The used values.
+ */
 function useIt(...vals) {
   return vals;
 }

test/test.js

@@ -4,7 +4,7 @@ const assert = require('assert');
 const util = require('util');
 const { ESLint } = require('eslint');
 
-const eslint = new ESLint({ overrideConfigFile: 'index.js' });
+const eslint = new ESLint({ overrideConfigFile: 'eslintrc.test.yml' });
 
 eslint
   .lintFiles(['test/ok.js', 'test/not-ok.js', 'test/jest.test.js'])
@@ -14,7 +14,13 @@ eslint
     assert.strictEqual(
       okResult.errorCount,
       0,
-      'ok.js should have no error: ' + util.format(okResult),
+      'ok.js should have no error: ' + util.format(okResult.messages),
+    );
+
+    assert.strictEqual(
+      okResult.warningCount,
+      0,
+      'ok.js should have no warnings: ' + util.format(okResult.messages),
     );
 
     const errors = notOkResult.messages