eslint-config icon indicating copy to clipboard operation
eslint-config copied to clipboard

Extend README to mention different file types for type aware rules

Open holtwick opened this issue 1 year ago • 3 comments

Clear and concise description of the problem

The README explains how to activate type aware rules here but this does e.g. not work for Vue files out of the box. It is required to add an option like this:

typescript: {
      tsconfigPath: './tsconfig.json',      
      filesTypeAware: ['**\/*.{ts,tsx,vue}'],
}

Suggested solution

Mention the filesTypeAware option in README to improve user experience.

Alternative

Add vue and other commonly used values as defaults.

Additional context

No response

Validations

  • [X] Follow our Code of Conduct
  • [X] Read the Contributing Guide.
  • [X] Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

holtwick avatar Feb 29 '24 08:02 holtwick

nit: Vue is not added by default as it drastically increases lint time

Dimava avatar Feb 29 '24 08:02 Dimava

I see! Also a very valueable information :) Thanks.

holtwick avatar Feb 29 '24 08:02 holtwick

I don't use type-aware rules myself tbh. Would love to see a PR and discuss otherwise I don't expect myself fixing that any sooner.

antfu avatar Mar 03 '24 20:03 antfu