Normalize cspell config and update prettier script#2
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR modernizes repository/project configuration and documentation by adding baseline tooling (Super-Linter, Dependabot, EditorConfig, cspell), removing legacy CI (Travis), and updating project metadata/docs to reflect the HTMLHint organization.
Changes:
- Add GitHub Actions Super-Linter workflow and Dependabot configuration for workflow updates.
- Add editor/spellcheck configuration files and update
package.jsonscripts/metadata. - Refresh
README.mdandCONTRIBUTING.md, and remove.travis.yml.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
package.json |
Updates metadata and adds prettier/spellcheck scripts. |
README.md |
Restructures contents/links and updates attribution text. |
CONTRIBUTING.md |
Simplifies contributing guidance and fixes issue link target. |
.travis.yml |
Removes Travis CI config (migration to GitHub Actions). |
.gitignore |
Adds ignore rules for OS/editor artifacts and lockfiles. |
.github/workflows/super-linter.yml |
Introduces automated linting via Super-Linter on pushes/PRs. |
.github/dependabot.yml |
Enables monthly GitHub Actions dependency updates. |
.editorconfig |
Establishes consistent whitespace/newline conventions. |
.cspell.json |
Adds cspell configuration for repository spellchecking. |
Comments suppressed due to low confidence (1)
README.md:23
- The README links to
contributing.md, but the repository file isCONTRIBUTING.md(uppercase). On case-sensitive filesystems (and on GitHub), this link will 404; update the link target to match the actual filename.
Contributions welcome! Read the [contribution guidelines](contributing.md) first.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "url": "https://github.com/thedaviddias/awesome-htmlhint/issues" | ||
| }, | ||
| "homepage": "https://github.com/thedaviddias/awesome-htmlhint#readme" | ||
| "license": "MIT", |
There was a problem hiding this comment.
package.json sets license to MIT, but the README's License section indicates the project is released under CC0 (badge + waiver text). These should be consistent; either update package.json to the correct SPDX identifier (e.g., CC0-1.0) or update the README/license files to match MIT.
| "license": "MIT", | |
| "license": "CC0-1.0", |
This pull request introduces several improvements to project configuration, documentation, and repository maintenance. The main changes include adding configuration files for linting, spell checking, and editor consistency, updating documentation for clarity and accuracy, and modernizing project metadata.
Repository maintenance and configuration:
.github/workflows/super-linter.ymlto enable automated linting of codebase using GitHub Actions and Super-Linter..github/dependabot.ymlto automate dependency updates for GitHub Actions workflows..editorconfigto enforce consistent coding styles across different editors..cspell.jsonto configure spell checking for markdown and code files, improving documentation quality..travis.ymlas part of migration away from Travis CI, reflecting a shift to GitHub Actions for CI/CD.Documentation updates:
README.mdto clarify plugin categories, update plugin links, and remove outdated sections for improved readability.README.mdto reference HTMLHint instead of David Dias.CONTRIBUTING.md, including updated issue links and streamlined contribution instructions.Project metadata modernization:
package.jsonwith accurate project description, author, license, homepage, repository URL, and added scripts for formatting and spell checking.