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

feat(md): formats md before committing #851

Merged
merged 3 commits into from May 24, 2019

Conversation

pranshuchittora
Copy link
Member

Closes #850

Linting of markdown, following webpack.js.org standards

Why tho?

  • Consistent formatting.
  • Easy to migrate docs to webpack.js.org.
  • It's good to follow some standards.

What kind of change does this PR introduce?
feature

Did you add tests for your changes?
Nopes

Summary

Does this PR introduce a breaking change?
Most probably not.
Nopes


Milestones 🏅

  • Addition of markdownlint

  • Setup base config

  • Integrate with husky

  • Fix all linting issue in all the docs 💯

@webpack-bot
Copy link

Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon.

@anshumanv
Copy link
Member

anshumanv commented Apr 22, 2019

I don't think we have so much md like docs site that we need a separate linter and introduce more deps in the package, it can be easily maintained without it and the markdown here(most of it) is gonna be shifted entirely to docs site so this will be even less used.

(IMO) and I'd like to hear what others think though 😄

Copy link
Member

@rishabh3112 rishabh3112 left a comment

Choose a reason for hiding this comment

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

I think it's not required.

@ematipico
Copy link
Contributor

I think what's best is to add prettier to the lint-staged hook command and tell it to format also the .MD files. Having a linter is too much I think :)

@pranshuchittora
Copy link
Member Author

@ematipico Sounds great, will be working on that 👍

formattes md files before commit
adds prettier as a dependency and formattes markdowns pre-commit
@pranshuchittora pranshuchittora changed the title [WIP] feat(md): adds markdownlint as a dependency feat(md): formats md before committing May 1, 2019
@ematipico
Copy link
Contributor

Could you please rebase? I think it's good to go!

Copy link
Member

@anshumanv anshumanv left a comment

Choose a reason for hiding this comment

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

Seems good to go after rebase! 💯

Copy link
Member

@rishabh3112 rishabh3112 left a comment

Choose a reason for hiding this comment

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

Merge conflict is still here as I can see.

@webpack-bot
Copy link

@pranshuchittora Thanks for your update.

I labeled the Pull Request so reviewers will review it again.

@rishabh3112 Please review the new changes.

@@ -124,6 +128,7 @@
"import-local": "^2.0.0",
"interpret": "^1.1.0",
"loader-utils": "^1.1.0",
"prettier": "^1.17.0",

Choose a reason for hiding this comment

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

@pranshuchittora was there a reason prettier needed to be added to dependencies instead of devDependencies?

Copy link
Contributor

Choose a reason for hiding this comment

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

Fix submitted as #968.

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

Successfully merging this pull request may close these issues.

feat(docs): addition of markdownlint
8 participants