From 36ece32e8f6509b71006264ad6763c6a59edc2d7 Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Thu, 26 Feb 2026 01:45:30 +0900 Subject: [PATCH] Normalize cspell config and update prettier script Reformat .cspell.json to use an explicit array for words and simplify ignorePaths to only include .cspell.json. Update package.json prettier script to target only .md and .yml (remove json), preventing JSON files from being reformatted by prettier. Fixes & Updates Update CONTRIBUTING.md Fixes --- .cspell.json | 12 ++++++++ .editorconfig | 20 ++++++++++++++ .github/dependabot.yml | 13 +++++++++ .github/workflows/super-linter.yml | 44 ++++++++++++++++++++++++++++++ .gitignore | 18 ++++++++++++ .travis.yml | 3 -- CONTRIBUTING.md | 22 ++------------- README.md | 29 ++++---------------- package.json | 28 ++++++++----------- 9 files changed, 125 insertions(+), 64 deletions(-) create mode 100644 .cspell.json create mode 100644 .editorconfig create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/super-linter.yml create mode 100644 .gitignore delete mode 100644 .travis.yml diff --git a/.cspell.json b/.cspell.json new file mode 100644 index 0000000..a4bc8ee --- /dev/null +++ b/.cspell.json @@ -0,0 +1,12 @@ +{ + "version": "0.2", + "words": [ + "ZIZMOR" + ], + "allowCompoundWords": true, + "language": "en,en-US", + "ignorePaths": [ + ".cspell.json" + ], + "useGitignore": true +} diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..a45efe7 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,20 @@ +# EditorConfig helps developers define and maintain consistent +# coding styles between different editors and IDEs +# editorconfig.org + +root = true + +# Apply for all files +[*] +charset = utf-8 +indent_style = space +indent_size = 2 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +# Apply for markdown files +[*.md] + +max_line_length = off +trim_trailing_whitespace = false diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..763a280 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: "/" + schedule: + interval: monthly + open-pull-requests-limit: 1 + cooldown: + default-days: 7 + groups: + github-actions: + patterns: + - "*" diff --git a/.github/workflows/super-linter.yml b/.github/workflows/super-linter.yml new file mode 100644 index 0000000..7743f77 --- /dev/null +++ b/.github/workflows/super-linter.yml @@ -0,0 +1,44 @@ +--- +name: Lint Code Base + +on: + push: + branches-ignore: + - "dependabot/**" + pull_request: + branches-ignore: + - "dependabot/**" + +permissions: + contents: read + +jobs: + build: + name: Lint Code Base + runs-on: ubuntu-latest + + permissions: + contents: read + packages: read + statuses: write + + steps: + - name: Checkout Code + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + fetch-depth: 0 + persist-credentials: false + + - name: Super-linter + uses: super-linter/super-linter/slim@12562e48d7059cf666c43a4ecb0d3b5a2b31bd9e # v8.4.0 + env: + DEFAULT_BRANCH: main + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + IGNORE_GITIGNORED_FILES: true + LINTER_RULES_PATH: / + LOG_LEVEL: NOTICE + SUPPRESS_POSSUM: true + VALIDATE_ALL_CODEBASE: false + VALIDATE_BIOME_FORMAT: false + VALIDATE_BIOME_LINT: false + VALIDATE_GIT_COMMITLINT: false diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e1e8939 --- /dev/null +++ b/.gitignore @@ -0,0 +1,18 @@ +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.Spotlight-V100 +.TemporaryItems +.Trashes + +package-lock.json +pnpm-lock.yaml +yarn.lock +bun.lockb +bun.lock + +.vscode +.idea +.DS_Store +.env +.env.local +.env.development.local diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index f178ec0..0000000 --- a/.travis.yml +++ /dev/null @@ -1,3 +0,0 @@ -language: node_js -node_js: - - 'node' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d48387..18fe6b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,28 +4,10 @@ First, thank you for considering contributing to the Awesome HTMLHint! It's people like you that make the open source community such a great community! 😊 -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, ... -- **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/awesome-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. - -## Your First Contribution - -Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). - ## Submitting code -Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests. - -## Code review process - -The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. -It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you? +Any change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. ## 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!). -You can also reach us at thedaviddias@gmail.com. - - +If you have any questions, create an [issue](https://github.com/htmlhint/awesome-htmlhint/issues) (protip: do a quick search first to see if someone else didn't ask the same question before!). diff --git a/README.md b/README.md index 87d2670..df82591 100644 --- a/README.md +++ b/README.md @@ -4,38 +4,20 @@ ## Contents -- [Plugins](#plugins) - - [Editors](#editors) +- [Editor Plugins](#editor-plugins) - [Tools](#tools) - - [Build tools](#build-tools) - - [Online tools](#online-tools) -- [Tutorials](#tutorials) -## Plugins +### Editor Plugins -### Editors - -- Visual Studio Code: [vscode-htmlhint](https://github.com/Microsoft/vscode-htmlhint) -- Sublime Text 3: [SublimeLinter-contrib-htmlhint](https://github.com/HTMLHint/SublimeLinter-contrib-htmlhint) -- Brackets: [brackets-htmlhint](https://github.com/HTMLHint/brackets-htmlhint) -- Atom: [linter-htmlhint](https://github.com/AtomLinter/linter-htmlhint) +- Visual Studio Code: [vscode-htmlhint](https://github.com/HTMLHint/vscode-htmlhint) +- Sublime Text 3: [SublimeLinter-contrib-htmlhint](https://github.com/HTMLHint/SublimeLinter-contrib-htmlhint) ## Tools -## Build tools - - Grunt: [grunt-htmlhint](https://www.npmjs.com/package/grunt-htmlhint) - Gulp: [gulp-htmlhint](https://www.npmjs.com/package/gulp-htmlhint) - Webpack: [htmlhint-loader](https://www.npmjs.com/package/htmlhint-loader) -## Online tools - -- Inspecode: [HTMLHint on Inspecode](https://inspecode.rocro.com/help/tools/htmlhint.html) - -## Tutorials - -- [HTMLHint Linter Codemirror Integration](https://www.youtube.com/watch?v=LjZI8bPSatY) - ## Contribute Contributions welcome! Read the [contribution guidelines](contributing.md) first. @@ -44,6 +26,5 @@ Contributions welcome! Read the [contribution guidelines](contributing.md) first [![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](http://creativecommons.org/publicdomain/zero/1.0) -To the extent possible under law, David Dias has waived all copyright and +To the extent possible under law, HTMLHint has waived all copyright and related or neighboring rights to this work. -` diff --git a/package.json b/package.json index 9ca0c24..2d4d5cc 100644 --- a/package.json +++ b/package.json @@ -1,25 +1,19 @@ { "name": "awesome-htmlhint", "version": "1.0.0", - "description": "> This is an awesome list", - "main": "index.js", - "scripts": { - + "description": "htmlhint list", + "homepage": "https://github.com/htmlhint/awesome-htmlhint#readme", + "bugs": { + "url": "https://github.com/htmlhint/awesome-htmlhint/issues" }, - "devDependencies": { - "awesome-lint": "*" - }, "repository": { "type": "git", - "url": "git+https://thedaviddias@github.com/thedaviddias/awesome-htmlhint.git" + "url": "git+https://github.com/htmlhint/awesome-htmlhint.git" }, - "keywords": [ - "awesome" - ], - "author": "", - "license": "ISC", - "bugs": { - "url": "https://github.com/thedaviddias/awesome-htmlhint/issues" - }, - "homepage": "https://github.com/thedaviddias/awesome-htmlhint#readme" + "license": "MIT", + "author": "HTMLHint", + "scripts": { + "prettier": "npx prettier --write \"**/*.{md,yml}\"", + "spellcheck": "npx cspell \"*.md\" --no-progress" + } }