Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions .cursor/rules/general.mdc

This file was deleted.

20 changes: 10 additions & 10 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org
# https://editorconfig.org

root = true

# Apply for all files
[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

# Apply for markdown files
[*.md]
[*.min.*]
insert_final_newline = false

[*.svg]
insert_final_newline = false

max_line_length = off
trim_trailing_whitespace = false
[CNAME]
insert_final_newline = false
10 changes: 0 additions & 10 deletions .gemini/config.yaml

This file was deleted.

16 changes: 16 additions & 0 deletions .github/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Agents

<!-- https://agents.md -->

## GitHub Actions

- The GitHub Actions workflows should be placed in the .github/workflows directory.
- The workflows should be named `<workflow-name>.yml`.
- All GitHub Actions should be pinned versions to avoid breaking changes (SHA-1).
- If using actions/checkout, it should have `persist-credentials: false` set.

## Dependabot

- GitHub Actions updates should be grouped and updated monthly.
- npm packages should be grouped and updated monthly.
- Dependabot config should be formatted with Prettier.
32 changes: 0 additions & 32 deletions .github/copilot-instructions.md

This file was deleted.

48 changes: 31 additions & 17 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,32 @@

<!-- https://agents.md -->

## General

- This project is for HTMLHint, a static code analysis tool for HTML.
- All code and comments should be in US English.
- The website is built with Astro Starlight.
- All code should be formatted with Prettier.
- Use ESLint to check for JavaScript errors.
- Rollup is used for building the project.
- Node.js 20 or newer is required; Volta pins the repo to Node 20 LTS in `package.json`.
- Core code is in TypeScript v5.4.5.
- All new rules for HTMLHint should be placed in the rules directory.
- Tests for new rules should be added in rules and follow the naming pattern `<rule-name>.spec.js`.
- Do not use deprecated TypeScript features.
- All user-facing messages and documentation should use clear, concise US English.
- Keep dependencies up to date and avoid unnecessary packages.
- All website content should be placed in the website directory and follow Astro Starlight conventions.
- Rules in the rules directory should always be documented in the website/src/content/docs/rules directory.
- Rules in src/core/core.ts should be listed alphabetically.
- Use the provided code snippets as examples for rule documentation.
- Newly added rules pages for the website should have the frontmatter: sidebar: hidden: true badge: New
- Always run `npm run build` before running tests or committing changes.
- When adding a new rule to website ensure that it has the frontmatter: `pagefind: false sidebar: badge: New hidden: true`.
- Always run `npm run lint` before declaring that a task is complete (if you've changed any files).
- Always use lf for line endings.
- As a general rule, rules should be listed alphabetically.

## Markdown Code Guide

- Markdown should be formatted with Prettier.
Expand All @@ -13,23 +39,11 @@
- YML files should begin with --- on the first line.
- YML should be formatted with Prettier.

## Communication (MANDATORY)

- No apologies - State facts and solutions directly.
- Concise style - Professional, avoid repetition and filler.
- Single chunk edits - All file edits in one operation.
- Real file links only - No placeholder files.
- No unnecessary confirmations - Use available context.

## Quality & Validation (MANDATORY)
## GitHub Commit Messages

- Never assume commands worked without verification.
- 98%+ confidence threshold for definitive claims.
- Immediate re-investigation when findings don't match expectations.
- Cross-tool validation when tools fail.
- If multiple changes are made then list changes using bullet points.

## Code Standards (MANDATORY)
## Documentation

- No emojis in code or documentation.
- Only implement what's requested.
- Preserve existing structures - Don't remove unrelated code.
- All documentation should be written in US English.
- For the 'Why this rule is important' section, always include a link to the relevant documentation and prefer MDN and Google documentation along with official documentation from the W3C.
Loading
Loading