feat: add support for @marko/testing-library (testing-library#572)

* feat: add support for @marko/testing-library * feat: add tests and update documentation for @marko/testing-library * fix: run prettier and update readme * test: add tests for @marko/testing-library * test: add marko tests for await-async-query-test * chore: address review comment * test: add marko await fire-event test case * test: add test for no-await-sync-query * test: no container * test: no-debugging-utils * test: no-dom-import * test: no-node-access * test: no unnecassary act * test: no-wait-for-empty-callback * test: no-wait-for-multiple-assertions * test: no-wait-for-side-effects * test: prefer-query-by-disappearance * test: prefer-screen-queries * test: render-result-naming-convention * fix: update no-dom-import rule to report the right module name * fix: address PR comments * fix: update Marko's brand logo
andipaetzold · May 11, 2022 · e332173 · e332173
1 parent 6148c6b
commit e332173
Show file tree

Hide file tree

Showing 52 changed files with 749 additions and 177 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/rules/await-fire-event.md b/docs/rules/await-fire-event.md
@@ -12,6 +12,7 @@ methods.
 >
 > - `@testing-library/vue` (supported by this plugin)
 > - `@testing-library/svelte` (not supported yet by this plugin)
+> - `@marko/testing-library` (supported by this plugin)
 
 Examples of **incorrect** code for this rule:
 

diff --git a/docs/rules/no-dom-import.md b/docs/rules/no-dom-import.md
@@ -76,3 +76,4 @@ With the configuration above, if the user imports from `@testing-library/dom` or
 - [Angular Testing Library API](https://testing-library.com/docs/angular-testing-library/api)
 - [React Testing Library API](https://testing-library.com/docs/react-testing-library/api)
 - [Vue Testing Library API](https://testing-library.com/docs/vue-testing-library/api)
+- [Marko Testing Library API](https://testing-library.com/docs/marko-testing-library/api)
diff --git a/docs/rules/no-unnecessary-act.md b/docs/rules/no-unnecessary-act.md
@@ -5,6 +5,7 @@
 > - `@testing-library/react` (supported by this plugin)
 > - `@testing-library/preact` (not supported yet by this plugin)
 > - `@testing-library/svelte` (not supported yet by this plugin)
+> - `@marko/testing-library` (supported by this plugin)
 
 ## Rule Details
 

diff --git a/lib/configs/marko.ts b/lib/configs/marko.ts
@@ -0,0 +1,29 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// YOU CAN REGENERATE IT USING npm run generate:configs
+
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'testing-library/await-async-query': 'error',
+    'testing-library/await-async-utils': 'error',
+    'testing-library/await-fire-event': 'error',
+    'testing-library/no-await-sync-query': 'error',
+    'testing-library/no-container': 'error',
+    'testing-library/no-debugging-utils': 'error',
+    'testing-library/no-dom-import': ['error', 'marko'],
+    'testing-library/no-node-access': 'error',
+    'testing-library/no-promise-in-fire-event': 'error',
+    'testing-library/no-render-in-setup': 'error',
+    'testing-library/no-unnecessary-act': 'error',
+    'testing-library/no-wait-for-empty-callback': 'error',
+    'testing-library/no-wait-for-multiple-assertions': 'error',
+    'testing-library/no-wait-for-side-effects': 'error',
+    'testing-library/no-wait-for-snapshot': 'error',
+    'testing-library/prefer-find-by': 'error',
+    'testing-library/prefer-presence-queries': 'error',
+    'testing-library/prefer-query-by-disappearance': 'error',
+    'testing-library/prefer-screen-queries': 'error',
+    'testing-library/render-result-naming-convention': 'error',
+  },
+};
diff --git a/lib/rules/await-async-query.ts b/lib/rules/await-async-query.ts
@@ -25,6 +25,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/await-async-utils.ts b/lib/rules/await-async-utils.ts
@@ -24,6 +24,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/await-fire-event.ts b/lib/rules/await-fire-event.ts
@@ -24,6 +24,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: false,
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/consistent-data-testid.ts b/lib/rules/consistent-data-testid.ts
@@ -23,6 +23,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: false,
         vue: false,
+        marko: false,
       },
     },
     messages: {

diff --git a/lib/rules/no-await-sync-events.ts b/lib/rules/no-await-sync-events.ts
@@ -29,6 +29,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: false,
         vue: false,
+        marko: false,
       },
     },
     messages: {

diff --git a/lib/rules/no-await-sync-query.ts b/lib/rules/no-await-sync-query.ts
@@ -18,6 +18,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-container.ts b/lib/rules/no-container.ts
@@ -25,6 +25,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-debugging-utils.ts b/lib/rules/no-debugging-utils.ts
@@ -32,6 +32,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-dom-import.ts b/lib/rules/no-dom-import.ts
@@ -23,6 +23,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: ['error', 'angular'],
         react: ['error', 'react'],
         vue: ['error', 'vue'],
+        marko: ['error', 'marko'],
       },
     },
     messages: {
@@ -46,7 +47,11 @@ export default createTestingLibraryRule<Options, MessageIds>({
       moduleName: string
     ) {
       if (framework) {
-        const correctModuleName = moduleName.replace('dom', framework);
+        // marko TL is called @marko/testing-library
+        const correctModuleName =
+          framework === 'marko'
+            ? moduleName.replace('dom-', `@${framework}/`)
+            : moduleName.replace('dom', framework);
         context.report({
           node,
           messageId: 'noDomImportFramework',

diff --git a/lib/rules/no-global-regexp-flag-in-query.ts b/lib/rules/no-global-regexp-flag-in-query.ts
@@ -25,6 +25,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: false,
         vue: false,
+        marko: false,
       },
     },
     messages: {

diff --git a/lib/rules/no-manual-cleanup.ts b/lib/rules/no-manual-cleanup.ts
@@ -30,6 +30,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: false,
         vue: false,
+        marko: false,
       },
     },
     messages: {

diff --git a/lib/rules/no-node-access.ts b/lib/rules/no-node-access.ts
@@ -18,6 +18,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-promise-in-fire-event.ts b/lib/rules/no-promise-in-fire-event.ts
@@ -25,6 +25,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-render-in-setup.ts b/lib/rules/no-render-in-setup.ts
@@ -55,6 +55,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-unnecessary-act.ts b/lib/rules/no-unnecessary-act.ts
@@ -28,6 +28,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: 'error',
         vue: false,
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-wait-for-empty-callback.ts b/lib/rules/no-wait-for-empty-callback.ts
@@ -23,6 +23,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-wait-for-multiple-assertions.ts b/lib/rules/no-wait-for-multiple-assertions.ts
@@ -22,6 +22,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-wait-for-side-effects.ts b/lib/rules/no-wait-for-side-effects.ts
@@ -25,6 +25,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/no-wait-for-snapshot.ts b/lib/rules/no-wait-for-snapshot.ts
@@ -24,6 +24,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/prefer-explicit-assert.ts b/lib/rules/prefer-explicit-assert.ts
@@ -74,6 +74,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: false,
         vue: false,
+        marko: false,
       },
     },
     messages: {

diff --git a/lib/rules/prefer-find-by.ts b/lib/rules/prefer-find-by.ts
@@ -57,6 +57,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/prefer-presence-queries.ts b/lib/rules/prefer-presence-queries.ts
@@ -23,6 +23,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/prefer-query-by-disappearance.ts b/lib/rules/prefer-query-by-disappearance.ts
@@ -28,6 +28,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/prefer-screen-queries.ts b/lib/rules/prefer-screen-queries.ts
@@ -45,6 +45,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/rules/prefer-user-event.ts b/lib/rules/prefer-user-event.ts
@@ -76,6 +76,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: false,
         vue: false,
+        marko: false,
       },
     },
     messages: {

diff --git a/lib/rules/prefer-wait-for.ts b/lib/rules/prefer-wait-for.ts
@@ -31,6 +31,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: false,
         react: false,
         vue: false,
+        marko: false,
       },
     },
     messages: {

diff --git a/lib/rules/render-result-naming-convention.ts b/lib/rules/render-result-naming-convention.ts
@@ -29,6 +29,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
         angular: 'error',
         react: 'error',
         vue: 'error',
+        marko: 'error',
       },
     },
     messages: {

diff --git a/lib/utils/index.ts b/lib/utils/index.ts
@@ -23,6 +23,7 @@ const LIBRARY_MODULES = [
   '@testing-library/preact',
   '@testing-library/vue',
   '@testing-library/svelte',
+  '@marko/testing-library',
 ];
 
 const SYNC_QUERIES_VARIANTS = ['getBy', 'getAllBy', 'queryBy', 'queryAllBy'];

diff --git a/lib/utils/types.ts b/lib/utils/types.ts
@@ -30,6 +30,7 @@ export const SUPPORTED_TESTING_FRAMEWORKS = [
   'angular',
   'react',
   'vue',
+  'marko',
 ] as const;
 export type SupportedTestingFramework =
   typeof SUPPORTED_TESTING_FRAMEWORKS[number];
diff --git a/tests/__snapshots__/index.test.ts.snap b/tests/__snapshots__/index.test.ts.snap
@@ -49,6 +49,36 @@ Object {
       "testing-library/prefer-screen-queries": "error",
     },
   },
+  "marko": Object {
+    "plugins": Array [
+      "testing-library",
+    ],
+    "rules": Object {
+      "testing-library/await-async-query": "error",
+      "testing-library/await-async-utils": "error",
+      "testing-library/await-fire-event": "error",
+      "testing-library/no-await-sync-query": "error",
+      "testing-library/no-container": "error",
+      "testing-library/no-debugging-utils": "error",
+      "testing-library/no-dom-import": Array [
+        "error",
+        "marko",
+      ],
+      "testing-library/no-node-access": "error",
+      "testing-library/no-promise-in-fire-event": "error",
+      "testing-library/no-render-in-setup": "error",
+      "testing-library/no-unnecessary-act": "error",
+      "testing-library/no-wait-for-empty-callback": "error",
+      "testing-library/no-wait-for-multiple-assertions": "error",
+      "testing-library/no-wait-for-side-effects": "error",
+      "testing-library/no-wait-for-snapshot": "error",
+      "testing-library/prefer-find-by": "error",
+      "testing-library/prefer-presence-queries": "error",
+      "testing-library/prefer-query-by-disappearance": "error",
+      "testing-library/prefer-screen-queries": "error",
+      "testing-library/render-result-naming-convention": "error",
+    },
+  },
   "react": Object {
     "plugins": Array [
       "testing-library",