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

chore: ignore website docs generated in biome #9168

Merged
merged 3 commits into from
Jan 29, 2025

Conversation

nunogois
Copy link
Member

@nunogois nunogois commented Jan 29, 2025

https://linear.app/unleash/issue/2-3208/add-website-docs-generated-folder-to-biome-ignore-lists

Noticed when running yarn lint locally that we get this error:

./website/docs/generated/openapi.json format ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ✖ Size of ./website/docs/generated/openapi.json is 1.7 MiB which exceeds configured maximum of 1.0 MiB for this project.
    The file size limit exists to prevent us inadvertently slowing down and loading large files that we shouldn't.
    Use the `files.maxSize` configuration to change the maximum size of files processed.

To overcome this, this PR adds website/docs/generated to the ignore list of both the linter and formatter in our Biome settings.

@nunogois nunogois requested review from chriswk and kwasniew January 29, 2025 13:18
Copy link

vercel bot commented Jan 29, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
unleash-docs ⬜️ Ignored (Inspect) Visit Preview Jan 29, 2025 1:44pm
unleash-monorepo-frontend ⬜️ Ignored (Inspect) Visit Preview Jan 29, 2025 1:44pm

Copy link
Contributor

github-actions bot commented Jan 29, 2025

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Files

biome.json Outdated
@@ -1,5 +1,8 @@
{
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
"files": {
"maxSize": 2097152
Copy link
Contributor

Choose a reason for hiding this comment

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

is it safe to increase it for SEO/WebPerf?

Copy link
Member Author

@nunogois nunogois Jan 29, 2025

Choose a reason for hiding this comment

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

By adding the generated folder to the ignore lists we no longer need this, so I'm removing it. I don't expect this to impact SEO/WebPerf at all, it's just a sane limit that Biome has by default to not load large files. See: https://biomejs.dev/reference/configuration/#filesmaxsize

@nunogois nunogois merged commit b870333 into main Jan 29, 2025
7 checks passed
@nunogois nunogois deleted the chore-bump-biome-files-maxsize branch January 29, 2025 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants