feat: add support for @marko/testing-library

[PrashantAshok]

Checks

• I have read the contributing guidelines.
• If some rule is added/updated/removed, I've regenerated the rules list.
• If some rule meta info is changed, I've regenerated the plugin shared configs.

Changes

• Add @marko/testing-library to the list of supported testing library frameworks

Context

As suggested in #80

[Belco90]

Hey @PrashantAshok! Thanks for your contribution. There are a few things missing tho:

• Update the README with a new label for Marko testing framework
• Since rules meta have changed, the plugin shared configs must be regenerated
• We should add some tests to the fake-rule.ts to make sure that @marko/testing-library is correctly reported as a Testing Library framework

[MichaelDeBoey]

@PrashantAshok Can you please add extra test cases for each rule, so we can see that all rules are still working?

[PrashantAshok]

@Belco90 @MichaelDeBoey - thanks for the review. I missed updating README, let me update that along with the tests.

Since rules meta have changed, the plugin shared configs must be regenerated

Sorry, I didn't get this point. How do I generate one? Did you mean the files under config? I already generated one for marko

We should add some tests to the fake-rule.ts to make sure that @marko/testing-library is correctly reported as a Testing Library framework

Sorry, any pointers on how would I go about verifying it? And is it some other file, since fake-rule.ts is not a test file.

[PrashantAshok]

@PrashantAshok Can you please add extra test cases for each rule, so we can see that all rules are still working?

Do I need to add tests for every rule or just the ones that is specific to Marko, e.g. await-fire-event.ts? (comparing the current tests with other frameworks like Angular, Vue etc)

[MichaelDeBoey]

@PrashantAshok Each rule should have some basic framework-specific tests to see that the rule works as expected, even if it's not doing anything "special".

Not all rules have them currently, but it would be good to start doing it anyways.

[Belco90]

Writing tests for Marko on each rule shouldn't be necessary! We actually haven't read a test for each testing framework on each rule. Adding some tests in create-testing-library-rule.test.ts (not fake-rule, sorry) should be enough.

[MichaelDeBoey]

Adding some tests in create-testing-library-rule.test.ts should be enough.

How would we even know 100% certain that all rules are actually working properly for the plugin?

[Belco90]

How would we even know 100% certain that all rules are actually working properly for the plugin?

In the same way as we do with the rest of the testing frameworks: assuming it works as expected by testing the core utils fromcreate-testing-library-rules.

[MichaelDeBoey]

assuming it works as expected

@Belco90 Well, that's what I think we should stop doing: assuming.

Supporting a new testing framework is the perfect opportunity to start really testing that all rules work on this framework.
We'll probably have some "unnecessary" tests, but confidence is at 100% for a very low cost imo.

[Belco90]

assuming it works as expected

@Belco90 Well, that's what I think we should stop doing: assuming.

Supporting a new testing framework is the perfect opportunity to start really testing that all rules work on this framework. We'll probably have some "unnecessary" tests, but confidence is at 100% for a very low cost imo.

Ok, let's cover the rules that are specific for Marko then.

Sorry, I didn't get this point. How do I generate one? Did you mean the files under config? I already generated one for marko

Sorry @PrashantAshok, I thought this was covered in the CONTRIBUTING.md, but it's not! You can regenerate this with npm run generate:configs, and the rules list with npm run generate:rules-list.

---

To summarize the changes needed:

• Update the README with a new label for Marko testing framework
• Regenerate the plugin shared configs
• Add an extra test for @marko/testing-library to create-testing-library-rule.test.ts
• Add an extra valid test and invalid test for those rules compatibles with @marko/testing-library (duplicating a basic existing test changing the Testing Library module imported should be fine).

[PrashantAshok]

Thanks @Belco90 for detailed suggestions. Points 1, 2 and 3 are done and pushed. Please have a look. (Currently there is no icon for Marko in simple-icons repo, have created an issue. Have 2 options for now - either we can render the icon without the logo Or I can create link with the entire svg file, but this would be too long. Let me know and I can update the draft PR accordingly)

Sure, I can add them. But sorry, I maybe missing something, are the current rule related tests dependent on any framework? For e.g. for this test case, the tests still pass if I pass in a random name

function createTestCode({ code, isAsync = true }: TestCode) {
  return `
    import { render } from '@testing-library/some-random-name'
    test("An example test",${isAsync ? ' async ' : ' '}() => {
      ${code}
    })
  `;
}

[Belco90]

Have 2 options for now - either we can render the icon without the logo Or I can create link with the entire svg file, but this would be too long. Let me know and I can update the draft PR accordingly)

Let's do it without logo, that's fine.

are the current rule related tests dependent on any framework? For e.g. for this test case, the tests still pass if I pass in a random name

There are some in specific rules, but we usually use just '@testing-library/{whatever}' because the core utils of the plugin will assume everything from @testing-library scope belongs to Testing Library. The problem with the Marko one is that it belongs to the @marko scope, so we need to make sure the rules will report things related to it as expected, since doesn't follow the same pattern.

[PrashantAshok]

@Belco90 - added a test, can you please check this commit - If it's good, I will go ahead and add for the rest of the relevant rules as well.

[Belco90]

@Belco90 - added a test, can you please check this commit - If it's good, I will go ahead and add for the rest of the relevant rules as well.

That's perfect! 👌

[PrashantAshok]

@Belco90 @MichaelDeBoey - all the suggested changed done and pushed.

[Belco90]

It looks good at first sight, but I want to review it later again, just in case.

[Belco90]

I just detected 2 tests files missing an invalid test for Marko. When that's done, it should be ready to go!

[Belco90]

LGTM!

All requests sorted out.

[github-actions]

🎉 This PR is included in version 5.5.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[Belco90]

@all-contributors please add @PrashantAshok for code, tests

[allcontributors]

@Belco90

I've put up a pull request to add @PrashantAshok! 🎉