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(linter): add prettier-ignore where formatting ruins code #8978

Conversation

camchenry
Copy link
Contributor

@camchenry camchenry commented Feb 8, 2025

While running just website, I noticed that these docs were causing some issues when running npm run fmt subsequently, I think due to the usage of character escapes. Disabling prettier seems to stop this from occurring.

Also the code examples in no-nonoctal-decimal-escape had weird formatting due to the usage of text which gets parsed as a label, so I updated the example.

@github-actions github-actions bot added the A-linter Area - Linter label Feb 8, 2025
Copy link
Contributor Author

camchenry commented Feb 8, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Feb 8, 2025
@camchenry camchenry marked this pull request as ready for review February 8, 2025 15:39
Copy link

codspeed-hq bot commented Feb 8, 2025

CodSpeed Performance Report

Merging #8978 will not alter performance

Comparing 02-07-docs_linter_add_prettier-ignore_where_formatting_ruins_code (02cb45b) with main (fcfc274)

Summary

✅ 33 untouched benchmarks

@Sysix Sysix added the 0-merge Merge with Graphite Merge Queue label Feb 8, 2025
Copy link
Collaborator

Sysix commented Feb 8, 2025

Merge activity

  • Feb 8, 2:46 PM EST: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
  • Feb 8, 2:46 PM EST: A user added this pull request to the Graphite merge queue.
  • Feb 8, 2:51 PM EST: A user merged this pull request with the Graphite merge queue.

While running `just website`, I noticed that these docs were causing some issues when running `npm run fmt` subsequently, I think due to the usage of character escapes. Disabling prettier seems to stop this from occurring.

Also the code examples in `no-nonoctal-decimal-escape` had weird formatting due to the usage of text which gets parsed as a label, so I updated the example.
@graphite-app graphite-app bot force-pushed the 02-07-docs_linter_add_prettier-ignore_where_formatting_ruins_code branch from 3f409ce to 02cb45b Compare February 8, 2025 19:47
@graphite-app graphite-app bot merged commit 02cb45b into main Feb 8, 2025
25 checks passed
@graphite-app graphite-app bot deleted the 02-07-docs_linter_add_prettier-ignore_where_formatting_ruins_code branch February 8, 2025 19:51
Dunqing pushed a commit that referenced this pull request Feb 10, 2025
While running `just website`, I noticed that these docs were causing some issues when running `npm run fmt` subsequently, I think due to the usage of character escapes. Disabling prettier seems to stop this from occurring.

Also the code examples in `no-nonoctal-decimal-escape` had weird formatting due to the usage of text which gets parsed as a label, so I updated the example.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0-merge Merge with Graphite Merge Queue A-linter Area - Linter C-docs Category - Documentation. Related to user-facing or internal documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants