@eagleoutice/eslint-config-flowr 2.1.7 → 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 |
 | :-- | :-- | :-- |

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,
@@ -185,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.7",
+  "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/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;