feat: create max-nested-describe rule

[dominictwlee]

Resolves #362

The idea is the same as the above issue. I changed the rule name and options to something more consistent with the max-nested-callbacks rule.

[dominictwlee]

Thanks for the review @G-Rath, I've made the changes according to your comments.

[G-Rath]

Cheers, this is looking good! Just got some documentation fixes, and if you could add a few modifier & .each tests that'd be great!

[dominictwlee]

My bad with the brackets! been a long day my eyes must be going fuzzy.

[G-Rath]

Awesome! No worries about the brackets - thanks for putting up with all my nitty requests 😄

[G-Rath]

I'm now wondering if 2 is a good default max, given that max-nested-callbacks has a max of 10.

Thinking about the tests I've written, I easily have more than two nested describes, and think you would easily hit that with class/method tests:

describe('MyClass', () => {
  describe('#doSomethingWithDate', () => {
    describe('when an error happens', () => {
       ...
    });

    describe('when given a number', () => {
      it('parses it as a date', () => {
         ...
      });
    });

    describe('when the date is in the future', () => {
       ...
    });
  });
});

I'm not overly fussed about having the perfect default, but wouldn't mind hearing if @SimenB has any opinions on what a good nested level might be.

[dominictwlee]

I'm now wondering if 2 is a good default max, given that max-nested-callbacks has a max of 10.

Thinking about the tests I've written, I easily have more than two nested describes, and think you would easily hit that with class/method tests:

describe('MyClass', () => {
  describe('#doSomethingWithDate', () => {
    describe('when an error happens', () => {
       ...
    });

    describe('when given a number', () => {
      it('parses it as a date', () => {
         ...
      });
    });

    describe('when the date is in the future', () => {
       ...
    });
  });
});

I'm not overly fussed about having the perfect default, but wouldn't mind hearing if @SimenB has any opinions on what a good nested level might be.

Yeah agreed. it's pretty subjective so probably depends on the respective individuals/teams.Though I do think 10 is probably a bit much for nested describes.

[dominictwlee]

@SimenB @G-Rath Hey just following up on this. Any thoughts on the default config for nested levels?

[G-Rath]

@dominictwlee sorry I've been very busy recently, both working on some core changes to eslint-plugin-jest (currently, looking at using settings for configuring rules) and with other work stuff 😅

Currently I think 5 is probably a good default, as it leaves you with 3 levels of nesting after a class describe + method describe.

[dominictwlee]

@dominictwlee sorry I've been very busy recently, both working on some core changes to eslint-plugin-jest (currently, looking at using settings for configuring rules) and with other work stuff

Currently I think 5 is probably a good default, as it leaves you with 3 levels of nesting after a class describe + method describe.

@G-Rath I've updated the default max to 5, and added a few tests + examples in docs for this.

[dominictwlee]

@G-Rath Just following up on this periodically, let me know if anything needs to change.

[G-Rath]

@dominictwlee cheers, lets land it

[github-actions]

🎉 This PR is included in version 24.4.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀