Option for lowercase-name rule to allow uppercase for top level describes

[overlookmotel]

My preferred style is for top-level describe/its to have names starting with a capital letter, and all nested blocks lower case. So then the concatenated test name reads like a sentence starting with a capital letter.

e.g.:

describe('Monkeys', () => {
  describe('eat', () => {
    it('bananas', () => { /* ... */ } );
  });

  it('sleep in the daytime', () => { /* ... */ } );
});

it('Elephants are very big', () => { /* ... */ } );

// Monkeys eat bananas
// Monkeys sleep in the daytime
// Elephants are very big

At present this style is not possible to enforce with the lowercase-name rule.

How about:

1. Add lowercase-name ignore options 'top-describe', 'top-it', 'top-test' (and 'top' as a shortcut for all three)
2. Add a new uppercase-name rule with the same options.

Alternatively, a new rule called e.g. name-case could cover all possible permutations, with options something like:

"lower"
"upper"

// Override for different statements
"lower", { "describe": "upper", "it": "upper", "test": "upper" }
"upper", { "describe": "ignore" }

// Override for all top-level statements
"lower", { "top": "upper" }

// Override for specific top-level statements
"lower", { "describe": "upper", "top": { "describe": "lower" } }

Do you feel this would be useful?

[SimenB]

Happy to merge a PR with an ignore option added 🙂

[overlookmotel]

Great! What do you think about a new name-case rule which covers all possibilities?

[gayathrigs27]

I will take this up

[overlookmotel]

@gayathrigs27 Great!

Which variant are you planning to implement? My favoured one was a name-case rule as that covers all possibilities. I'm not sure if the maintainers would accept that though.

[gayathrigs27]

I thought of using the approach SimenB suggested

[github-actions]

🎉 This issue has been resolved in version 23.17.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀