eslint-plugin-use-agnostic 1.7.3 → 1.7.5

package/README.md

@@ -78,8 +78,6 @@ With this list established, it thus becomes possible to recognize static import
 
 ## Caveats
 
-Base url and aliased import paths are currently resolved under the assumption that `process.cwd()` and `context.cwd` have the same value.
-
 It is up to you to confirm that your Agnostic Modules are indeed agnostic, meaning that they have neither server- nor client-side code. `eslint-plugin-use-agnostic`, at least at this time, does not do this verification for you.
 
 It is also up to you to ensure, as outlined above, that **you avoid** exporting React components along with other logics within the same modules (unless you have to per the design of your current framework), which may derail the linting in some cases. Separating exporting React components within their own modules ending with a JSX file extension, from exporting other logics within modules that don't end with a JSX file extension, is crucial for distinguishing between Components Modules and Logics Modules respectively.

package/library/index.js

@@ -53,6 +53,8 @@ export {
   commentedDirectives_commentedModules,
 } from "./_commons/constants/bases.js";
 
+export { highlightFirstLineOfCode } from "./_commons/utilities/helpers.js";
+
 // agnostic20
 
 export {

package/package.json

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

package/types/index.d.ts

@@ -45,6 +45,24 @@ export const commentedDirectives_commentedModules: Readonly<{
   "use agnostic strategies": "Agnostic Strategies Module";
 }>;
 
+/**
+ * Gets the coordinates for the first line of code of a file.
+ * @param context An ESLint rule's `context` object.
+ * @returns The `context.report` `loc`-compatible coordinates for the first line of code of a file.
+ */
+export const highlightFirstLineOfCode: (
+  context: RuleContext<string, readonly unknown[]>
+) => {
+  start: {
+    line: number;
+    column: number;
+  };
+  end: {
+    line: number;
+    column: number;
+  };
+};
+
 // agnostic20
 
 // directives
@@ -408,22 +426,25 @@ export const getCommentedDirectiveFromCurrentModule: (
  * - `'use agnostic conditions'`, `"use agnostic conditions"` denoting an Agnostic Conditions Module.
  * - `'use agnostic strategies'`, `"use agnostic strategies"` denoting an Agnostic Strategies Module.
  * @param resolvedPath The resolved path of the imported module.
- * @returns The commented directive, or lack thereof via `null`. Given the strictness of this architecture, the lack of a directive is considered a mistake. (Though rules may provide the opportunity to declare a default, and configs with preset defaults may become provided.)
+ * @returns The commented directive, or lack thereof via `null`. Now also provides the obtained `SourceCode` object. Given the strictness of this architecture, the lack of a directive is considered a mistake. (Though rules may provide the opportunity to declare a default, and configs with preset defaults may become provided.)
  */
 export const getCommentedDirectiveFromImportedModule: (
   resolvedPath: string
-) =>
-  | "use server logics"
-  | "use client logics"
-  | "use agnostic logics"
-  | "use server components"
-  | "use client components"
-  | "use agnostic components"
-  | "use server functions"
-  | "use client contexts"
-  | "use agnostic conditions"
-  | "use agnostic strategies"
-  | null;
+) => {
+  commentedDirective:
+    | "use server logics"
+    | "use client logics"
+    | "use agnostic logics"
+    | "use server components"
+    | "use client components"
+    | "use agnostic components"
+    | "use server functions"
+    | "use client contexts"
+    | "use agnostic conditions"
+    | "use agnostic strategies"
+    | null;
+  sourceCode: ESLintSourceCode;
+};
 
 /**
  * Ensures that a module's commented directive is consistent with its file extension (depending on whether it ends with 'x' for JSX).