objectionary / objectionary/lints

test attributes with name containing `"test"` are possible, while should lead to lint warnings

Open
#553 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug help wanted
Dominant language
Java
Stars
14
Forks
39
Avg merge
22h 54m
Merged PRs (30d)
90

Description

Consider this EO test:

# Tests for foo.
[] > foo-tests
  # Test.
  [] > tests-setup
    eq. > @
      foo.setup 42
      52

Name tests-setup looks incorrect to me, since here, in test foo is a subject under test, not a test script itself. Ideally, the correct name should sound like: foo-setups-42-correctly. Thus, I suggest to warn about test word in test attribute names.

BTW, jtcop implemented this check in RuleNotContainsTestWord rule.

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 with the EO example in this issue and compare the proposed behavior with jtcop's RuleNotContainsTestWord at src/main/java/com/github/lombrozo/testnames/rules/RuleNotContainsTestWord.java. Identify the lints project's corresponding rule and tests; done means test attribute names containing the word "test" produce the intended lint warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.