Adds a Vale rule enforcing the existing "select, not click" style
guidance: "click" assumes the reader has a mouse, and touch, keyboard,
and assistive-technology users don't click.
`Coder.SelectClick` (warning severity) flags
`click`/`clicks`/`clicked`/`clicking` in prose, exempting:
- Literal mouse-button phrasing (`left-click`, `right-click`,
`middle-click`, `mouse click`, and combinations) — these name an actual
mouse action with no device-agnostic equivalent.
- `one-click`/`single-click` as a compound feature descriptor
("one-click install").
Reworded every existing instructional "click" in `docs/` to the matching
`select` form (`select`/`selects`/`selections`/`selected`/`selecting`)
so the rule ships with a clean baseline, per this repo's Vale-rule
doctrine.
Left alone, deliberately: two generated API reference pages
(`docs/reference/api/enterprise.md`, `schemas.md`) use "click" as an
analytics-event noun, tied to a Go source doc comment and an operation
ID (`report-a-premium-paywall-click`). Fixing those means editing
generated code and an API operation ID, which is out of scope for a
docs-style PR — see the rule's own comments for the reasoning. That
leaves 2 non-zero-baseline findings for this rule.
---
🤖 Built with AI assistance.
---------
Co-authored-by: Ian Evans <5760366+ianjevans@users.noreply.github.com>
134 lines
2.4 KiB
Plaintext
134 lines
2.4 KiB
Plaintext
# Common ignore patterns, these rules applies in both root and subdirectories.
|
|
.DS_Store
|
|
.eslintcache
|
|
.gitpod.yml
|
|
.idea
|
|
.run
|
|
**/*.swp
|
|
gotests.coverage
|
|
gotests.xml
|
|
gotests_stats.json
|
|
gotests.json
|
|
node_modules/
|
|
vendor/
|
|
yarn-error.log
|
|
|
|
# Vale (prose linter) pulls package contents into docs/.style/styles/ on
|
|
# `vale sync`. Each synced package directory and the sync sentinel are
|
|
# gitignored. The Coder/ directory next to them is tracked because it
|
|
# holds our custom rules, and config/ because it holds our vocab lists.
|
|
docs/.style/.vale-synced
|
|
docs/.style/styles/*/
|
|
!docs/.style/styles/Coder/
|
|
!docs/.style/styles/config/
|
|
!docs/.style/styles/config/**
|
|
|
|
# Test output files
|
|
test-output/
|
|
|
|
# VSCode settings.
|
|
**/.vscode/*
|
|
# Allow VSCode recommendations and default settings in project root.
|
|
!/.vscode/extensions.json
|
|
!/.vscode/settings.json
|
|
# Allow code snippets
|
|
!/.vscode/*.code-snippets
|
|
|
|
# Front-end ignore patterns.
|
|
.next/
|
|
site/*-storybook.log
|
|
site/coverage/
|
|
site/storybook-static/
|
|
site/test-results/*
|
|
site/e2e/test-results/*
|
|
site/e2e/states/*.json
|
|
site/e2e/.auth.json
|
|
site/playwright-report/*
|
|
site/.swc
|
|
|
|
# Make target for updating generated/golden files (any dir).
|
|
.gen
|
|
/_gen/
|
|
.gen-golden
|
|
|
|
# Build
|
|
bin/
|
|
build/
|
|
dist/
|
|
out/
|
|
|
|
# Bundle analysis
|
|
site/stats/
|
|
|
|
*.tfstate
|
|
*.tfstate.backup
|
|
*.tfplan
|
|
*.lock.hcl
|
|
!provisioner/terraform/testdata/resources/.terraform.lock.hcl
|
|
.terraform/
|
|
!coderd/testdata/parameters/modules/.terraform/
|
|
!provisioner/terraform/testdata/modules-source-caching/.terraform/
|
|
|
|
**/.coderv2/*
|
|
**/__debug_bin
|
|
|
|
# direnv
|
|
.envrc
|
|
.direnv
|
|
*.test
|
|
|
|
# Loadtesting
|
|
./scaletest/terraform/.terraform
|
|
./scaletest/terraform/.terraform.lock.hcl
|
|
scaletest/terraform/secrets.tfvars
|
|
.terraform.tfstate.*
|
|
|
|
# Nix
|
|
result
|
|
|
|
# Data dumps from unit tests
|
|
**/*.test.sql
|
|
|
|
# Filebrowser.db
|
|
**/filebrowser.db
|
|
|
|
# pnpm
|
|
.pnpm-store/
|
|
|
|
# Zed
|
|
.zed_server
|
|
|
|
# dlv debug binaries for go tests
|
|
__debug_bin*
|
|
|
|
**/.claude/settings.local.json
|
|
|
|
# Local agent configuration
|
|
AGENTS.local.md
|
|
|
|
# mise local overrides
|
|
mise.local.toml
|
|
.mise.local.toml
|
|
mise.*.local.toml
|
|
.mise.*.local.toml
|
|
|
|
# `mise oci build` writes its OCI image layout here by default.
|
|
mise-oci/
|
|
|
|
/.env
|
|
|
|
# Ignore plans written by AI agents.
|
|
PLAN.md
|
|
|
|
# Ignore any dev licenses
|
|
license.txt
|
|
|
|
# Agent planning documents (local working files).
|
|
docs/plans/
|
|
|
|
# Local audit reports (e.g. site/scripts/audit-docs-paths.mjs output).
|
|
# The file is for local inspection only.
|
|
docs/.audit/
|
|
|
|
/release-action
|
|
test-timings.tsv |