diff --git a/.cspell.json b/.cspell.json new file mode 100644 index 000000000..b1e051de8 --- /dev/null +++ b/.cspell.json @@ -0,0 +1,55 @@ +{ + "version": "0.2", + "words": [ + "adcontainer", + "atitle", + "attrname", + "attrvalue", + "bgsound", + "blabla", + "blankspace", + "checkstyle", + "clsx", + "codecov", + "codeql", + "commitlint", + "enochian", + "extlang", + "guoyu", + "hjid", + "hjsv", + "Hotjar", + "htmlhint", + "htmlhintrc", + "htmlparser", + "Infima", + "invision", + "langtag", + "mingo", + "nocolor", + "nodir", + "nomix", + "onttt", + "opencollective", + "ruleid", + "rulesdir", + "ruleset", + "selfclosing", + "sometag", + "specialchars", + "stylelint", + "svgr", + "tagend", + "tagname", + "tagstart", + "testhref", + "testtitle", + "uffff", + "unmin", + "xiang", + "Yanis" + ], + "language": "en,en-US", + "ignorePaths": [".cspell.json"], + "useGitignore": true +} diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 000000000..8474788c0 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,22 @@ +name: 'Check spelling' +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + spellcheck: + runs-on: ubuntu-latest + if: ${{ github.actor != 'dependabot[bot]' }} + steps: + - uses: actions/checkout@v4 + - uses: streetsidesoftware/cspell-action@v6 + with: + check_dot_files: false + incremental_files_only: true + inline: warning + strict: false diff --git a/.gitignore b/.gitignore index b14c4db7c..81de3fa1b 100644 --- a/.gitignore +++ b/.gitignore @@ -37,7 +37,7 @@ lib-cov .nyc_output coverage -# Compiled binary addons (http://nodejs.org/api/addons.html) +# Compiled binary addons (https://nodejs.org/api/addons.html) build/Release # Dependency directory diff --git a/.prettierignore b/.prettierignore index 6c31cb9d0..1d7127100 100644 --- a/.prettierignore +++ b/.prettierignore @@ -31,3 +31,5 @@ CHANGELOG.md # Report created by test report.html + +CODEOWNERS diff --git a/.prettierrc b/.prettierrc.json similarity index 100% rename from .prettierrc rename to .prettierrc.json diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1991f93fd..19c7bca5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ First, thank you for considering contributing to HTMLHint! It's people like you We welcome any type of contribution, not only code. You can help with - **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open) -- **Marketing**: writing blog posts, howto's, printing stickers, ... +- **Marketing**: writing blog posts, how-to's, printing stickers, ... - **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ... - **Code**: take a look at the [open issues](https://github.com/thedaviddias/HTMLHint/issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them. @@ -26,7 +26,7 @@ It is also always helpful to have some context for your pull request. What was t ## Questions -If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!). +If you have any questions, create an [issue](issue) (ProTip: do a quick search first to see if someone else didn't ask the same question before!). You can also reach us at thedaviddias@gmail.com. diff --git a/commitlint.config.js b/commitlint.config.js index c95b02700..1bc490af7 100644 --- a/commitlint.config.js +++ b/commitlint.config.js @@ -9,7 +9,7 @@ module.exports = { extends: ['@commitlint/config-conventional'], parserPreset: './parser-preset', - // Add your own rules. See http://marionebl.github.io/commitlint + // Add your own rules. See https://marionebl.github.io/commitlint rules: { // Apply valid scopes and types 'scope-enum': [scopeValidationLevel, 'always', validScopes], diff --git a/docs/user-guide/rules/href-abs-or-rel.md b/docs/user-guide/rules/href-abs-or-rel.md index dfb7c0f4a..93393a2af 100644 --- a/docs/user-guide/rules/href-abs-or-rel.md +++ b/docs/user-guide/rules/href-abs-or-rel.md @@ -17,7 +17,7 @@ The following pattern are **not** considered violations: ```html -abs: test1 test2 +abs: test1 test2 rel: test1 test2 ``` diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 0c4f13ba7..5197a9ff0 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -77,8 +77,8 @@ const config = { href: 'https://stackoverflow.com/questions/tagged/htmlhint', }, { - label: 'Twitter', - href: 'https://twitter.com/HTMLHint', + label: 'X (Twitter)', + href: 'https://x.com/HTMLHint', }, ], }, diff --git a/website/static/img/site.webmanifest b/website/static/img/site.webmanifest index de65106f4..799bbc8b1 100644 --- a/website/static/img/site.webmanifest +++ b/website/static/img/site.webmanifest @@ -1,6 +1,6 @@ { - "name": "", - "short_name": "", + "name": "HTMLHint", + "short_name": "HTMLHint", "icons": [ { "src": "/android-chrome-192x192.png",