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

Integration with ESLint's built-in configurations (strict-type-checked, stylistic-type-checked) #67

Open
undergroundwires opened this issue Dec 28, 2023 · 1 comment

Comments

@undergroundwires
Copy link

Documentation problem on ESLint configurations

The current documentation advises using this config after other plugins. However, it lacks clarity on integrating with ESLint's stricter inbuilt configurations like strict-type-checked or stylistic-type-checked, which exceed the recommended level provided by @vue/typescript/recommended.

Issues with .vue file parsing

Going against the official documentation and adding strict-type-checked and stylistic-type-checked before this config works partly. This is also suggested by @n0099 in issue #29. It allows reusing parser and plugin options but it fails to parse .vue files

So doing something like:

    '@vue/typescript/recommended',

    'plugin:@typescript-eslint/strict-type-checked',
    'plugin:@typescript-eslint/stylistic-type-checked',

Fails on files that are not .ts, such as cjs, js and most importantly .vue files.

Potential solution

I see two steps solution, and would appreciate your input, @sodatea:

  1. Update README.md to offer clear guidance on using these ESLint configurations. Either advise against their use if unsupported, or provide a workaround if possible. The current instruction to use this config after other plugins is unclear and confusing, leading to similar issues on GitHub.
  2. Find a way to support integration with these inbuilt ESLint rules.

Updating documentation can be first step as it could address related issues like #63, #43, #29, and #18, potentially resolving them with an official statement from the maintainers.

@n0099
Copy link

n0099 commented Dec 28, 2023

undergroundwires added a commit to undergroundwires/privacy.sexy that referenced this issue Jan 5, 2024
- Bump all ESLint dependencies related to TypeScript to their latest
  version. This was made possible by the resolution of compatibility
  issues with `@vue/eslint-config-airbnb-with-typescript`.
  See vuejs/eslint-config-airbnb#58 for details.
- Refactor code to comply with the latest linting configuration.
- Improve documentation in the ESLint configuration file to better
  describe the functionality and limitations of
  `@vue/typescript/recommended`.
  See vuejs/eslint-config-typescript#67 for details.
- Document functionality and limitation of `@vue/typescript/recommended`
  more clearly in ESLint configuration file.
undergroundwires added a commit to undergroundwires/privacy.sexy that referenced this issue Jan 5, 2024
- Bump all ESLint dependencies related to TypeScript to their latest
  version. This was made possible by the resolution of compatibility
  issues with `@vue/eslint-config-airbnb-with-typescript`.
  See vuejs/eslint-config-airbnb#58 for details.
- Refactor code to comply with the latest linting configuration.
- Improve documentation in the ESLint configuration file to better
  describe the functionality and limitations of
  `@vue/typescript/recommended`.
  See vuejs/eslint-config-typescript#67 for details.
- Document functionality and limitation of `@vue/typescript/recommended`
  more clearly in ESLint configuration file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants