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-infra] Force git diff to reset tabs origin #249

Open
oliviertassinari opened this issue Nov 26, 2024 · 0 comments
Open

[docs-infra] Force git diff to reset tabs origin #249

oliviertassinari opened this issue Nov 26, 2024 · 0 comments
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product status: waiting for maintainer These issues haven't been looked at yet by a maintainer

Comments

@oliviertassinari
Copy link
Member

oliviertassinari commented Nov 26, 2024

Summary

Create a new markdown lint rule so that git diff have to reset their tabs/spacing at the origin, meaning to go from:

+    foo() {
+      bar;

to:

+foo() {
+  bar;

Examples

Prior work was done around this in https://github.com/mui/material-ui/blob/master/packages/markdownlint-rule-mui/git-diff.js. This rule is here to make sure that the git diff we write has the correct format.

This issue is about a new rule as it's stylistic.

Motivation

Avoid the need to have comments like mui/mui-x#15575 (comment)

Search keywords: -

@oliviertassinari oliviertassinari added status: waiting for maintainer These issues haven't been looked at yet by a maintainer enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product labels Nov 26, 2024
@oliviertassinari oliviertassinari changed the title [docs-infra] Improve markdownlint for git diff [docs-infra] Force git diff to reset tabs origin Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product status: waiting for maintainer These issues haven't been looked at yet by a maintainer
Projects
None yet
Development

No branches or pull requests

1 participant