@sektek/eslint-plugin 2.0.0 → 3.0.1

package/configs/recommended.js

@@ -1,7 +1,6 @@
+import checkFile from 'eslint-plugin-check-file';
 import { globalIgnores } from 'eslint/config';
 import globals from 'globals';
-
-import checkFile from 'eslint-plugin-check-file';
 import importPlugin from 'eslint-plugin-import';
 import js from '@eslint/js';
 import jsdoc from 'eslint-plugin-jsdoc';
@@ -48,6 +47,19 @@ export default [
         { '**/*\\.{js,ts}': 'KEBAB_CASE' },
       ],
       'import/newline-after-import': 'error',
+      'import/order': [
+        'error',
+        {
+          groups: [
+            'builtin',
+            ['external', 'internal'],
+            'parent',
+            ['sibling', 'index'],
+          ],
+          'newlines-between': 'always',
+        },
+      ],
+      'jsdoc/require-jsdoc': ['error', { publicOnly: true }],
       'jsdoc/tag-lines': ['error', 'any', { startLines: 1, maxBlockLines: 1 }],
       'mocha/no-exclusive-tests': 'error',
       'no-console': 'error',

package/configs/typescript.js

@@ -8,6 +8,9 @@ export default [
   ...ts.configs.recommended,
   {
     extends: [jsdoc.configs['flat/recommended-typescript']],
+    rules: {
+      'jsdoc/require-jsdoc': ['error', { publicOnly: true }],
+    },
     settings: {
       'import/resolver': {
         typescript: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sektek/eslint-plugin",
-  "version": "2.0.0",
+  "version": "3.0.1",
   "description": "Eslint configuration for all @sektek projects",
   "author": "Edward Kelly <eddie@sektek.net>",
   "repository": {
@@ -12,7 +12,8 @@
   "type": "module",
   "main": "index.js",
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "test": "node --test 'test/**/*.spec.js'"
   },
   "dependencies": {
     "@sektek/prettier-config": "^2",

package/test/require-jsdoc.spec.js

@@ -0,0 +1,49 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+
+import { ESLint } from 'eslint';
+import { defineConfig } from 'eslint/config';
+
+import sektek from '../index.js';
+
+const lint = async (config, code, filePath) => {
+  const eslint = new ESLint({
+    overrideConfigFile: true,
+    overrideConfig: defineConfig(config),
+    cwd: process.cwd(),
+  });
+  const [result] = await eslint.lintText(code, { filePath });
+  return result.messages.filter(m => m.ruleId === 'jsdoc/require-jsdoc');
+};
+
+const cases = [
+  {
+    name: 'recommended',
+    config: sektek.configs.recommended,
+    file: 'src/sample.js',
+  },
+  {
+    name: 'typescript',
+    config: sektek.configs.typescript,
+    file: 'src/sample.ts',
+  },
+];
+
+for (const { name, config, file } of cases) {
+  describe(`${name} jsdoc/require-jsdoc`, () => {
+    it('allows an unexported function without JSDoc', async () => {
+      const messages = await lint(
+        config,
+        'function helper() {}\nhelper();\n',
+        file,
+      );
+      assert.deepEqual(messages, []);
+    });
+
+    it('requires JSDoc on an exported function', async () => {
+      const messages = await lint(config, 'export function api() {}\n', file);
+      assert.equal(messages.length, 1);
+      assert.equal(messages[0].severity, 2);
+    });
+  });
+}