eslint-plugin-use-agnostic 0.1.2 → 0.3.1

package/README.md

@@ -1,3 +1,5 @@
 # eslint-plugin-use-agnostic
 
 eslint-plugin-use-agnostic highlights problematic server-client imports in projects made with the Fullstack React Architecture (Next.js App Router, etc.) based on each of their modules' derived effective directives through detailed import rule violations, thanks to the introduction of its very own 'use agnostic' directive.
+
+![First example of linting with the use-agnostic ESLint plugin](./first-screenshot.png)

package/library/agnostic20/constants/bases.js

@@ -87,6 +87,9 @@ const makeIntroForSpecificViolationMessage = (
     importedFileEffectiveDirective
   );
 
+const SUGGEST_USE_AGNOSTIC =
+  "If the module you're trying to import does not possess any server-side code however, please mark it with the 'use agnostic' directive to make it compatible across all environments.";
+
 export const effectiveDirectives_BlockedImports = Object.freeze({
   [USE_SERVER_LOGICS]: [
     // USE_SERVER_LOGICS allowed, because Server Logics can compose with one another.
@@ -163,14 +166,16 @@ export const effectiveDirectives_BlockedImports = Object.freeze({
       message: `${makeIntroForSpecificViolationMessage(
         USE_CLIENT_LOGICS,
         USE_SERVER_LOGICS
-      )} Server logic should never leak to the client.`,
+      )} Server logic should never leak to the client. 
+${SUGGEST_USE_AGNOSTIC}`,
     },
     {
       blockedImport: USE_SERVER_COMPONENTS,
       message: `${makeIntroForSpecificViolationMessage(
         USE_CLIENT_LOGICS,
         USE_SERVER_COMPONENTS
-      )} Server Components cannot be thinkered with on the client.`,
+      )} Server Components cannot be thinkered with on the client. 
+${SUGGEST_USE_AGNOSTIC}`,
     },
     // USE_SERVER_FUNCTIONS allowed, because it is technically feasible to tinker with a Client Component within a Client Logics Module and attach to said Client Component a Server Function to be triggered on the client.
     // USE_CLIENT_LOGICS allowed, because Client Logics can compose with one another.
@@ -184,14 +189,16 @@ export const effectiveDirectives_BlockedImports = Object.freeze({
       message: `${makeIntroForSpecificViolationMessage(
         USE_CLIENT_COMPONENTS,
         USE_SERVER_LOGICS
-      )} Server logic should never leak to the client.`,
+      )} Server logic should never leak to the client. 
+${SUGGEST_USE_AGNOSTIC}`,
     },
     {
       blockedImport: USE_SERVER_COMPONENTS,
       message: `${makeIntroForSpecificViolationMessage(
         USE_CLIENT_COMPONENTS,
         USE_SERVER_COMPONENTS
-      )} Server Components may only pass through Client Components through the children prop within Server Components Modules.`,
+      )} Server Components may only pass through Client Components through the children prop within Server Components Modules. 
+${SUGGEST_USE_AGNOSTIC}`,
     },
     // USE_SERVER_FUNCTIONS allowed, because Server Functions are specifically triggered by Client Components.
     // USE_CLIENT_LOGICS allowed, because logic from the client can safely support Client Components.
@@ -205,14 +212,16 @@ export const effectiveDirectives_BlockedImports = Object.freeze({
       message: `${makeIntroForSpecificViolationMessage(
         USE_AGNOSTIC_LOGICS,
         USE_SERVER_LOGICS
-      )} Server Logic cannot run in both the server and the client.`,
+      )} Server Logic cannot run in both the server and the client. 
+${SUGGEST_USE_AGNOSTIC}`,
     },
     {
       blockedImport: USE_SERVER_COMPONENTS,
       message: `${makeIntroForSpecificViolationMessage(
         USE_AGNOSTIC_LOGICS,
         USE_SERVER_COMPONENTS
-      )} Server Components cannot be tinkered with on both the server and the client.`,
+      )} Server Components cannot be tinkered with on both the server and the client. 
+${SUGGEST_USE_AGNOSTIC}`,
     },
     {
       blockedImport: USE_SERVER_FUNCTIONS,
@@ -244,14 +253,16 @@ export const effectiveDirectives_BlockedImports = Object.freeze({
       message: `${makeIntroForSpecificViolationMessage(
         USE_AGNOSTIC_COMPONENTS,
         USE_SERVER_LOGICS
-      )} Server Logic cannot run in both the server and the client.`,
+      )} Server Logic cannot run in both the server and the client. 
+${SUGGEST_USE_AGNOSTIC}`,
     },
     {
       blockedImport: USE_SERVER_COMPONENTS,
       message: `${makeIntroForSpecificViolationMessage(
         USE_AGNOSTIC_COMPONENTS,
         USE_SERVER_COMPONENTS
-      )} Unlike Client Components, Server Components cannot make silos of their own once on the client, and can therefore not be executed from the client.`,
+      )} Unlike Client Components, Server Components cannot make silos of their own once on the client, and can therefore not be executed from the client. 
+${SUGGEST_USE_AGNOSTIC}`,
     },
     // USE_SERVER_FUNCTIONS allowed, because as Agnostic Components Modules can import Client Components, they are able to pass them Server Functions as props as well.
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-use-agnostic",
-  "version": "0.1.2",
+  "version": "0.3.1",
   "description": "Highlights problematic server-client imports in projects made with the Fullstack React Architecture.",
   "keywords": [
     "eslint",
@@ -11,7 +11,11 @@
     "next-js",
     "remix",
     "reactrouter",
-    "react-router"
+    "react-router",
+    "fullstack",
+    "server",
+    "client",
+    "agnostic"
   ],
   "license": "MIT",
   "author": "Luther Tchofo Safo <luther@tchofo-safo-portfolio.me>",