@dereekb/util 13.11.2 → 13.11.3

package/eslint/src/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { utilRequireNoSideEffectsRule, type UtilRequireNoSideEffectsRuleOptions, type UtilRequireNoSideEffectsRuleDefinition } from './require-no-side-effects.rule';
+export { utilPreferNoSideEffectsInJsdocRule, type UtilPreferNoSideEffectsInJsdocRuleDefinition } from './prefer-no-side-effects-in-jsdoc.rule';
+export { utilEslintPlugin, type UtilEslintPlugin } from './plugin';

package/eslint/src/lib/plugin.d.ts

@@ -0,0 +1,18 @@
+import { type UtilRequireNoSideEffectsRuleDefinition } from './require-no-side-effects.rule';
+import { type UtilPreferNoSideEffectsInJsdocRuleDefinition } from './prefer-no-side-effects-in-jsdoc.rule';
+/**
+ * ESLint plugin interface for @dereekb/util rules.
+ */
+export interface UtilEslintPlugin {
+    readonly rules: {
+        readonly 'require-no-side-effects': UtilRequireNoSideEffectsRuleDefinition;
+        readonly 'prefer-no-side-effects-in-jsdoc': UtilPreferNoSideEffectsInJsdocRuleDefinition;
+    };
+}
+/**
+ * ESLint plugin for @dereekb/util rules.
+ *
+ * Register as a plugin in your flat ESLint config, then enable individual rules
+ * under the chosen plugin prefix (e.g. 'dereekb-util/require-no-side-effects').
+ */
+export declare const utilEslintPlugin: UtilEslintPlugin;

package/eslint/src/lib/prefer-no-side-effects-in-jsdoc.rule.d.ts

@@ -0,0 +1,42 @@
+type AstNode = any;
+/**
+ * ESLint rule definition for prefer-no-side-effects-in-jsdoc.
+ */
+export interface UtilPreferNoSideEffectsInJsdocRuleDefinition {
+    readonly meta: {
+        readonly type: 'suggestion';
+        readonly fixable: 'code';
+        readonly docs: {
+            readonly description: string;
+            readonly recommended: boolean;
+        };
+        readonly messages: {
+            readonly preferJsdocPlacement: string;
+        };
+        readonly schema: readonly object[];
+    };
+    create(context: {
+        options: unknown[];
+        report: (descriptor: {
+            node: AstNode;
+            messageId: string;
+            data?: Record<string, string>;
+            fix?: (fixer: AstNode) => AstNode | AstNode[];
+        }) => void;
+        sourceCode: AstNode;
+    }): Record<string, (node: AstNode) => void>;
+}
+/**
+ * ESLint rule that flags functions with both a JSDoc block and a separate
+ * `// @__NO_SIDE_EFFECTS__` (or block-comment equivalent) line comment between
+ * the JSDoc and the declaration. Auto-fix migrates the annotation into the JSDoc
+ * (last tag before the closing) and removes the standalone comment, since the
+ * JSDoc form is the workspace's preferred placement.
+ *
+ * Unlike `require-no-side-effects`, this rule does not require the function to
+ * be tagged as a factory — it triggers purely on the presence of an existing
+ * line-comment annotation alongside a JSDoc, so it can sweep all 688 historical
+ * annotations through `eslint --fix`.
+ */
+export declare const utilPreferNoSideEffectsInJsdocRule: UtilPreferNoSideEffectsInJsdocRuleDefinition;
+export {};

package/eslint/src/lib/require-no-side-effects.rule.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Options for the require-no-side-effects rule.
+ */
+export interface UtilRequireNoSideEffectsRuleOptions {
+    /**
+     * When true, also flag functions whose names match the factory naming patterns
+     * in addition to JSDoc-tag detection.
+     */
+    readonly checkNamePatterns?: boolean;
+    /**
+     * Additional name pattern source strings (compiled to RegExp) when `checkNamePatterns` is true.
+     */
+    readonly additionalNamePatterns?: readonly string[];
+}
+type AstNode = any;
+/**
+ * ESLint rule definition for require-no-side-effects.
+ */
+export interface UtilRequireNoSideEffectsRuleDefinition {
+    readonly meta: {
+        readonly type: 'suggestion';
+        readonly fixable: 'code';
+        readonly docs: {
+            readonly description: string;
+            readonly recommended: boolean;
+        };
+        readonly messages: {
+            readonly missingNoSideEffectsJsdoc: string;
+            readonly missingJsdocForFactory: string;
+        };
+        readonly schema: readonly object[];
+    };
+    create(context: {
+        options: UtilRequireNoSideEffectsRuleOptions[];
+        report: (descriptor: {
+            node: AstNode;
+            messageId: string;
+            data?: Record<string, string>;
+            fix?: (fixer: AstNode) => AstNode | AstNode[];
+        }) => void;
+        sourceCode: AstNode;
+    }): Record<string, (node: AstNode) => void>;
+}
+/**
+ * ESLint rule requiring the side-effect-free annotation inside the JSDoc of every
+ * factory function — that is, declarations carrying the dbxUtilKind factory JSDoc tag,
+ * and optionally functions matching factory name patterns.
+ *
+ * Auto-fix inserts the annotation as the last line of the JSDoc, removes any
+ * redundant standalone-comment annotation between the JSDoc and the declaration,
+ * and (when matched by name with no JSDoc) creates a minimal JSDoc carrying both tags.
+ */
+export declare const utilRequireNoSideEffectsRule: UtilRequireNoSideEffectsRuleDefinition;
+export {};

package/fetch/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@dereekb/util/fetch",
-  "version": "13.11.2",
+  "version": "13.11.3",
   "peerDependencies": {
-    "@dereekb/util": "13.11.2",
+    "@dereekb/util": "13.11.3",
     "make-error": "^1.3.6",
     "fast-content-type-parse": "^3.0.0"
   },