Shareable Htmlhint Config
📄 About
Package that contains shareable configurations for HTMLHint — a popular linting tool that helps to identify and fix problems in your HTML code.
→ Purpose
This package aims to provide a shared set of rules for HTMLHint to ensure consistent coding practices across a team or organization.
- Provide a shared configuration that helps avoid inconsistencies and ensures that everyone follows the latest best practices and guidelines.
- Make it easier for teams to use HTMLHint effectively and improve the quality of their HTML code.
💿 Installation
To use this configuration, you'll need to install the htmlhint
and @wayofdev/htmlhint-config
packages as devDependencies in your project. These packages should be installed in the package.json
file of the specific app or package that needs them:
pnpm --filter=my-first-app add -D htmlhint @wayofdev/htmlhint-config
This package should be added to the root of your monorepo, where you have a file .htmlhintrc
and a package.json
file. Within your monorepo, you should have a structure with directories for your apps and packages, such as:
.
├── package.json (root)
├── apps
│ └── my-first-app
│ ├── package.json
│ └── ... (other app files)
└── packages
└── my-first-package
├── package.json
└── ... (other package files)
→ Configure
To configure the htmlhint
, add script to package.json
pnpm pkg set scripts.lint:html="htmlhint --config ./node_modules/@wayofdev/htmlhint-config/index.json **/*.html"
💻 Usage
You can run the htmlhint
command manually using the following pnpm
command:
pnpm --filter=my-first-app lint:html
Alternatively, you can add it to lint-staged configuration to run together with Husky git hooks.
🤝 License
🧱 Credits and Useful Resources
Based on:
Related projects:
- htmlhint
- husky
- lint-staged
🙆🏼♂️ Author Information
This repository was created in 2023 by lotyp / wayofdev.
🙌 Want to Contribute?
Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to:
- 🤔 Suggest a feature
- 🐛 Report an issue
- 📖 Improve documentation
- 👨💻 Contribute to the code
You are more than welcome. Before contributing, kindly check our guidelines.