Skip to content

test(eslint-plugin): assert that ts/tsx code blocks in docs are syntactically valid #8142

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

Merged
merged 14 commits into from
Jan 29, 2024

Conversation

auvred
Copy link
Member

@auvred auvred commented Dec 27, 2023

PR Checklist

Overview

For now, just trying to parse each code block with ts and tsx lang

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @auvred!

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 Dec 27, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 72e0b1c
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/65afde5c4e5c770008f4154b
😎 Deploy Preview https://deploy-preview-8142--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: 89 (🔴 down 1 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.

Comment on lines -175 to -178

const Comp: FC = () => {
return <button onClick={() => {}} />;
};
Copy link
Member Author

Choose a reason for hiding this comment

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

We can't mix angle bracket assertions and jsx syntax

JoshuaKGoldberg
JoshuaKGoldberg previously approved these changes Jan 8, 2024
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

I know @Josh-Cena has done a lot with Docusaurus things so leaving open in case they have a chance to review. Will come and merge back in a week otherwise.

@JoshuaKGoldberg JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jan 8, 2024
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Mostly LGTM

},
ecmaVersion: 'latest',
sourceType: 'module',
range: true,
Copy link
Member

Choose a reason for hiding this comment

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

Why this?

Copy link
Member Author

Choose a reason for hiding this comment

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

Without range: true parser throws Cannot read properties of undefined (reading '0') on valid code

Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

LGTM

@JoshuaKGoldberg JoshuaKGoldberg merged commit a41ad15 into typescript-eslint:main Jan 29, 2024
danvk pushed a commit to danvk/typescript-eslint that referenced this pull request Feb 4, 2024
…yntactically valid (typescript-eslint#8142)

* test(eslint-plugin): assert that `ts`/`tsx` code blocks in docs are syntactically valid

* revert unintended changes in space-before-blocks.md

* chore: shorten examples in consistent-type-assertions.md

* refactor: do not parse md file again

* docs: more consistent examples for consistent-type-assertions

* docs: convert `js` code blocks to `ts`

* Update packages/eslint-plugin/tests/docs.test.ts

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

* chore: use regex instead of startsWith

* chore: fix few codesamples

---------

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Repo: add a test asserting that all code blocks in docs are syntactically valid
4 participants