Compatibility with eslint-plugin-testing-library

[thymikee]

Describe the Feature

It would be lovely to verify that our library is compatible with eslint-plugin-testing-library, determine what's missing and plan the necessary work to make it usable.

Possible Implementations

I'd like avoid creating another plugin based on the existing one. I'd prefer documenting the shortcomings (e.g. lack of screen if there are rules for that)

[thymikee]

cc @mdjastrzebski

[thymikee]

@cross19xx please put your findings here :)

[cross19xx]

With the exception of the following syntaxes, all other rules are valid and compatible with eslint-plugin-testing-library.

• no-debug: Using the default debug is seen as a valid syntax, whereas using the debug inside the render method is seen as an invalid syntax, i.e.

  // Valid syntax
  import {debug} from 'react-native-testing-library';
  debug(<Component />);
  
  // Invalid syntax
  import {render} from 'react-native-testing-library';
  const {debug} = render(<Component />);

  Luckily, react-native-testing-library@next covers this.

• prefer-wait-for: This is shown as an invalid syntax the wait method in RNTL is waitForElement. A suggestion will be to have an alias for waitForElement as waitFor. Depending on the state of this (i.e. if on or off), no-wait-for-empty-callback may be triggered

• prefer-screen-queries. This will require having a screen object.

[thymikee]

Thanks! Now w need to document it

[BatDroid]

@thymikee could you please explain a bit more about what should be documented. I would love to start my contribution on this repo

[thymikee]

• prefer-screen-queries. This will require having a screen object.

Only this one is relevant now, since we don't have screen queries.

[pierrezimmermannbam]

I have tried all rules on my project and they all seem to work fine but some are irrelevant :

• prefer-screen-queries : as stated above, it doesn't make sense without a screen object
• prefer-user-event : user event is not compatible with rntl
• no-dom-import : not so sure about that one but there should be no reason to import dom-testing-library
• prefer-wait-for: wait is no longer available
• no-wait-for-empty-callback : callback is not optional

consistent-data-testid works but it needs to be configured so that it checks the testID attribute :

{
  "testing-library/consistent-data-testid": [
    2,
    {
      "testIdAttribute": ["testID"],
     "testIdPattern": "^TestId(__[A-Z]*)?$"
    }
  ]
}

@thymikee I 'd be glad to help on the doc, where would you document this ?

[thymikee]

We have a Guides section on the website. A new guide called "eslint compatibility" or so would be nice to have.

[mdjastrzebski]

Closing as done.