eslint-plugin-use-agnostic 1.2.0 → 1.2.2

package/comments.config.js

@@ -12,9 +12,7 @@ import { directive21Comments } from "./jscomments/directive21/constants/bases.js
 
 const config = Object.freeze({
   jsDoc: jSDocComments,
-  // ...jSDocComments,
   tests: testsComments,
-  // ...testsComments,
   [agnostic20ConfigName]: agnostic20Comments,
   [directive21ConfigName]: directive21Comments,
 });
@@ -22,7 +20,7 @@ const config = Object.freeze({
 export default config;
 
 /* Notes
-comment: "comment", // $COMMENT#COMMENT in code, "comment" on hover when resolved by the VSCode extension JSComments
+comment: "comment", // $COMMENT#COMMENT in code, "comment" on hover when resolved by the VSCode extension JSComments (Comment Variables)
 Aims of the VSCode extension JSComments: 
 - automatically capitalizes keys, so here: 
   - config.comment would return $COMMENT#COMMENT
@@ -30,4 +28,5 @@ Aims of the VSCode extension JSComments:
   - 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
+A working CLI is already on npm: comment-variables.
 */

package/jscomments/_commons/constants/bases.js

@@ -1,12 +1,12 @@
 // comment variables for JSDoc definitions
 export const jSDocComments = Object.freeze({
   // library/_commons/utilities/helpers.js
-  basePath: "The absolute import path with extension yet resolved.",
+  basePath: "The absolute import path with its extension yet resolved.",
   currentDir:
-    "The directory of the file containing the import (from `path.dirname(context.filename)`).",
+    "The directory of the file containing the import, such as from `path.dirname(context.filename)`.",
   importPath:
-    "The import specifier (e.g., `@/components/Button` or `./utils`), from the current node.",
-  cwd: "The project root (from `context.cwd`).",
+    "The import specifier (e.g., `@/components/Button` or `./utils`), such as one from the current node.",
+  cwd: "The project root, such as from `context.cwd`.",
   fileResolvedPath: "The resolved path of the file.",
   aContext: "An ESLint rule's `context` object.",
   resolvedDirectives_blockedImports: `The blocked imports object, either for agnostic20 or for directive21.`,

package/library/_commons/utilities/helpers.js

@@ -1,14 +1,6 @@
-import fs from "fs";
-import path from "path";
-
-import { Linter } from "eslint";
-import { loadConfig, createMatchPath } from "tsconfig-paths";
-
 import {
-  EXTENSIONS,
   ARE_NOT_ALLOWED_TO_IMPORT,
   resolvedDirectives_resolvedModules,
-  typeScriptAndJSXCompatible,
 } from "../constants/bases.js";
 
 /**
@@ -22,86 +14,6 @@ import {
  * @typedef {import('../../../types/_commons/typedefs').ResolvedDirectives_BlockedImports<T, U>} ResolvedDirectives_BlockedImports
  */
 
-/* resolveImportPath */
-
-/**
- * Finds the existing path of an import that does not have an extension specified.
- * @param {string} basePath The absolute import path with extension yet resolved.
- * @returns The absolute path with its extension or `null` if no path is found.
- */
-const findExistingPath = (basePath) => {
-  for (const ext of EXTENSIONS) {
-    const fullPath = `${basePath}${ext}`;
-    if (fs.existsSync(fullPath)) return fullPath;
-  }
-  return null;
-};
-
-/**
- * Resolves an import path to a filesystem path, handling:
- * - Base url and aliases (via tsconfig.json `baseUrl` and `paths` compiler options)
- * - Missing extensions (appends `.ts`, `.tsx`, etc.)
- * - Directory imports (e.g., `./components` → `./components/index.ts`)
- * @param {string} currentDir The directory of the file containing the import (from `path.dirname(context.filename)`).
- * @param {string} importPath The import specifier (e.g., `@/components/Button` or `./utils`), from the current node.
- * @param {string} cwd The project root (from `context.cwd`).
- * @returns The absolute resolved path or `null` if no path is found.
- */
-export const resolveImportPath = (currentDir, importPath, cwd) => {
-  // Step 1: Resolves baseUrl and aliases
-  const config = loadConfig(cwd);
-
-  const resolveTSConfig =
-    config.resultType === "success"
-      ? createMatchPath(config.absoluteBaseUrl, config.paths)
-      : null;
-
-  const baseUrlOrAliasedPath = resolveTSConfig
-    ? resolveTSConfig(importPath, undefined, undefined, EXTENSIONS)
-    : null;
-
-  // Step 2: Resolves relative/absolute paths
-  const basePath = baseUrlOrAliasedPath || path.resolve(currentDir, importPath);
-
-  // does not resolve on node_modules
-  if (basePath.includes("node_modules")) return null;
-
-  // Case 1: File with extension exists
-  if (path.extname(importPath) && fs.existsSync(basePath)) return basePath;
-
-  // Case 2: Tries appending extensions
-  const extensionlessImportPath = findExistingPath(basePath);
-  if (extensionlessImportPath) return extensionlessImportPath;
-
-  // Case 3: Directory import (e.g., `./components` → `./components/index.ts`)
-  const indexPath = path.join(basePath, "index");
-  const directoryImportPath = findExistingPath(indexPath);
-  if (directoryImportPath) return directoryImportPath;
-
-  return null; // not found
-};
-
-/* getSourceCodeFromFilePath */
-
-/**
- * Gets the ESLint-generated SourceCode object of a file from its resolved path.
- * @param {string} resolvedPath The resolved path of the file.
- * @returns The ESLint-generated SourceCode object of the file.
- */
-export const getSourceCodeFromFilePath = (resolvedPath) => {
-  // ensures each instance of the function is based on its own linter
-  // (just in case somehow some linters were running concurrently)
-  const linter = new Linter();
-  // the raw code of the file at the end of the resolved path
-  const text = fs.readFileSync(resolvedPath, "utf8");
-  // utilizes linter.verify ...
-  linter.verify(text, { languageOptions: typeScriptAndJSXCompatible });
-  // ... to retrieve the raw code as a SourceCode object
-  const code = linter.getSourceCode();
-
-  return code;
-};
-
 /* highlightFirstLineOfCode */
 
 /**

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

@@ -1,5 +1,7 @@
 import path from "path";
 
+import { resolveImportingPath } from "resolve-importing-path";
+
 import {
   EXTENSIONS,
   useServerJSXMessageId,
@@ -16,10 +18,7 @@ import {
   specificViolationMessage,
 } from "../constants/bases.js";
 
-import {
-  resolveImportPath,
-  highlightFirstLineOfCode,
-} from "../../../_commons/utilities/helpers.js";
+import { highlightFirstLineOfCode } from "../../../_commons/utilities/helpers.js";
 import {
   getDirectiveFromCurrentModule,
   getDirectiveFromImportedModule,
@@ -104,7 +103,7 @@ const importedFileFlow = (context, node) => {
   const skipTrue = { ...skip, importedFileEffectiveDirective: undefined };
 
   // finds the full path of the import
-  const resolvedImportPath = resolveImportPath(
+  const resolvedImportPath = resolveImportingPath(
     path.dirname(context.filename),
     node.source.value,
     context.cwd

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

@@ -1,3 +1,5 @@
+import { getSourceCodeFromFilePath } from "get-sourcecode-from-file-path";
+
 import {
   USE_SERVER,
   LOGICS,
@@ -12,7 +14,6 @@ import {
   isImportBlocked as commonsIsImportBlocked,
   makeMessageFromCurrentFileResolvedDirective,
   findSpecificViolationMessage as commonsFindSpecificViolationMessage,
-  getSourceCodeFromFilePath,
 } from "../../../_commons/utilities/helpers.js";
 
 /**

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

@@ -1,5 +1,7 @@
 import path from "path";
 
+import { resolveImportingPath } from "resolve-importing-path";
+
 import {
   EXTENSIONS,
   reExportNotSameMessageId,
@@ -19,10 +21,7 @@ import {
   specificFailure,
 } from "../constants/bases.js";
 
-import {
-  resolveImportPath,
-  highlightFirstLineOfCode,
-} from "../../../_commons/utilities/helpers.js";
+import { highlightFirstLineOfCode } from "../../../_commons/utilities/helpers.js";
 import {
   getCommentedDirectiveFromCurrentModule,
   getVerifiedCommentedDirective,
@@ -113,7 +112,7 @@ const importedFileFlow = (context, node) => {
   const skipTrue = { ...skip, importedFileCommentedDirective: undefined };
 
   // finds the full path of the import
-  const resolvedImportPath = resolveImportPath(
+  const resolvedImportPath = resolveImportingPath(
     path.dirname(context.filename),
     node.source.value,
     context.cwd

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

@@ -1,3 +1,5 @@
+import { getSourceCodeFromFilePath } from "get-sourcecode-from-file-path";
+
 import { exportNotStrategized } from "../../../_commons/constants/bases.js";
 import {
   USE_AGNOSTIC_STRATEGIES,
@@ -12,7 +14,6 @@ import {
   isImportBlocked as commonsIsImportBlocked,
   makeMessageFromCurrentFileResolvedDirective,
   findSpecificViolationMessage as commonsFindSpecificViolationMessage,
-  getSourceCodeFromFilePath,
 } from "../../../_commons/utilities/helpers.js";
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-use-agnostic",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Highlights problematic server-client imports in projects made with the Fullstack React Architecture.",
   "keywords": [
     "eslint",
@@ -41,6 +41,8 @@
     "test": "node tests/agnostic20/import-rules.test.js && node tests/directive21/import-rules.test.js"
   },
   "dependencies": {
+    "get-sourcecode-from-file-path": "^1.0.0",
+    "resolve-importing-path": "^1.0.2",
     "tsconfig-paths": "^4.2.0",
     "typescript-eslint": "^8.32.0"
   },