eslint-plugin-use-agnostic 1.4.1 → 1.5.0

package/comments.config.json

@@ -1652,6 +1652,26 @@
       }
     },
     "forComposedVariables": {
+      "shouldNeverClient": {
+        "value": "should never leak to the client.",
+        "key": "AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT",
+        "placeholder": "$COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT"
+      },
+      "shouldNeverServer": {
+        "value": "should never leak to the server.",
+        "key": "AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER",
+        "placeholder": "$COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER"
+      },
+      "runServerLikeClient": {
+        "value": "can run safely on the server just like they can on the client.",
+        "key": "AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT",
+        "placeholder": "$COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT"
+      },
+      "runClientLikeServer": {
+        "value": "can run safely on the client just like they can on the server.",
+        "key": "AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER",
+        "placeholder": "$COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER"
+      },
       "canComposeOneAnother": {
         "value": "can compose with one another.",
         "key": "AGNOSTIC20#FORCOMPOSEDVARIABLES#CANCOMPOSEONEANOTHER",
@@ -2643,6 +2663,26 @@
       }
     },
     "forComposedVariables": {
+      "shouldNeverClient": {
+        "value": "should never leak to the client.",
+        "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT",
+        "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT"
+      },
+      "shouldNeverServer": {
+        "value": "should never leak to the server.",
+        "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER",
+        "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER"
+      },
+      "runServerLikeClient": {
+        "value": "can run safely on the server just like they can on the client.",
+        "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT",
+        "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT"
+      },
+      "runClientLikeServer": {
+        "value": "can run safely on the client just like they can on the server.",
+        "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER",
+        "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER"
+      },
       "canComposeOneAnother": {
         "value": "can compose with one another.",
         "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCOMPOSEONEANOTHER",
@@ -2773,15 +2813,15 @@
         "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTCOMPONENTS",
         "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTCOMPONENTS"
       },
-      "canServerLikeClient": {
+      "renderServerLikeClient": {
         "value": "can render safely on the server just like they can on the client.",
-        "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#CANSERVERLIKECLIENT",
-        "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANSERVERLIKECLIENT"
+        "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERSERVERLIKECLIENT",
+        "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERSERVERLIKECLIENT"
       },
-      "canClientLikeServer": {
+      "renderClientLikeServer": {
         "value": "can render safely on the client just like they can on the server.",
-        "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTLIKESERVER",
-        "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTLIKESERVER"
+        "key": "DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERCLIENTLIKESERVER",
+        "placeholder": "$COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERCLIENTLIKESERVER"
       }
     }
   }

package/jscomments/_commons/constants/bases.js

@@ -1,3 +1,5 @@
+// now obsolete
+
 import url from "url";
 import path from "path";
 

package/jscomments/_commons/constants/data.js

@@ -0,0 +1,6 @@
+/** @typedef {import("../../../comments.config.mjs").ResolvedConfigData} ResolvedConfigData */
+
+import { resolvedConfigData } from "../../../comments.config.mjs";
+
+/** @type {ResolvedConfigData} */
+export const commentVariablesData = resolvedConfigData;

package/jscomments/agnostic20/comments.js

@@ -18,13 +18,13 @@ export const agnostic20Comments = Object.freeze({
   "use agnostic components": agnosticComponentsComments,
   forAliasVariables: Object.freeze({
     serverNeverClient:
-      "Server Logics should never leak to the client." /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#SERVERNEVERCLIENT */,
+      "$COMMENT#AGNOSTIC20#USE_SERVER_LOGICS#KINDS $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT" /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#SERVERNEVERCLIENT */,
     clientNeverServer:
-      "Client Logics should never leak to the server." /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#CLIENTNEVERSERVER */,
+      "$COMMENT#AGNOSTIC20#USE_CLIENT_LOGICS#KINDS $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER" /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#CLIENTNEVERSERVER */,
     agnosticCanServerClient:
-      "Agnostic Logics can run safely on the server just like they can on the client." /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#AGNOSTICCANSERVERCLIENT */,
+      "$COMMENT#AGNOSTIC20#USE_AGNOSTIC_LOGICS#KINDS $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT" /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#AGNOSTICCANSERVERCLIENT */,
     agnosticCanClientServer:
-      "Agnostic Logics can run safely on the client just like they can on the server." /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#AGNOSTICCANCLIENTSERVER */,
+      "$COMMENT#AGNOSTIC20#USE_AGNOSTIC_LOGICS#KINDS $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER" /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#AGNOSTICCANCLIENTSERVER */,
     serverFunctionsNoComponents:
       "Server Functions have no business working with React Components." /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#SERVERFUNCTIONSNOCOMPONENTS */,
     serverLogicsCantBoth:
@@ -33,6 +33,14 @@ export const agnostic20Comments = Object.freeze({
       "$COMMENT#AGNOSTIC20#USE_CLIENT_LOGICS#KINDS $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#CANTSERVERCLIENT" /* $COMMENT#AGNOSTIC20#FORALIASVARIABLES#CLIENTLOGICSCANTBOTH */,
   }),
   forComposedVariables: Object.freeze({
+    shouldNeverClient:
+      "should never leak to the client." /* $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT */,
+    shouldNeverServer:
+      "should never leak to the server." /* $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER */,
+    runServerLikeClient:
+      "can run safely on the server just like they can on the client." /* $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT */,
+    runClientLikeServer:
+      "can run safely on the client just like they can on the server." /* $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER */,
     canComposeOneAnother:
       "can compose with one another." /* $COMMENT#AGNOSTIC20#FORCOMPOSEDVARIABLES#CANCOMPOSEONEANOTHER */,
     cantTinkeredServer:

package/jscomments/directive21/comments.js

@@ -24,13 +24,13 @@ export const directive21Comments = Object.freeze({
   "use agnostic strategies": agnosticStrategiesComments,
   forAliasVariables: Object.freeze({
     serverNeverClient:
-      "Prime Server Logics should never leak to the client." /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#SERVERNEVERCLIENT */,
+      "$COMMENT#DIRECTIVE21#USE_SERVER_LOGICS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT" /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#SERVERNEVERCLIENT */,
     clientNeverServer:
-      "Prime Client Logics should never leak to the server." /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#CLIENTNEVERSERVER */,
+      "$COMMENT#DIRECTIVE21#USE_CLIENT_LOGICS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER" /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#CLIENTNEVERSERVER */,
     agnosticCanServerClient:
-      "Prime Agnostic Logics can run safely on the server just like they can on the client." /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#AGNOSTICCANSERVERCLIENT */,
+      "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_LOGICS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT" /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#AGNOSTICCANSERVERCLIENT */,
     agnosticCanClientServer:
-      "Prime Agnostic Logics can run safely on the client just like they can on the server." /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#AGNOSTICCANCLIENTSERVER */,
+      "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_LOGICS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER" /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#AGNOSTICCANCLIENTSERVER */,
     serverFunctionsNoComponents:
       "(Special) Server Functions have no business working with React Components." /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#SERVERFUNCTIONSNOCOMPONENTS */,
     serverLogicsCantBoth:
@@ -40,11 +40,19 @@ export const directive21Comments = Object.freeze({
     agnosticComponentsCanAny:
       "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_COMPONENTS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANANYPRIMELOGICS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#NOEXPORTCOMPONENTS" /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#AGNOSTICCOMPONENTSCANANY */,
     agnosticComponentsRenderAny:
-      "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_COMPONENTS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTLIKESERVER" /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#AGNOSTICCOMPONENTSRENDERANY */,
+      "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_COMPONENTS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERCLIENTLIKESERVER" /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#AGNOSTICCOMPONENTSRENDERANY */,
     serverFunctionsClient:
       "$COMMENT#DIRECTIVE21#USE_SERVER_FUNCTIONS#SPECIALS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTCOMPONENTS" /* $COMMENT#DIRECTIVE21#FORALIASVARIABLES#SERVERFUNCTIONSCLIENT */,
   }),
   forComposedVariables: Object.freeze({
+    shouldNeverClient:
+      "AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT" /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#SHOULDNEVERCLIENT */,
+    shouldNeverServer:
+      "AGNOSTIC20#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER" /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#SHOULDNEVERSERVER */,
+    runServerLikeClient:
+      "AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT" /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RUNSERVERLIKECLIENT */,
+    runClientLikeServer:
+      "AGNOSTIC20#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER" /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RUNCLIENTLIKESERVER */,
     canComposeOneAnother:
       "AGNOSTIC20#FORCOMPOSEDVARIABLES#CANCOMPOSEONEANOTHER" /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCOMPOSEONEANOTHER */,
     cantTinkeredServer:
@@ -97,9 +105,11 @@ export const directive21Comments = Object.freeze({
       "when the root of the application is planted on the server." /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#WHENROOTONSERVER */,
     canClientComponents:
       "can be specifically triggered by Client Components." /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTCOMPONENTS */,
-    canServerLikeClient:
-      "can render safely on the server just like they can on the client." /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANSERVERLIKECLIENT */,
-    canClientLikeServer:
-      "can render safely on the client just like they can on the server." /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTLIKESERVER */,
+    // renderServerLikeClient
+    renderServerLikeClient:
+      "can render safely on the server just like they can on the client." /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERSERVERLIKECLIENT */,
+    // renderClientLikeServer
+    renderClientLikeServer:
+      "can render safely on the client just like they can on the server." /* $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERCLIENTLIKESERVER */,
   }),
 });

package/jscomments/directive21/modules-comments.js

@@ -115,13 +115,13 @@ export const serverComponentsComments = Object.freeze({
   "use client components":
     /* valid */ "$COMMENT#DIRECTIVE21#USE_CLIENT_COMPONENTS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANBENESTEDINSIDE $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#TOCREATEBOUNDARIES $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#WHENROOTONSERVER" /* $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#USE_CLIENT_COMPONENTS */,
   "use agnostic components":
-    /* valid */ "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_COMPONENTS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANSERVERLIKECLIENT" /* $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#USE_AGNOSTIC_COMPONENTS */,
+    /* valid */ "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_COMPONENTS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERSERVERLIKECLIENT" /* $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#USE_AGNOSTIC_COMPONENTS */,
   "use server functions":
     /* valid */ "(Special) Server Functions can be passed to imported Client Components within Lineal Server Components Modules, even though indeed Lineal Server Components Modules and Lineal Server Components can make their own Server Functions through inline `'use server'` directives." /* $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#USE_SERVER_FUNCTIONS */,
   "use client contexts":
     /* valid */ "$COMMENT#DIRECTIVE21#USE_CLIENT_CONTEXTS#SPECIALS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANBENESTEDINSIDE $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#KINDS $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#TOWRAPTREE $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#WHENROOTONSERVER" /* $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#USE_CLIENT_CONTEXTS */,
   "use agnostic conditions":
-    /* valid */ "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_CONDITIONS#SPECIALSCOMMA $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#ASIFLINEALAGNOSTIC $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANSERVERLIKECLIENT" /* $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#USE_AGNOSTIC_CONDITIONS */,
+    /* valid */ "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_CONDITIONS#SPECIALSCOMMA $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#ASIFLINEALAGNOSTIC $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERSERVERLIKECLIENT" /* $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#USE_AGNOSTIC_CONDITIONS */,
   kinds:
     "Lineal Server Components" /* $COMMENT#DIRECTIVE21#USE_SERVER_COMPONENTS#KINDS */,
   kindsComma:
@@ -156,7 +156,7 @@ export const clientComponentsComments = Object.freeze({
   "use client contexts":
     /* valid */ "(Special) Client Contexts Components can effectively become Lineal and only render their children on the client via this mechanism since, by a Client Contexts Component being the child of a Lineal Client Component, the Client Contexts Component's children become the grandchildren of an ancestor Lineal Client Component, enforcing them to render exclusively on the client." /* $COMMENT#DIRECTIVE21#USE_CLIENT_COMPONENTS#USE_CLIENT_CONTEXTS */,
   "use agnostic conditions":
-    /* valid */ "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_CONDITIONS#SPECIALSCOMMA $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#ASIFLINEALAGNOSTIC $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#CANCLIENTLIKESERVER" /* $COMMENT#DIRECTIVE21#USE_CLIENT_COMPONENTS#USE_AGNOSTIC_CONDITIONS */,
+    /* valid */ "$COMMENT#DIRECTIVE21#USE_AGNOSTIC_CONDITIONS#SPECIALSCOMMA $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#ASIFLINEALAGNOSTIC $COMMENT#DIRECTIVE21#FORCOMPOSEDVARIABLES#RENDERCLIENTLIKESERVER" /* $COMMENT#DIRECTIVE21#USE_CLIENT_COMPONENTS#USE_AGNOSTIC_CONDITIONS */,
   module:
     "Lineal Client Components Module" /* $COMMENT#DIRECTIVE21#USE_CLIENT_COMPONENTS#MODULE */,
   modulePeriod:

package/library/agnostic20/_commons/constants/bases.js

@@ -11,7 +11,8 @@ import {
 
 import { makeIntroForSpecificViolationMessage } from "../../../_commons/utilities/helpers.js";
 
-import { resolvedConfigData } from "../../../../jscomments/_commons/constants/bases.js";
+// import { resolvedConfigData } from "../../../../jscomments/_commons/constants/bases.js";
+import { commentVariablesData } from "../../../../jscomments/_commons/constants/data.js";
 
 /**
  * @typedef {import('../../../../types/agnostic20/_commons/typedefs.js').Directive} Directive
@@ -106,7 +107,7 @@ export const makeBlockedImport = (
       currentFileEffectiveDirective,
       importedFileEffectiveDirective
     )} ${
-      resolvedConfigData[agnostic20ConfigName][currentFileEffectiveDirective][
+      commentVariablesData[agnostic20ConfigName][currentFileEffectiveDirective][
         importedFileEffectiveDirective
       ].value
     }`,

package/library/directive21/_commons/constants/bases.js

@@ -14,7 +14,8 @@ import {
 
 import { makeIntroForSpecificViolationMessage } from "../../../_commons/utilities/helpers.js";
 
-import { resolvedConfigData } from "../../../../jscomments/_commons/constants/bases.js";
+// import { resolvedConfigData } from "../../../../jscomments/_commons/constants/bases.js";
+import { commentVariablesData } from "../../../../jscomments/_commons/constants/data.js";
 
 /**
  * @typedef {import('../../../../types/directive21/_commons/typedefs.js').CommentedDirective} CommentedDirective
@@ -162,9 +163,9 @@ export const makeBlockedImport = (
       currentFileCommentedDirective,
       importedFileCommentedDirective
     )} ${
-      resolvedConfigData[directive21ConfigName][currentFileCommentedDirective][
-        importedFileCommentedDirective
-      ].value
+      commentVariablesData[directive21ConfigName][
+        currentFileCommentedDirective
+      ][importedFileCommentedDirective].value
     }`,
   });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-use-agnostic",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Highlights problematic server-client imports in projects made with the Fullstack React Architecture.",
   "keywords": [
     "eslint",