After trying to add a index.d.ts declaration file myself, I quickly realized I do not understand the build/bundling system for this monorepo. The declaration files were excluded from the build output.

I found the two different TODO comments explaining how the current build process isn't great for an eslint plugin.

./packages/eslint-plugin-react-hooks/npm/index.js

// TODO: this doesn't make sense for an ESLint rule.
// We need to fix our build process to not create bundles for "raw" packages like this.

./scripts/rollup/bundles.js

// TODO: it's awkward to create a bundle for this but if we don't, the package
// won't get copied. We also can't create just DEV bundle because it contains a
// NODE_ENV check inside. We should probably tweak our build process to allow
// "raw" packages that don't get bundled.

Fixing this would also allow adding declaration files to the published package, instead of being ignored by the bundler.

Makes me wonder if eslint-plugin-react-hooks should be in its own repository like most standalone npm packages, to avoid the awkwardness of a monorepo bundling system that wasn't designed for it. But I'll leave that decision to the maintainers.

Figured I'd dump the declaration files I wrote here for anyone who works on this issue in the future:

// index.d.ts
import type { configs, rules } from './src/index';

declare var plugin: {
  configs: typeof configs;
  rules: typeof rules;
};

export default plugin;

// src/index.d.ts
import type { Linter } from "eslint";

import type RulesOfHooks from './RulesOfHooks';
import type ExhaustiveDeps from './ExhaustiveDeps';

export const configs: {
  recommended: Linter.Config;
};

export const rules: {
  'rules-of-hooks': typeof RulesOfHooks;
  'exhaustive-deps': typeof ExhaustiveDeps;
};

// both src/RulesOfHooks.d.ts and src/ExhaustiveDeps.d.ts
import type { Rule } from "eslint";

declare var rule: Rule.RuleModule;

export default rule;

This issue has been automatically marked as stale. If this issue is still affecting you, please leave any comment (for example, "bump"), and we'll keep it open. We are sorry that we haven't been able to prioritize it yet. If you have any new additional information, please include it with your comment!

bump

This issue has been automatically marked as stale. If this issue is still affecting you, please leave any comment (for example, "bump"), and we'll keep it open. We are sorry that we haven't been able to prioritize it yet. If you have any new additional information, please include it with your comment!

Not stale.

Such an annoying issue with many eslint plugins.

This issue also applies to eslint-plugin-react-compiler. A fix could cover both packages at once.

Not stale.

I can take this up once #30774 lands.

@michaelfaith, #30774 is in. Are you still up for adding typings to eslint-plugin-react-hooks and eslint-plugin-react-compiler? Happy to help if you no longer have enough capacity.

@michaelfaith, #30774 is in. Are you still up for adding typings to eslint-plugin-react-hooks and eslint-plugin-react-compiler? Happy to help if you no longer have enough capacity.

I've started working on converting the hooks plugin to TypeScript entirely (rather than just adding declaration files), in preparation for merging the two plugins. One outcome of that will be type declarations.