Skip to content

Bug: [consistent-type-export] Declaration shadowing causes false positive #11388

Open
@Xunnamius

Description

@Xunnamius

Before You File a Bug Report Please Confirm You Have Done The Following...

  • I have tried restarting my IDE and the issue persists.
  • I have updated to the latest version of the packages.
  • I have searched for related issues and found none that matched my issue.
  • I have read the FAQ and my problem is not listed.

Issue Description

Take the Error class. As far as I can tell, TypeScript differentiates between the runtime name Error, which is an ErrorConstructor that you call new on, versus the type name Error, which is what is returned by the ErrorConstructor in the type system:

const error: Error = new Error()

Where the name Error is simultaneously the TypeScript type and the runtime object.

Suppose I want to decorate subclasses of Error on the fly:

/* eslint-disable @typescript-eslint/no-explicit-any */

function decorateErrorClass<T extends new (...args: any[]) => Error>(
  errorConstructor: T
) {
  const decoratedConstructor = errorConstructor as T & {
    additionalStaticProp: boolean;
  };

  decoratedConstructor.additionalStaticProp = true;
  return { MyError: decoratedConstructor };
}

const { MyError } = decorateErrorClass(
  class MyError extends Error {
    panic() {
      console.log('panicking!');
    }
  }
);

/**
 * Some commentary that should be exported.
 */
export type MyError = InstanceType<typeof MyError>; 
// AFAICT if we don't export the instance type of MyError (above), DX degrades for importers
export { MyError };

// MyError (class) and myError (instance) are both correctly typed in this file.
const myError = new MyError();
console.log(MyError.additionalStaticProp); // true
myError.panic(); // outputs: "panicking!"

And then, in some other file, I attempt to import and export MyError:

import { MyError } from './index.js';

export type SomethingElse = boolean;

export { MyError };

npx eslint gives the following error:

npx eslint                              

/tmp/tmp.1UuL6fdCYx/src/1-broken/bad.ts
  5:1  error  All exports in the declaration are only used as types. Use `export type`  @typescript-eslint/consistent-type-exports

✖ 1 problem (1 error, 0 warnings)
  1 error and 0 warnings potentially fixable with the `--fix` option.

What makes this false positive particularly pernicious is if I'm blindly applying --fix on the file I'm editing (as I am wont to do), it'll turn that MyError runtime export into a type-only export. This breaks downstream consumers at runtime but the linter shows no issues.

My best guess: the issue is with the self-described "hack" on line 154. I'd dig further, but the workaround in my case is easy and elegant enough:

- const { MyError } = decorateErrorClass(
+ export const { MyError } = decorateErrorClass(
  class MyError extends Error {
    panic() {
      console.log('panicking!');
    }
  }
);

/**
 * Some commentary that should be exported.
 */
export type MyError = InstanceType<typeof MyError>;
- export { MyError };

Maybe related to #10313.

Reproduction Repository Link

https://github.com/Xunnamius/typescript-eslint-bug-repro-11388

Repro Steps

  1. clone the repo
  2. npm install
  3. npx eslint

Versions

package version
typescript-eslint 8.36.0
@eslint/js 9.30.1
TypeScript 5.8.3
ESLint 9.30.1
node 22.17.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuebugSomething isn't workingpackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy