eslint-plugin-use-agnostic 0.11.3 → 0.11.4

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

@@ -46,9 +46,9 @@ import {
 /* currentFileFlow */
 
 /**
- * The flow that begins the import rules enforcement rule, retrieving the valid directive of the current file before comparing it to upcoming valid directives of the files it imports.
+ * The flow that begins the import rules enforcement rule, retrieving the verified commented directive of the current file before comparing it to upcoming verified commented directives of the files it imports.
  * @param {Context} context The ESLint rule's `context` object.
- * @returns Either an object with `skip: true` to disregard or one with the non-null `verifiedCommentedDirective`. ()
+ * @returns Either an object with `skip: true` to disregard or one with the non-null `verifiedCommentedDirective`.
  */
 export const currentFileFlow = (context) => {
   const skipTrue = { ...skip, verifiedCommentedDirective: undefined };
@@ -135,7 +135,7 @@ const importedFileFlow = (context, node) => {
   if (!importedFileCommentedDirective) {
     console.warn(
       "WARNING. The imported file, whose path has been resolved, has no directive. It is thus ignored since the report on that circumstance is available on the imported file itself."
-    );
+    ); // The decision not to report has been taken to not inflate the number of warnings.
     return skipTrue;
   }
 

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

@@ -32,8 +32,8 @@ import {
 
 /**
  * Detects whether a string is single- or double-quoted.
- * @param {string} string
- * @returns
+ * @param {string} string The original string.
+ * @returns `true` if single-quoted, `false` if double-quoted, `null` if neither.
  */
 const detectQuoteType = (string) => {
   if (string.startsWith("'") && string.endsWith("'")) {
@@ -47,8 +47,8 @@ const detectQuoteType = (string) => {
 
 /**
  * Removes single quotes from a string known to be single-quoted.
- * @param {string} string
- * @returns
+ * @param {string} string The original string.
+ * @returns The string with quotes removed.
  */
 const stripSingleQuotes = (string) => {
   if (string.startsWith("'") && string.endsWith("'")) {
@@ -59,8 +59,8 @@ const stripSingleQuotes = (string) => {
 
 /**
  * Removes double quotes from a string known to be double-quoted.
- * @param {string} string
- * @returns
+ * @param {string} string The original string.
+ * @returns The string with quotes removed.
  */
 const stripDoubleQuotes = (string) => {
   if (string.startsWith('"') && string.endsWith('"')) {
@@ -224,8 +224,9 @@ export const getStrategizedDirective = (context, node) => {
 /**
  * Returns a boolean deciding if an imported file's commented directive is incompatible with the current file's commented directive.
  * @template {CommentedDirectiveWithoutUseAgnosticStrategies} T
+ * @template {CommentedDirectiveWithoutUseAgnosticStrategies} U
  * @param {T} currentFileCommentedDirective The current file's commented directive.
- * @param {T} importedFileCommentedDirective The imported file's commented directive.
+ * @param {U} importedFileCommentedDirective The imported file's commented directive.
  * @returns `true` if the import is blocked, as established in `commentedDirectives_BlockedImports`.
  */
 export const isImportBlocked = (
@@ -258,8 +259,9 @@ export const makeMessageFromCurrentFileCommentedDirective = (
 /**
  * Finds the `message` for the specific violation of commented directives import rules based on `commentedDirectives_BlockedImports`.
  * @template {CommentedDirectiveWithoutUseAgnosticStrategies} T
+ * @template {CommentedDirectiveWithoutUseAgnosticStrategies} U
  * @param {T} currentFileCommentedDirective The current file's commented directive.
- * @param {T} importedFileCommentedDirective The imported file's commented directive.
+ * @param {U} importedFileCommentedDirective The imported file's commented directive.
  * @returns The corresponding `message`.
  */
 export const findSpecificViolationMessage = (
@@ -275,11 +277,11 @@ export const findSpecificViolationMessage = (
 /* addressDirectiveIfAgnosticStrategies */
 
 /**
- * Verifies the current node's export strategy if `"use agnostic strategies"` by reporting `exportNotStrategized` in case an export is not strategized in an Agnostic Strategies Module.
+ * Verifies the current node's export strategy if the current commented directive is `"use agnostic strategies"` by reporting `exportNotStrategized` in case an export is not strategized in an Agnostic Strategies Module.
  * @param {Context} context The ESLint rule's `context` object.
  * @param {ExportNamedDeclaration | ExportAllDeclaration | ExportDefaultDeclaration} node The ESLint `node` of the rule's current traversal.
  * @param {CommentedDirective} currentFileCommentedDirective The current file's commented directive.
- * @returns The commented directive, the addressed strategy (as a commented directive) or null in case of failure.
+ * @returns The commented directive, the addressed strategy (as a commented directive) or `null` in case of failure.
  */
 export const addressDirectiveIfAgnosticStrategies = (
   context,

package/package.json

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