eslint-plugin-use-agnostic 0.6.1 → 0.8.0

package/README.md

@@ -16,7 +16,6 @@ npm install eslint@^9.0.0 eslint-plugin-use-agnostic --save-dev
 // eslint.config.js
 
 import { defineConfig, globalIgnores } from "eslint/config";
-import tseslint from "typescript-eslint"; // for compatibility with TypeScript, not included as a devDependency
 
 import useAgnostic, {
   useAgnosticPluginName,
@@ -32,9 +31,6 @@ export default defineConfig([
       [useAgnosticPluginName]: useAgnostic,
     },
     extends: [`${useAgnosticPluginName}/${agnostic20ConfigName}`],
-    languageOptions: {
-      parser: tseslint.parser, // for compatibility with .ts and .tsx
-    },
   },
 ]);
 ```

package/library/_commons/constants/bases.js

@@ -1,5 +1,8 @@
-// plugin name
+/* plugin names */
+// use-agnostic
 export const useAgnosticPluginName = "use-agnostic";
+// crossingStrategies
+export const strategiesPluginName = "strategies";
 
 /* config names */
 // agnostic20
@@ -15,6 +18,14 @@ export const enforceEffectiveDirectivesRuleName =
 export const enforceCommentedDirectivesRuleName =
   "enforce-commented-directives-import-rules";
 
+// crossingStrategies
+export const verifySpecifierImportRuleName =
+  "verify-specifier-import-export-same-strategy";
+export const verifyDefaultImportRuleName =
+  "verify-default-import-export-same-strategy";
+export const verifyNamespaceImportRuleName =
+  "verify-namespace-import-export-some-strategy";
+
 /* messageIds */
 export const reExportNotSameMessageId = "re-export-not-same-directive";
 // agnostic20

package/library/agnostic20/{constants → _commons/constants}/bases.js

@@ -13,9 +13,9 @@ import {
   CLIENT_COMPONENTS_MODULE as COMMONS_CLIENT_COMPONENTS_MODULE,
   AGNOSTIC_LOGICS_MODULE as COMMONS_AGNOSTIC_LOGICS_MODULE,
   AGNOSTIC_COMPONENTS_MODULE as COMMONS_AGNOSTIC_COMPONENTS_MODULE,
-} from "../../_commons/constants/bases.js";
+} from "../../../_commons/constants/bases.js";
 
-import { makeIntroForSpecificViolationMessage as commonsMakeIntroForSpecificViolationMessage } from "../../_commons/utilities/helpers.js";
+import { makeIntroForSpecificViolationMessage as commonsMakeIntroForSpecificViolationMessage } from "../../../_commons/utilities/helpers.js";
 
 // directives
 export const NO_DIRECTIVE = null;

package/library/agnostic20/{rules/import-rules-enforcement.js → _commons/rules/import-rules.js}

@@ -2,7 +2,7 @@ import {
   reExportNotSameMessageId,
   importBreaksEffectiveImportRulesMessageId,
   useServerJSXMessageId,
-} from "../../_commons/constants/bases.js";
+} from "../../../_commons/constants/bases.js";
 import {
   currentFileEffectiveDirective,
   importedFileEffectiveDirective,
@@ -25,7 +25,6 @@ const rule = {
         "Enforces import rules based on the file's effective directive. ",
     },
     schema: [],
-    // currentFileEffectiveDirective, importedFileEffectiveDirective, effectiveDirectiveMessage, specificViolationMessage
     messages: {
       [reExportNotSameMessageId]: `The effective directives of this file and this re-export are dissimilar.
 Here, "{{ ${currentFileEffectiveDirective} }}" and "{{ ${importedFileEffectiveDirective} }}" are not the same. Please re-export only from modules that have the same effective directive as the current module. `,

package/library/agnostic20/{utilities → _commons/utilities}/flows.js

@@ -5,7 +5,7 @@ import {
   useServerJSXMessageId,
   importBreaksEffectiveImportRulesMessageId,
   reExportNotSameMessageId,
-} from "../../_commons/constants/bases.js";
+} from "../../../_commons/constants/bases.js";
 import {
   USE_SERVER_LOGICS,
   USE_SERVER_COMPONENTS,
@@ -20,7 +20,7 @@ import {
   specificViolationMessage,
 } from "../constants/bases.js";
 
-import { resolveImportPath } from "../../_commons/utilities/helpers.js";
+import { resolveImportPath } from "../../../_commons/utilities/helpers.js";
 import {
   getDirectiveFromCurrentModule,
   getDirectiveFromImportedModule,

package/library/agnostic20/{utilities → _commons/utilities}/helpers.js

@@ -8,7 +8,7 @@ import {
   JS,
   MJS,
   CJS,
-} from "../../_commons/constants/bases.js";
+} from "../../../_commons/constants/bases.js";
 import {
   NO_DIRECTIVE,
   USE_SERVER,
@@ -32,7 +32,7 @@ import {
   isImportBlocked as commonsIsImportBlocked,
   makeMessageFromResolvedDirective,
   findSpecificViolationMessage as commonsFindSpecificViolationMessage,
-} from "../../_commons/utilities/helpers.js";
+} from "../../../_commons/utilities/helpers.js";
 
 /* getDirectiveFromCurrentModule */
 

package/library/agnostic20/config.js

@@ -1,4 +1,5 @@
 import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
 
 import {
   agnostic20ConfigName,
@@ -19,6 +20,10 @@ export const makeAgnostic20Config = (plugin) => ({
         [`${useAgnosticPluginName}/${enforceEffectiveDirectivesRuleName}`]:
           "warn",
       },
+      languageOptions: {
+        // for compatibility with .ts and .tsx
+        parser: tseslint.parser,
+      },
     },
   ]),
 });

package/library/directive21/{constants → _commons/constants}/bases.js

@@ -19,9 +19,9 @@ import {
   CLIENT_CONTEXTS_MODULE as COMMONS_CLIENT_CONTEXTS_MODULE,
   AGNOSTIC_CONDITIONS_MODULE as COMMONS_AGNOSTIC_CONDITIONS_MODULE,
   AGNOSTIC_STRATEGIES_MODULE as COMMONS_AGNOSTIC_STRATEGIES_MODULE,
-} from "../../_commons/constants/bases.js";
+} from "../../../_commons/constants/bases.js";
 
-import { makeIntroForSpecificViolationMessage as commonsMakeIntroForSpecificViolationMessage } from "../../_commons/utilities/helpers.js";
+import { makeIntroForSpecificViolationMessage as commonsMakeIntroForSpecificViolationMessage } from "../../../_commons/utilities/helpers.js";
 
 // commented directives
 export const USE_SERVER_LOGICS = COMMONS_USE_SERVER_LOGICS;

package/library/directive21/{rules/import-rules-enforcement.js → _commons/rules/import-rules.js}

@@ -5,7 +5,7 @@ import {
   commentedDirectiveVerificationFailed,
   importNotStrategized,
   exportNotStrategized,
-} from "../../_commons/constants/bases.js";
+} from "../../../_commons/constants/bases.js";
 import {
   currentFileCommentedDirective,
   importedFileCommentedDirective,
@@ -29,7 +29,6 @@ const rule = {
         "Enforces import rules based on the file's commented directive. ",
     },
     schema: [],
-    // currentFileCommentedDirective, importedFileCommentedDirective, commentedDirectiveMessage, specificViolationMessage, specificFailure
     messages: {
       [reExportNotSameMessageId]: `The commented directives of this file (or Strategy) and this re-export are dissimilar.
 Here, "{{ ${currentFileCommentedDirective} }}" and "{{ ${importedFileCommentedDirective} }}" are not the same. Please re-export only from modules that have the same commented directive as the current module. `,

package/library/directive21/{utilities → _commons/utilities}/flows.js

@@ -8,7 +8,7 @@ import {
   commentedDirectiveVerificationFailed,
   importNotStrategized,
   exportNotStrategized,
-} from "../../_commons/constants/bases.js";
+} from "../../../_commons/constants/bases.js";
 import {
   USE_SERVER_LOGICS,
   USE_CLIENT_LOGICS,
@@ -28,7 +28,7 @@ import {
   specificFailure,
 } from "../constants/bases.js";
 
-import { resolveImportPath } from "../../_commons/utilities/helpers.js";
+import { resolveImportPath } from "../../../_commons/utilities/helpers.js";
 import {
   getCommentedDirectiveFromCurrentModule,
   getVerifiedCommentedDirective,
@@ -139,11 +139,21 @@ const importedFileFlow = (context, node) => {
   }
 
   /* GETTING THE CORRECT DIRECTIVE INTERPRETATION OF STRATEGY FOR AGNOSTIC STRATEGIES MODULES IMPORTS. 
-  (The Directive-First Architecture does not check whether the export and import Strategies are the same at this time, meaning a @clientLogics strategy could be wrongly imported and interpreted as a @serverLogics strategy. However, Strategy exports are plan to be linting in the future within their own Agnostic Strategies Modules to ensure they respect import rules within their own scopes. It may also become possible to check whether the export and import Strategies are the same in the future when identifiers are defined and the same, especially for components modules where a convention could be to for all non-type export to be named and PascalCase.) */
+  (The Directive-First Architecture does not check whether the export and import Strategies are the same at this time, meaning a @clientLogics strategy could be wrongly imported and interpreted as a @serverLogics strategy.
+  
+  After a short attempt, this feature is currently cancelled, mainly since the amount of work it will require will not be able to be transferred in a future where commented strategies will actually be real syntax.
+  
+  However, Strategy exports are planned to be linting in the future within their own Agnostic Strategies Modules to ensure they respect import rules within their own scopes. It may also become possible to check whether the export and import Strategies are the same in the future when identifiers are defined and the same, especially for components modules where a convention could be to for all non-type export to be named and PascalCase.) */
   if (importedFileCommentedDirective === USE_AGNOSTIC_STRATEGIES) {
-    importedFileCommentedDirective = getStrategizedDirective(context, node);
+    const importingFileCommentedDirective = getStrategizedDirective(
+      context,
+      node
+    );
+
+    // FOR NOW, we consider the importingFileCommentedDirective (which is strategized) and the importedFileCommentedDirective (which should be strategized on its own imported file) to be same, given the limitation highlighted above.
+    importedFileCommentedDirective = importingFileCommentedDirective;
 
-    if (importedFileCommentedDirective === null) {
+    if (importingFileCommentedDirective === null) {
       context.report({
         node,
         messageId: importNotStrategized,

package/library/directive21/{utilities → _commons/utilities}/helpers.js

@@ -5,7 +5,7 @@ import {
   commentedDirectiveVerificationFailed,
   importNotStrategized,
   exportNotStrategized,
-} from "../../_commons/constants/bases.js";
+} from "../../../_commons/constants/bases.js";
 import {
   USE_SERVER_LOGICS,
   USE_CLIENT_LOGICS,
@@ -30,7 +30,7 @@ import {
   isImportBlocked as commonsIsImportBlocked,
   makeMessageFromResolvedDirective,
   findSpecificViolationMessage as commonsFindSpecificViolationMessage,
-} from "../../_commons/utilities/helpers.js";
+} from "../../../_commons/utilities/helpers.js";
 
 /* getCommentedDirectiveFromCurrentModule */
 

package/library/directive21/config.js

@@ -1,4 +1,5 @@
 import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
 
 import {
   directive21ConfigName,
@@ -19,6 +20,10 @@ export const makeDirective21Config = (plugin) => ({
         [`${useAgnosticPluginName}/${enforceCommentedDirectivesRuleName}`]:
           "warn",
       },
+      languageOptions: {
+        // for compatibility with .ts and .tsx
+        parser: tseslint.parser,
+      },
     },
   ]),
 });

package/library/directive21/crossingStrategies/_commons/plugins/strategies.js

@@ -0,0 +1,23 @@
+import {
+  verifySpecifierImportRuleName,
+  verifyDefaultImportRuleName,
+  verifyNamespaceImportRuleName,
+} from "../../../../_commons/constants/bases.js";
+
+import verifySpecifierImportExportSameStrategy from "../rules/specifiers.js";
+import verifyDefaultImportExportSameStrategy from "../rules/defaults.js";
+import verifyNamespaceImportExportSomeStrategy from "../rules/namespaces.js";
+
+// The name of the plugin is `strategies`.
+// This is the strategies plugin.
+
+/** @type {import('eslint').ESLint.Plugin} */
+const plugin = {
+  rules: {
+    [verifySpecifierImportRuleName]: verifySpecifierImportExportSameStrategy,
+    [verifyDefaultImportRuleName]: verifyDefaultImportExportSameStrategy,
+    [verifyNamespaceImportRuleName]: verifyNamespaceImportExportSomeStrategy,
+  },
+};
+
+export default plugin;

package/library/directive21/crossingStrategies/_commons/rules/defaults.js

@@ -0,0 +1,56 @@
+import {
+  USE_SERVER_LOGICS,
+  USE_CLIENT_LOGICS,
+  USE_AGNOSTIC_LOGICS,
+  USE_SERVER_COMPONENTS,
+  USE_CLIENT_COMPONENTS,
+  USE_AGNOSTIC_COMPONENTS,
+  USE_SERVER_FUNCTIONS,
+  USE_CLIENT_CONTEXTS,
+  USE_AGNOSTIC_CONDITIONS,
+} from "../../../_commons/constants/bases.js";
+
+// The name of the rule is `verify-default-import-export-same-strategy`.
+// This is the verify-default-import-export-same-strategy rule.
+
+/** @type {import('@typescript-eslint/utils').TSESLint.RuleModule<string, []>} */ // string for now
+const rule = {
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "Verifies that a default import and export have the same strategy. ",
+    },
+    schema: [
+      {
+        // importingFileCommentedDirective
+        enum: [
+          USE_SERVER_LOGICS,
+          USE_CLIENT_LOGICS,
+          USE_AGNOSTIC_LOGICS,
+          USE_SERVER_COMPONENTS,
+          USE_CLIENT_COMPONENTS,
+          USE_AGNOSTIC_COMPONENTS,
+          USE_SERVER_FUNCTIONS,
+          USE_CLIENT_CONTEXTS,
+          USE_AGNOSTIC_CONDITIONS,
+        ],
+      },
+      {
+        // importedName (because stemming from the same makeConfig)
+        type: "undefined",
+      },
+    ],
+    messages: {},
+  },
+  create: (context) => {
+    return {
+      ExportDefaultDeclaration: (node) => {
+        console.log("verify-default-import-export-same-strategy");
+        console.log(node);
+      },
+    };
+  },
+};
+
+export default rule; // verify-default-import-export-same-strategy

package/library/directive21/crossingStrategies/_commons/rules/namespaces.js

@@ -0,0 +1,61 @@
+import {
+  USE_SERVER_LOGICS,
+  USE_CLIENT_LOGICS,
+  USE_AGNOSTIC_LOGICS,
+  USE_SERVER_COMPONENTS,
+  USE_CLIENT_COMPONENTS,
+  USE_AGNOSTIC_COMPONENTS,
+  USE_SERVER_FUNCTIONS,
+  USE_CLIENT_CONTEXTS,
+  USE_AGNOSTIC_CONDITIONS,
+} from "../../../_commons/constants/bases.js";
+
+// The name of the rule is `verify-namespace-import-export-some-strategy`.
+// This is the verify-namespace-import-export-some-strategy rule.
+
+/** @type {import('@typescript-eslint/utils').TSESLint.RuleModule<string, []>} */ // string for now
+const rule = {
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "Verifies that a specifier's import and export have the same strategy. ",
+    },
+    schema: [
+      {
+        // importingFileCommentedDirective
+        enum: [
+          USE_SERVER_LOGICS,
+          USE_CLIENT_LOGICS,
+          USE_AGNOSTIC_LOGICS,
+          USE_SERVER_COMPONENTS,
+          USE_CLIENT_COMPONENTS,
+          USE_AGNOSTIC_COMPONENTS,
+          USE_SERVER_FUNCTIONS,
+          USE_CLIENT_CONTEXTS,
+          USE_AGNOSTIC_CONDITIONS,
+        ],
+      },
+      {
+        // importedName (because stemming from the same makeConfig)
+        type: "undefined",
+      },
+    ],
+    messages: {},
+  },
+  create: (context) => {
+    return {
+      ExportSpecifier: (node) => {
+        console.log("verify-namespace-import-export-some-strategy");
+        console.log(node);
+      },
+      ExportNamedDeclaration: (node) => {
+        console.log("verify-namespace-import-export-some-strategy");
+        console.log("ExportNamedDeclaration");
+        console.log(node);
+      },
+    };
+  },
+};
+
+export default rule; // verify-namespace-import-export-some-strategy

package/library/directive21/crossingStrategies/_commons/rules/specifiers.js

@@ -0,0 +1,64 @@
+import {
+  USE_SERVER_LOGICS,
+  USE_CLIENT_LOGICS,
+  USE_AGNOSTIC_LOGICS,
+  USE_SERVER_COMPONENTS,
+  USE_CLIENT_COMPONENTS,
+  USE_AGNOSTIC_COMPONENTS,
+  USE_SERVER_FUNCTIONS,
+  USE_CLIENT_CONTEXTS,
+  USE_AGNOSTIC_CONDITIONS,
+} from "../../../_commons/constants/bases.js";
+
+// The name of the rule is `verify-specifier-import-export-same-strategy`.
+// This is the verify-specifier-import-export-same-strategy rule.
+
+/** @type {import('@typescript-eslint/utils').TSESLint.RuleModule<string, []>} */ // string for now
+const rule = {
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "Verifies that a specifier's import and export have the same strategy. ",
+    },
+    schema: [
+      {
+        // importingFileCommentedDirective
+        enum: [
+          USE_SERVER_LOGICS,
+          USE_CLIENT_LOGICS,
+          USE_AGNOSTIC_LOGICS,
+          USE_SERVER_COMPONENTS,
+          USE_CLIENT_COMPONENTS,
+          USE_AGNOSTIC_COMPONENTS,
+          USE_SERVER_FUNCTIONS,
+          USE_CLIENT_CONTEXTS,
+          USE_AGNOSTIC_CONDITIONS,
+        ],
+      },
+      {
+        // importedName
+        type: "string",
+      },
+    ],
+    messages: {},
+  },
+  create: (context) => {
+    return {
+      // for hobbyists
+      ExportSpecifier: (node) => {
+        console.log("verify-specifier-import-export-same-strategy");
+        console.log(node.exported.name);
+        console.log(node);
+      },
+      // for people who drink their coffee black and their ASTs recursive
+      ExportNamedDeclaration: (node) => {
+        console.log("verify-specifier-import-export-same-strategy");
+        console.log("ExportNamedDeclaration");
+        console.log(node);
+      },
+    };
+  },
+};
+
+export default rule; // verify-specifier-import-export-same-strategy

package/library/directive21/crossingStrategies/config.js

@@ -0,0 +1,67 @@
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+
+import {
+  strategiesPluginName,
+  verifySpecifierImportRuleName,
+  verifyDefaultImportRuleName,
+  verifyNamespaceImportRuleName,
+} from "../../_commons/constants/bases.js";
+import {
+  USE_SERVER_LOGICS,
+  USE_CLIENT_LOGICS,
+  USE_AGNOSTIC_LOGICS,
+  USE_SERVER_COMPONENTS,
+  USE_CLIENT_COMPONENTS,
+  USE_AGNOSTIC_COMPONENTS,
+  USE_SERVER_FUNCTIONS,
+  USE_CLIENT_CONTEXTS,
+  USE_AGNOSTIC_CONDITIONS,
+} from "../_commons/constants/bases.js";
+
+import strategies from "./_commons/plugins/strategies.js";
+
+// The name of the config is `crossingStrategies`.
+// This is the crossingStrategies config.
+
+/**
+ * Makes the crossingStrategies config for specifiers, defaults, and namespaces.
+ * @param {"specifiers" | "defaults" | "namespaces"} type The type of the returned config, either "specifiers", "defaults", or "namespaces".
+ * @param {USE_SERVER_LOGICS | USE_CLIENT_LOGICS | USE_AGNOSTIC_LOGICS | USE_SERVER_COMPONENTS | USE_CLIENT_COMPONENTS | USE_AGNOSTIC_COMPONENTS | USE_SERVER_FUNCTIONS | USE_CLIENT_CONTEXTS | USE_AGNOSTIC_CONDITIONS} option1 importingFileCommentedDirective as option 1. (The strategy on the importing file.)
+ * @param {string | null} option2 importedName as option2 (The specifier's name on the importing file. Undefined when unnecessary.)
+ */
+export const makeCrossingStrategiesConfig = (type, option1, option2) => {
+  let ruleName = "";
+
+  switch (type) {
+    case "specifiers":
+      ruleName = verifySpecifierImportRuleName;
+      break;
+    case "defaults":
+      ruleName = verifyDefaultImportRuleName;
+      break;
+    case "namespaces":
+      ruleName = verifyNamespaceImportRuleName;
+      break;
+    default:
+      console.error(
+        "Type should only be 'specifiers', 'defaults', or 'namespaces'. This error should never be printed."
+      );
+      return [];
+  }
+
+  return defineConfig([
+    {
+      plugins: {
+        [strategiesPluginName]: strategies,
+      },
+      rules: {
+        [`${strategiesPluginName}/${ruleName}`]: ["warn", option1, option2],
+      },
+      languageOptions: {
+        // for compatibility with .ts and .tsx
+        parser: tseslint.parser,
+      },
+    },
+  ]);
+};

package/library/index.js

@@ -5,8 +5,8 @@ import {
   enforceCommentedDirectivesRuleName,
 } from "./_commons/constants/bases.js";
 
-import enforceEffectiveDirectivesImportRules from "./agnostic20/rules/import-rules-enforcement.js";
-import enforceCommentedDirectivesImportRules from "./directive21/rules/import-rules-enforcement.js";
+import enforceEffectiveDirectivesImportRules from "./agnostic20/_commons/rules/import-rules.js";
+import enforceCommentedDirectivesImportRules from "./directive21/_commons/rules/import-rules.js";
 
 import { makeAgnostic20Config } from "./agnostic20/config.js";
 import { makeDirective21Config } from "./directive21/config.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-use-agnostic",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "description": "Highlights problematic server-client imports in projects made with the Fullstack React Architecture.",
   "keywords": [
     "eslint",
@@ -30,12 +30,17 @@
     "type": "git",
     "url": "git+https://github.com/LutherTS/eslint-plugin-use-agnostic.git"
   },
+  "scripts": {
+    "test": "node tests/agnostic20/import-rules.test.js"
+  },
   "dependencies": {
-    "tsconfig-paths": "^4.2.0"
+    "tsconfig-paths": "^4.2.0",
+    "typescript-eslint": "^8.32.0"
   },
   "devDependencies": {
     "@typescript-eslint/utils": "^8.31.1",
-    "eslint": ">=9.0.0"
+    "eslint": ">=9.0.0",
+    "typescript": "^5.8.3"
   },
   "peerDependencies": {
     "eslint": ">=9.0.0"