@eagleoutice/eslint-config-flowr 2.1.6 → 2.1.8

package/README.md

@@ -19,7 +19,9 @@ configuration from your `tsdoc.json`:
 ## The `flowr` plugin
 
 flowR groups its functions in helper objects (`DfEdge`, `Resolve`, `NodeId`, and friends) so that there is one obvious
-entry point per topic. Two rules keep the code on those entry points, both on by default.
+entry point per topic. Two rules keep the code on those entry points, both on by default. A third,
+`flowr/file-naming`, checks file names (`dataflow-graph.ts`, `1-setup.ts`, `Vertex.ts`) and keeps `*.spec.ts` files
+below `test/`.
 
 | rule | driven by | finds |
 | :-- | :-- | :-- |
@@ -80,7 +82,7 @@ The shipped set groups into families:
 | family | shape it finds | helper it points at |
 | :-- | :-- | :-- |
 | `edge-*` | `e.types === T`, `(e.types & T) !== 0`, and the bitmask spellings around them | `DfEdge` |
-| `vertex-is*`, `vertex-has-origin` | `v.tag === VertexType.X`, `Vertex.isFunctionCall(v) && v.origin.includes(o)` | `Vertex` |
+| `vertex-is*`, `vertex-has-origin` | `v.tag === VertexType.X`, `DfgVertex.isFunctionCall(v) && v.origin.includes(o)` | `DfgVertex` |
 | `node-is*` | `n.type === RType.X`, negated and through `?.` | `RSymbol`, `RFunctionCall`, and the rest of the `R*` node objects |
 | `argument-is-*`, `call-is-*`, `list-is-implicit` | a guard written out, `RFunctionCall.is(n) && n.named` | the narrower guard of the same object |
 | `symbol-name-comparison*` | `symbol.content === 'name'`, which misses `pkg::name` because an identifier with a namespace is an array | `Identifier.getName` / `Identifier.matches` |

package/index.js

@@ -10,7 +10,6 @@ const eslint_plugin_2 = __importDefault(require("@stylistic/eslint-plugin"));
 const eslint_plugin_jsdoc_1 = __importDefault(require("eslint-plugin-jsdoc"));
 const eslint_plugin_tsdoc_1 = __importDefault(require("eslint-plugin-tsdoc"));
 const eslint_plugin_unused_imports_1 = __importDefault(require("eslint-plugin-unused-imports"));
-const eslint_plugin_check_file_1 = __importDefault(require("eslint-plugin-check-file"));
 const eslint_plugin_import_x_1 = __importDefault(require("eslint-plugin-import-x"));
 const eslint_plugin_unicorn_1 = __importDefault(require("eslint-plugin-unicorn"));
 const plugin_1 = __importDefault(require("./plugin"));
@@ -41,7 +40,6 @@ const config = [
             '@stylistic': eslint_plugin_2.default,
             'import-x': eslint_plugin_import_x_1.default,
             'unused-imports': eslint_plugin_unused_imports_1.default,
-            'check-file': eslint_plugin_check_file_1.default,
             tsdoc: eslint_plugin_tsdoc_1.default,
             jsdoc: eslint_plugin_jsdoc_1.default,
             flowr: plugin_1.default,
@@ -105,14 +103,21 @@ const config = [
             '@stylistic/no-extra-semi': 'error',
             'jsdoc/check-alignment': 'error',
             /*
-             * the same alignment `key-spacing` asks of object values, asked of tsdoc: the `-` of every `@param`
-             * in a block lines up, so the names read as a column instead of as prose.
+             * `jsdoc/check-line-alignment` is deliberately NOT enabled. Lining up what the tags declare reads
+             * well, but 'always' reaches past the tags: it re-flows every hand-wrapped line to the margin, and
+             * that indentation is the author's and carries meaning -- a `@param` description hung under its
+             * first line, or the nested call in an R example that only its indentation ties to the call around
+             * it:
              *
-             * `disableWrapIndent` keeps its hands off every line after the first: a continuation is indented
-             * because the author meant something by it -- a hanging list, or a nested call in an R example
-             * whose indentation is what links it to the call around it -- and re-flowing that loses the point.
+             * ```r
+             * test_that("my test", {
+             *    assert_equal(1 + 1, 2)
+             * })
+             * ```
+             *
+             * Neither `preserveMainDescriptionPostDelimiter` nor `disableWrapIndent` stops it doing that to a
+             * tag's continuation lines, so the alignment is left to the author, like the delimiter style is.
              */
-            'jsdoc/check-line-alignment': ['error', 'always', { disableWrapIndent: true }],
             /* `@param name - what it is`, the spelling the codebase already uses everywhere */
             'jsdoc/require-hyphen-before-param-description': ['error', 'always'],
             'jsdoc/no-multi-asterisks': 'error',
@@ -178,12 +183,7 @@ const config = [
                         throw: { after: false }
                     }
                 }],
-            'check-file/filename-naming-convention': ['error', {
-                    '**/*.ts': '?(\\d+-)?([A-Z])+([a-z])*((-|.)?([A-Z])+([a-z]))'
-                }],
-            'check-file/folder-match-with-fex': ['error', {
-                    '*.spec.{js,jsx,ts,tsx}': 'test/**'
-                }],
+            'flowr/file-naming': 'error',
             '@stylistic/no-trailing-spaces': 'error',
             '@stylistic/space-infix-ops': ['error', { int32Hint: false }],
             '@typescript-eslint/no-unused-vars': 'off',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/eslint-config-flowr",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "description": "Linting rules for flowr and friends",
   "license": "ISC",
   "repository": {
@@ -37,7 +37,6 @@
     "@stylistic/eslint-plugin": "^5.7.1",
     "@typescript-eslint/eslint-plugin": "^8.54.0",
     "@typescript-eslint/parser": "^8.54.0",
-    "eslint-plugin-check-file": "^3.3.1",
     "eslint-plugin-import-x": "^4.17.1",
     "eslint-plugin-jsdoc": "^62.5.0",
     "eslint-plugin-tsdoc": "^0.5.0",

package/patterns.js

@@ -84,12 +84,12 @@ const discriminatorIs = (id, { property, enumName, enumFile, propertyFile, helpe
     };
 };
 /**
- * `v.tag === VertexType.X`. One `Vertex` helper answers for every kind, and its members are named after the
- * enum, so `{{type|last}}` spells the check without a table: `VertexType.Use` to `Vertex.isUse`.
+ * `v.tag === VertexType.X`. One `DfgVertex` helper answers for every kind, and its members are named after
+ * the enum, so `{{type|last}}` spells the check without a table: `VertexType.Use` to `DfgVertex.isUse`.
  */
 const vertexIs = (id, options) => discriminatorIs(id, {
     property: 'tag', enumName: 'VertexType', enumFile: VERTEX, propertyFile: VERTEX,
-    helper: 'Vertex', member: 'is{{type|last}}', hint: 'Compare through the vertex helper'
+    helper: 'DfgVertex', member: 'is{{type|last}}', hint: 'Compare through the vertex helper'
 }, options);
 /**
  * `n.type === RType.X`. Every `RType` member has a helper object of the same name prefixed with `R`
@@ -220,15 +220,15 @@ const patterns = [
     {
         id: 'vertex-has-origin',
         selector: 'LogicalExpression[operator="&&"]'
-            + `${helperCall('left', 'Vertex', 'isFunctionCall')}`
+            + `${helperCall('left', 'DfgVertex', 'isFunctionCall')}`
             + `${call('right', 'includes')}[right.callee.object.type="MemberExpression"][right.callee.object.property.name="origin"]`,
         capture: { vertex: 'left.arguments.0', origin: 'right.arguments.0' },
-        replace: 'Vertex.hasOrigin({{vertex}}, {{origin}})',
+        replace: 'DfgVertex.hasOrigin({{vertex}}, {{origin}})',
         declaredIn: { 'left.callee.object': VERTEX, 'right.callee.object.property': VERTEX },
         sameText: [['left.arguments.0', 'right.callee.object.object']],
         /* `hasOrigin` is no type predicate, so the replacement can drop a narrowing the code below relies on */
         fix: false,
-        message: 'Use `Vertex.hasOrigin`, it is exactly this check. Check the narrowing first, `hasOrigin` returns a plain boolean.'
+        message: 'Use `DfgVertex.hasOrigin`, it is exactly this check. Check the narrowing first, `hasOrigin` returns a plain boolean.'
     },
     edgesFallback('graph-edges-from', 'outgoingEdges', 'edgesFrom'),
     edgesFallback('graph-edges-to', 'ingoingEdges', 'edgesTo'),

package/plugin.d.ts

@@ -5,6 +5,7 @@ declare const plugin: {
     rules: {
         'use-instead': import("eslint").Rule.RuleModule;
         'replacement-pattern': import("eslint").Rule.RuleModule;
+        'file-naming': import("eslint").Rule.RuleModule;
     };
 };
 export = plugin;

package/plugin.js

@@ -5,11 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 /** The flowR-specific rules, see the README for the tags they read. */
 const replacement_pattern_1 = __importDefault(require("./rules/replacement-pattern"));
 const use_instead_1 = __importDefault(require("./rules/use-instead"));
+const file_naming_1 = __importDefault(require("./rules/file-naming"));
 const plugin = {
     meta: { name: '@eagleoutice/eslint-config-flowr' },
     rules: {
         'use-instead': use_instead_1.default,
-        'replacement-pattern': replacement_pattern_1.default
+        'replacement-pattern': replacement_pattern_1.default,
+        'file-naming': file_naming_1.default
     }
 };
 module.exports = plugin;

package/rules/file-naming.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export = rule;

package/rules/file-naming.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const path_1 = __importDefault(require("path"));
+/** `dataflow-graph`, `Vertex`, `1-setup`, `r-bridge.test`: lower-case words, each optionally capitalized */
+const fileName = /^(\d+-)?[A-Z]?[a-z]+([-.][A-Z]?[a-z]+)*$/;
+const specFile = /\.spec\.[jt]sx?$/;
+const rule = {
+    meta: {
+        type: 'layout',
+        docs: {
+            description: 'enforce the flowR file naming convention and keep spec files in the test folder',
+            url: 'https://github.com/flowr-analysis/flowr-lint#flowrfile-naming'
+        },
+        schema: [],
+        messages: {
+            name: 'The filename "{{ name }}" does not match {{ pattern }}',
+            spec: 'The spec file "{{ name }}" belongs below test/'
+        }
+    },
+    create(context) {
+        return {
+            Program(node) {
+                const file = path_1.default.relative(context.cwd, context.physicalFilename).split(path_1.default.sep).join('/');
+                const name = path_1.default.posix.basename(file);
+                if (name.endsWith('.ts') && !fileName.test(name.slice(0, name.lastIndexOf('.')))) {
+                    context.report({ node, messageId: 'name', data: { name, pattern: String(fileName) } });
+                }
+                if (specFile.test(name) && !file.startsWith('test/')) {
+                    context.report({ node, messageId: 'spec', data: { name } });
+                }
+            }
+        };
+    }
+};
+module.exports = rule;