R008: 用例声明格式不规范

Official

Detect XTS test case doc format violations early.

Authoropenharmonyinsight
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps you find XTS test cases whose JSDoc-style comment blocks are not declared in the required format, which can break review consistency and make test code harder to maintain.

Core Features & Use Cases

  • Comment block format validation: Checks that doc comments use the required /** ... */ structure and that each line starts with *.
  • Tag correctness for test case metadata: Ensures parameters like @tc.name / @tc.number use the @ modifier and disallows incorrect separators such as : instead of whitespace.
  • Attachment rule enforcement: Verifies that the doc comment ends immediately before the it('...') test case declaration without unintended empty lines.
  • Scope: Scans only test files with extensions .test.ets, .test.ts, .test.js.

Quick Start

Run the R008 rule scan on your codebase to list all test files and the line-level issues where test case declaration comments violate the required format.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: R008: 用例声明格式不规范
Download link: https://github.com/openharmonyinsight/openharmony-skills/archive/main.zip#r008

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.