Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend README to mention different file types for type aware rules #411

Open
3 tasks done
holtwick opened this issue Feb 29, 2024 · 3 comments
Open
3 tasks done

Extend README to mention different file types for type aware rules #411

holtwick opened this issue Feb 29, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation pr welcome

Comments

@holtwick
Copy link
Contributor

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

@holtwick holtwick added the enhancement New feature or request label Feb 29, 2024
@Dimava
Copy link
Contributor

Dimava commented Feb 29, 2024

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

@holtwick
Copy link
Contributor Author

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

@antfu
Copy link
Owner

antfu commented Mar 3, 2024

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 antfu added documentation Improvements or additions to documentation pr welcome and removed enhancement New feature or request labels Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pr welcome
Projects
None yet
Development

No branches or pull requests

3 participants