loadsys / loadsys/loadsys_codesniffer

Add coverage for all sniffs identified by testUntested()

Open
#39 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug help-wanted
Dominant language
PHP
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

The test suite now compares the full list of sniffs employed by a coding standard against those in the test sample file `//~` annotations and throws an assertion failure if the sample files fail to "cover" all tests.

This acts as a crude kind of "coverage" metric of the sniffs defined in the ruleset, but right now we're only covering about 31 out of 120+ sniffs.

To resolve this, uncomment the `markTestIncomplete()` in `LoadsysStandardTest::testUntested()`. Then repeatedly run `vendor/bin/phpunit` and add new sample files for each remaining sniff name listed. Ideally, there should be two files for each sniff-- one confirming that incorrect style is caught by our ruleset, and another that correct behavior is _not_ caught. The new files should be arranged in the `tests/files/must/` and `tests/files/must_not/` folders. Read the `## Testing` section of the README for more naming details and goals.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in LoadsysStandardTest::testUntested(), uncomment markTestIncomplete(), and run vendor/bin/phpunit to identify the remaining sniff names. Read the README's Testing section, then add sample files under tests/files/must/ and tests/files/must_not/ for the remaining sniffs; done means the full ruleset list is covered and the test suite passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.