eslint-plugin-use-agnostic 0.10.5 → 0.10.7

package/comments.config.js

@@ -0,0 +1,25 @@
+import {
+  agnostic20ConfigName,
+  directive21ConfigName,
+} from "./library/_commons/constants/bases.js";
+
+import { agnostic20Comments } from "./jscomments/agnostic20/constants/bases.js";
+import { directive21Comments } from "./jscomments/directive21/constants/bases.js";
+
+const config = Object.freeze({
+  comment: "comment", // $COMMENT#COMMENT in code, "comment" on hover when resolved by the VSCode extension JSComments
+  [agnostic20ConfigName]: agnostic20Comments,
+  [directive21ConfigName]: directive21Comments,
+});
+
+export default config;
+
+/* Notes
+Aims of the VSCode extension JSComments: 
+- automatically capitalizes keys, so here: 
+  - config.comment would return $COMMENT#COMMENT
+- automatically chain keys within keys, so here
+  - config["agnostic20"] would return $COMMENT#AGNOSTIC20#*
+  - config["directive21"] would return $COMMENT#DIRECTIVE21#*
+- this way, instead doing a find-replace on a big documentation comment, the comment stays within the config and only the config placeholder is found and replaced for the same results 
+*/

package/library/_commons/utilities/helpers.js

@@ -9,15 +9,8 @@ import {
   resolvedDirectives_resolvedModules,
 } from "../constants/bases.js";
 
-import jscommentsConfig from "../../../comments.config.js";
-
 /**
- * @typedef {import('../../../types/_commons/typedefs').EffectiveDirective} EffectiveDirective
- * @typedef {import('../../../types/_commons/typedefs').CommentedDirective} CommentedDirective
  * @typedef {import('../../../types/_commons/typedefs').ResolvedDirectiveWithoutUseAgnosticStrategies} ResolvedDirectiveWithoutUseAgnosticStrategies
- * @typedef {import('../../../types/_commons/typedefs').Agnostic20ConfigName} Agnostic20ConfigName
- * @typedef {import('../../../types/_commons/typedefs').Directive21ConfigName} Directive21ConfigName
- * @typedef {import('../../../types/_commons/typedefs').UseAgnosticConfigName} UseAgnosticConfigName
  * @typedef {import('../../../types/_commons/typedefs').Context<string, readonly unknown[]>} Context
  */
 

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

@@ -12,7 +12,7 @@ import {
   USE_AGNOSTIC_STRATEGIES as COMMONS_USE_AGNOSTIC_STRATEGIES,
 } from "../../../_commons/constants/bases.js";
 
-import { makeIntroForSpecificViolationMessage as commonsMakeIntroForSpecificViolationMessage } from "../../../_commons/utilities/helpers.js";
+import { makeIntroForSpecificViolationMessage } from "../../../_commons/utilities/helpers.js";
 
 import jscommentsConfig from "../../../../comments.config.js";
 
@@ -22,6 +22,7 @@ import jscommentsConfig from "../../../../comments.config.js";
  * @typedef {import('../../../../types/directive21/_commons/typedefs.js').CommentedDirectives} CommentedDirectives
  * @typedef {import('../../../../types/directive21/_commons/typedefs.js').CommentedStrategy} CommentedStrategy
  * @typedef {import('../../../../types/directive21/_commons/typedefs.js').CommentedStrategies} CommentedStrategies
+ * @typedef {import('../../../../types/directive21/_commons/typedefs.js').CommentStyles} CommentStyles
  */
 
 // commented directives
@@ -56,7 +57,7 @@ export const commentedDirectivesArray = Object.freeze([
 export const commentedDirectivesSet = new Set(commentedDirectivesArray); // no longer used exported to satisfy static type inference
 
 // mapped commented directives to their extension rules
-export const commentedDirectives_extensionRules = {
+export const commentedDirectives_extensionRules = Object.freeze({
   [USE_SERVER_LOGICS]: false, // Must not end with 'x'
   [USE_CLIENT_LOGICS]: false,
   [USE_AGNOSTIC_LOGICS]: false,
@@ -67,7 +68,7 @@ export const commentedDirectives_extensionRules = {
   [USE_CLIENT_CONTEXTS]: true,
   [USE_AGNOSTIC_CONDITIONS]: true,
   [USE_AGNOSTIC_STRATEGIES]: null, // Any extension allowed
-};
+});
 
 // commented strategies
 export const AT_SERVER_LOGICS = "@serverLogics";
@@ -121,23 +122,31 @@ export const specificFailure = "specificFailure";
 /* commentedDirectives_4RawImplementations */
 
 // all formatting styles as an array of [prefix, quote, suffix]
-const commentStyles = [
-  [`// `, `'`, ``], // V1: `// 'directive'`
-  [`// `, `"`, ``], // V2: `// "directive"`
-  [`/* `, `'`, ` */`], // V3: `/* 'directive' */`
-  [`/* `, `"`, ` */`], // V4: `/* "directive" */`
-]; // further inference optimation can be made but is overkill...
+/** @type {CommentStyles} */
+const commentStyles = Object.freeze([
+  Object.freeze([`// `, `'`, ``]), // V1: `// 'directive'`
+  Object.freeze([`// `, `"`, ``]), // V2: `// "directive"`
+  Object.freeze([`\/\* `, `'`, ` \*\/`]), // V3: `/* 'directive' */`
+  Object.freeze([`\/\* `, `"`, ` \*\/`]), // V4: `/* "directive" */`
+]);
 
 /**
  * Makes the array of all four accepted commented directive implementations on a directive basis.
- * @param {CommentedDirective} directive The commented directive.
+ * @template {CommentedDirective} T
+ * @param {T} directive The commented directive.
  * @returns The array of formatted commented directives.
  */
-const make4RawImplementations = (directive) =>
-  commentStyles.map(
-    ([prefix, quote, suffix]) =>
-      `${prefix}${quote}${directive}${quote}${suffix}`
-  ); // ...further inference optimation could be an extra challenge but would probably require TypeScript for comfort
+const make4RawImplementations = (directive) => {
+  /** @type {readonly [`// '${T}'`, `// "${T}""`, `\/\* '${T}' \*\/`, `\/\* "${T}"" \*\/`]} */
+  const rawImplementations = Object.freeze(
+    commentStyles.map(
+      ([prefix, quote, suffix]) =>
+        `${prefix}${quote}${directive}${quote}${suffix}`
+    )
+  );
+
+  return rawImplementations;
+};
 
 export const commentedDirectives_4RawImplementations = Object.freeze({
   [USE_SERVER_LOGICS]: make4RawImplementations(USE_SERVER_LOGICS),
@@ -189,7 +198,7 @@ export const makeBlockedImport = (
 ) => {
   return Object.freeze({
     blockedImport: importedFileCommentedDirective,
-    message: `${commonsMakeIntroForSpecificViolationMessage(
+    message: `${makeIntroForSpecificViolationMessage(
       currentFileCommentedDirective,
       importedFileCommentedDirective
     )} ${

package/library/directive21/_commons/utilities/flows.js

@@ -142,7 +142,7 @@ 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 an @clientLogics strategy could be wrongly imported and interpreted as an @serverLogics strategy.
   
-  After a short attempt, the feature to address this (crossingStrategies) is currently canceled, 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.
+  After a short attempt, the feature to address this (crossingStrategies) is currently canceled, mainly due to the exponential complexity provided by the different ways in which exports can be made in JavaScript.
   
   (Consequently, details below are currently at the stage of wishful thinking.)
   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 for all non-type exports to be named and PascalCase. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-use-agnostic",
-  "version": "0.10.5",
+  "version": "0.10.7",
   "description": "Highlights problematic server-client imports in projects made with the Fullstack React Architecture.",
   "keywords": [
     "eslint",
@@ -22,7 +22,8 @@
   "files": [
     "library",
     "types/index.d.ts",
-    "jscomments"
+    "jscomments",
+    "comments.config.js"
   ],
   "exports": {
     ".": {