| name | check-standards |
| description | Run the same code-quality checks CI runs (Prettier format, ESLint, typecheck, and unit tests) over the current diff before pushing or marking a PR ready. Use before opening/updating a PR, when the user asks to verify standards, lint, format, or check that CI will pass. |
Check standards (mirror CI locally)
Runs, over the changed files only, the same gates CI applies on Wazuh Dashboard
PRs, so failures are caught before they burn CI minutes. Fix issues, then re-run
until clean.
The approach is generic; blocks marked repo-specific cover this repo's exact
commands (test runner, lint, typecheck).
Workflow
- [ ] 1. Compute changed files vs the base branch
- [ ] 2. Prettier --check (autofix with --write)
- [ ] 3. ESLint (autofix with --fix)
- [ ] 4. Typecheck
- [ ] 5. Unit tests for the changed code
- [ ] 6. Report pass/fail summary
1. Compute changed files
Match how CI computes them (diff against the base branch, excluding deletions):
BASE=<version-branch>
git fetch origin "$BASE"
CHANGED=$(git diff --name-status --diff-filter=d "origin/$BASE"...HEAD | awk '{print $NF}')
CODE=$(echo "$CHANGED" | grep -E '\.[jt]sx?$' || true)
echo "$CHANGED"
2. Prettier (format)
Check the changed files the same way pre-commit (.lintstagedrc) would:
npx prettier $CHANGED --check --ignore-unknown
npx prettier $CHANGED --write --ignore-unknown
repo-specific (wazuh-dashboard-notifications): this repo has its own local
.prettierrc (es5 trailing commas, single quotes, 80-col) — Prettier
resolves it from the repo root, not the parent checkout. .prettierignore skips
*.md and *.lock, so don't expect those to be reformatted. A .lintstagedrc
runs prettier --write on staged files, but there is no husky hook wired in
this repo — run Prettier yourself.
3. ESLint
repo-specific (wazuh-dashboard-notifications): ESLint config is .eslintrc.js
(extends @elastic/eslint-config-kibana + plugin:@elastic/eui/recommended; a
legacy YAML .eslintrc is also present), and the lint script runs through the
parent checkout. yarn lint runs both ESLint and Stylelint
(node ../../scripts/eslint . && node ../../scripts/stylelint). Run it from this
plugin's dir inside wazuh-dashboard/plugins/<this-plugin>. It enforces the
short SPDX license header on .js/.ts/.tsx files, so new files need the
Copyright OpenSearch Contributors / SPDX-License-Identifier: Apache-2.0
block.
yarn lint
node ../../scripts/eslint . --fix
If you need to scope ESLint to changed files, node ../../scripts/eslint $CODE
works too (the @elastic/eslint-import-resolver-kibana resolver needs the parent
checkout's node_modules).
4. Typecheck
repo-specific (wazuh-dashboard-notifications): there is no typecheck
script. tsconfig.json extends ../../tsconfig.json, so run it from inside
the parent checkout:
../../node_modules/.bin/tsc --noEmit -p tsconfig.json
5. Unit tests (changed code)
repo-specific (wazuh-dashboard-notifications): the test script is
yarn test:jest (it runs TZ=UTC ../../node_modules/.bin/jest --config ./test/jest.config.js from inside the wazuh-dashboard checkout at
plugins/<this-plugin>). Bootstrap once (yarn osd bootstrap from the
wazuh-dashboard root), then:
yarn test:jest
Scope for speed with a path/pattern (yarn test:jest <path>). Refresh snapshots
only when the change intends to (yarn test:jest -u).
Remember: unit tests are colocated (*.test.ts / *.test.tsx, typically in
__tests__/ folders next to the source, snapshots under __snapshots__/). New
source files should ship with their colocated test.
6. Report
Summarize each gate as pass/fail; if anything failed, list the offending files and
either fix them or explain what needs manual attention:
Prettier: PASS
ESLint: FAIL (2 files) → public/components/Foo/Foo.tsx, server/routes/bar.ts
Typecheck: PASS
Jest: PASS
Only report "ready for review" once every applicable gate passes.
