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

.editorconfig missing #1562

Closed
jrson83 opened this issue Nov 15, 2024 · 6 comments
Closed

.editorconfig missing #1562

jrson83 opened this issue Nov 15, 2024 · 6 comments

Comments

@jrson83
Copy link
Contributor

jrson83 commented Nov 15, 2024

I noticed because there is no .editorconfig, the line spacing within the Markdown files is not consistent, as some are saved with 2 and some with 4. As I like to fix the code block issues with xml language and find it hard to work with an unconsistent file formatting, I like to create a PR to fix the issue, if welcome.

@Isengo1989
Copy link
Collaborator

@jrson83 we are using markdown lint for that (https://github.com/shopware/docs/blob/main/markdown-style-config.yml)

Maybe that rule does what you are looking for -> https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md046---code-block-style

What is the issue you were mentioning?

@jrson83
Copy link
Contributor Author

jrson83 commented Nov 22, 2024

Thanks for reply. But I think this has nothing to do with the linter. If you look at the .md files in the IDE without forced .editorconfig, you can see that they were created with inconsistent or undefined line spacing.

For the other issue please see here: https://github.com/shopware/docs/pull/1557/files/1daa8d9de365dc694f99e302f10aadf0c24398ad#r1841759820

I like to fix this issue here, to work on the others. I can do this in no time.

What line spacing do you want to actually use for the .md files 2 or 4?

@jrson83
Copy link
Contributor Author

jrson83 commented Dec 1, 2024

@mitelg 2 or 4?

@Isengo1989
Copy link
Collaborator

@jrson83 we will discuss this topic soon in the DX team and get back to you here. This would be my suggestion:

[*.md]
indent_style = space
indent_size = 2

@Isengo1989
Copy link
Collaborator

Hey @jrson83 the PR was merged - feel free to create one based on the space indent of 2 with an .editorconfig as talked about in the other issue 👋

@Isengo1989
Copy link
Collaborator

Closing the issue, let's continue on the PR 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants