companion-template-compliance

Run a template compliance review that detects whether the module is JavaScript or TypeScript, then validates required files, config file contents, package.json fields, manifest.json rules, and HELP.md content against the official template. All violations are reported as critical severity.

A module is TypeScript if tsconfig.json exists at the module root or package.json contains "type": "module". Otherwise it is treated as JavaScript, and the corresponding template rules are applied.

TypeScript modules need all JavaScript template files plus eslint.config.mjs, tsconfig.build.json, tsconfig.json, .husky/pre-commit, and src/main.ts. The package-lock.json file must not be present, and all source code must live in the src/ directory.

The keywords array must not contain "companion", "module", "stream deck", the manufacturer name, the module or product name, or the full product name. These terms add no search value and any match is flagged as a critical violation.

HELP.md fails when it contains the placeholder string "Write some help for your users here", has only a stub heading, or is fewer than five meaningful lines. It must document what the module does, configuration, available actions and feedbacks, and troubleshooting tips.

No. All template compliance violations are critical severity and block approval, including missing files, wrong repository URLs, placeholder maintainers, banned keywords, and config file deviations from the template.