Merge pull request #186 from MikeMcC399/update/meta-type

chore: add meta.type to rules
cypress-io · Apr 24, 2024 · 404387a · 404387a
2 parents 8227cbc + 4fded72
commit 404387a
Show file tree

Hide file tree

Showing 10 changed files with 9 additions and 1 deletion.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -16,7 +16,6 @@
   ],
   "rules": {
     "eslint-plugin/require-meta-schema": "off",
-    "eslint-plugin/require-meta-type": "off",
     "n/no-extraneous-require": [
       "error",
       {

diff --git a/lib/rules/assertion-before-screenshot.js b/lib/rules/assertion-before-screenshot.js
@@ -16,6 +16,7 @@ const assertionCommands = [
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Assert on the page state before taking a screenshot, so the screenshot is consistent',
       category: 'Possible Errors',

diff --git a/lib/rules/no-assigning-return-values.js b/lib/rules/no-assigning-return-values.js
@@ -17,6 +17,7 @@ function get (obj, propertyString = '') {
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prevent assigning return values of cy calls',
       category: 'Possible Errors',

diff --git a/lib/rules/no-async-before.js b/lib/rules/no-async-before.js
@@ -2,6 +2,7 @@
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prevent using async/await in Cypress before methods',
       category: 'Possible Errors',

diff --git a/lib/rules/no-async-tests.js b/lib/rules/no-async-tests.js
@@ -2,6 +2,7 @@
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prevent using async/await in Cypress test cases',
       category: 'Possible Errors',

diff --git a/lib/rules/no-force.js b/lib/rules/no-force.js
@@ -6,6 +6,7 @@
 
 module.exports = {
   meta: {
+    type: 'suggestion',
     docs: {
       description: 'Disallow using of \'force: true\' option for click and type calls',
       category: 'Possible Errors',

diff --git a/lib/rules/no-pause.js b/lib/rules/no-pause.js
@@ -6,6 +6,7 @@
 
 module.exports = {
   meta: {
+    type: 'suggestion',
     docs: {
       description: 'Disallow using of \'cy.pause\' calls',
       category: 'Possible Errors',

diff --git a/lib/rules/no-unnecessary-waiting.js b/lib/rules/no-unnecessary-waiting.js
@@ -2,6 +2,7 @@
 
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: 'Prevent waiting for arbitrary time periods',
       category: 'Possible Errors',

diff --git a/lib/rules/require-data-selectors.js b/lib/rules/require-data-selectors.js
@@ -2,6 +2,7 @@
 
 module.exports = {
   meta: {
+    type: 'suggestion',
     docs: {
       description: 'Use data-* attributes to provide context to your selectors and insulate them from CSS or JS changes https://docs.cypress.io/guides/references/best-practices.html#Selecting-Elements',
       category: 'Possible Errors',

diff --git a/lib/rules/unsafe-to-chain-command.js b/lib/rules/unsafe-to-chain-command.js
@@ -69,6 +69,7 @@ const getDefaultOptions = (context) => {
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
+    type: 'problem',
     docs: {
       description: DESCRIPTION,
       category: 'Possible Errors',