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

docs: correct the usage of eslint-recommended #9014

Merged
merged 4 commits into from May 8, 2024

Conversation

honeymaro
Copy link
Contributor

PR Checklist

Overview

Fixed docs since eslint-recommended is FlatConfig.Config not FlatConfig.ConfigArray

// packages/typescript-eslint/src/configs/eslint-recommended.ts

import config from '@typescript-eslint/eslint-plugin/use-at-your-own-risk/eslint-recommended-raw';
import type { FlatConfig } from '@typescript-eslint/utils/ts-eslint';

/**
 * This is a compatibility ruleset that:
 * - disables rules from eslint:recommended which are already handled by TypeScript.
 * - enables rules that make sense due to TS's typechecking / transpilation.
 */
export default (
  _plugin: FlatConfig.Plugin,
  _parser: FlatConfig.Parser,
): FlatConfig.Config => ({
  ...config('minimatch'),
  name: 'typescript-eslint/eslint-recommended',
});

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @honeymaro!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

Copy link

netlify bot commented Apr 28, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit dc2f03a
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/663ba0269de6f200087fa2d9
😎 Deploy Preview https://deploy-preview-9014--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (🟢 up 3 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@auvred auvred left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this!

@auvred auvred merged commit af47bc9 into typescript-eslint:main May 8, 2024
57 of 58 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants