eslint-plugin-use-agnostic 0.10.5 → 0.10.6

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-use-agnostic",
-  "version": "0.10.5",
+  "version": "0.10.6",
   "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": {
     ".": {