feat(no-invalid-state-props): modify the rule to accept new xstate@5 …

…state props Newly accepted props: types, output. No longer valid props: activities, tsTypes, schema, preserveActionOrder, predictableActionArguments, strict, data.
rlaffers · Aug 14, 2023 · 4aecdff · 4aecdff
1 parent 0637a6f
commit 4aecdff
Show file tree

Hide file tree

Showing 4 changed files with 290 additions and 59 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -29,7 +29,13 @@ module.exports = {
     'no-async-guard': require('./rules/no-async-guard'),
   },
   configs: {
+    // Requires: xstate@5
     recommended: {
+      settings: {
+        xstate: {
+          version: 5,
+        },
+      },
       plugins: ['xstate'],
       rules: {
         'xstate/spawn-usage': 'error',
@@ -46,7 +52,62 @@ module.exports = {
         'xstate/no-async-guard': 'error',
       },
     },
+    // Requires: xstate@5
     all: {
+      settings: {
+        xstate: {
+          version: 5,
+        },
+      },
+      plugins: ['xstate'],
+      rules: {
+        'xstate/spawn-usage': 'error',
+        'xstate/no-infinite-loop': 'error',
+        'xstate/no-imperative-action': 'error',
+        'xstate/no-ondone-outside-compound-state': 'error',
+        'xstate/invoke-usage': 'error',
+        'xstate/entry-exit-action': 'error',
+        'xstate/event-names': ['warn', 'macroCase'],
+        'xstate/state-names': ['warn', 'camelCase'],
+        'xstate/no-inline-implementation': 'warn',
+        'xstate/no-auto-forward': 'warn',
+        'xstate/prefer-always': 'error',
+        'xstate/no-misplaced-on-transition': 'error',
+        'xstate/no-invalid-transition-props': 'error',
+        'xstate/no-invalid-state-props': 'error',
+        'xstate/no-async-guard': 'error',
+      },
+    },
+    // Requires: xstate@4
+    recommended_v4: {
+      settings: {
+        xstate: {
+          version: 4,
+        },
+      },
+      plugins: ['xstate'],
+      rules: {
+        'xstate/spawn-usage': 'error',
+        'xstate/no-infinite-loop': 'error',
+        'xstate/no-imperative-action': 'error',
+        'xstate/no-ondone-outside-compound-state': 'error',
+        'xstate/invoke-usage': 'error',
+        'xstate/entry-exit-action': 'error',
+        'xstate/prefer-always': 'error',
+        'xstate/prefer-predictable-action-arguments': 'warn',
+        'xstate/no-misplaced-on-transition': 'error',
+        'xstate/no-invalid-transition-props': 'error',
+        'xstate/no-invalid-state-props': 'error',
+        'xstate/no-async-guard': 'error',
+      },
+    },
+    // Requires: xstate@4
+    all_v4: {
+      settings: {
+        xstate: {
+          version: 4,
+        },
+      },
       plugins: ['xstate'],
       rules: {
         'xstate/spawn-usage': 'error',

diff --git a/lib/rules/no-invalid-state-props.js b/lib/rules/no-invalid-state-props.js
@@ -8,55 +8,104 @@ const {
   hasProperty,
 } = require('../utils/predicates')
 const { allPass } = require('../utils/combinators')
+const getSettings = require('../utils/getSettings')
 
-const validProperties = [
-  'after',
-  'always',
-  'entry',
-  'exit',
-  'history', // only when type=history
-  'id',
-  'initial',
-  'invoke',
-  'meta',
-  'on',
-  'onDone',
-  'states',
-  'tags',
-  'target', // only when type=history
-  'type',
-  'data',
-  'description',
-  'activities',
-]
-function isValidStateProperty(property) {
-  return validProperties.includes(property.key.name)
+const validProperties = {
+  4: [
+    'after',
+    'always',
+    'entry',
+    'exit',
+    'history', // only when type=history
+    'id',
+    'initial',
+    'invoke',
+    'meta',
+    'on',
+    'onDone',
+    'states',
+    'tags',
+    'target', // only when type=history
+    'type',
+    'data',
+    'description',
+    'activities',
+  ],
+  5: [
+    'after',
+    'always',
+    'entry',
+    'exit',
+    'history', // only when type=history
+    'id',
+    'initial',
+    'invoke',
+    'meta',
+    'on',
+    'onDone',
+    'states',
+    'tags',
+    'target', // only when type=history
+    'type',
+    'description',
+    'output',
+  ],
 }
 
-const validRootProperties = [
-  'after',
-  'context',
-  'description',
-  'entry',
-  'exit',
-  'history', // only when type=history
-  'id',
-  'initial',
-  'invoke',
-  'meta',
-  'on',
-  'predictableActionArguments',
-  'preserveActionOrder',
-  'schema',
-  'states',
-  'strict',
-  'tags',
-  'target', // only when type=history
-  'tsTypes',
-  'type',
-]
-function isValidRootStateProperty(property) {
-  return validRootProperties.includes(property.key.name)
+function isValidStateProperty(property, version) {
+  return (
+    validRootProperties[version] &&
+    validProperties[version].includes(property.key.name)
+  )
+}
+
+const validRootProperties = {
+  4: [
+    'after',
+    'context',
+    'description',
+    'entry',
+    'exit',
+    'history', // only when type=history
+    'id',
+    'initial',
+    'invoke',
+    'meta',
+    'on',
+    'predictableActionArguments',
+    'preserveActionOrder',
+    'schema',
+    'states',
+    'strict',
+    'tags',
+    'target', // only when type=history
+    'tsTypes',
+    'type',
+  ],
+  5: [
+    'after',
+    'context',
+    'description',
+    'entry',
+    'exit',
+    'history', // only when type=history
+    'id',
+    'initial',
+    'invoke',
+    'meta',
+    'on',
+    'states',
+    'tags',
+    'target', // only when type=history
+    'types',
+    'type',
+  ],
+}
+function isValidRootStateProperty(property, version) {
+  return (
+    validRootProperties[version] &&
+    validRootProperties[version].includes(property.key.name)
+  )
 }
 
 function hasHistoryTypeProperty(node) {
@@ -156,6 +205,7 @@ module.exports = {
   },
 
   create: function (context) {
+    const { version } = getSettings(context)
     return {
       [stateDeclaration]: function (node) {
         const isHistoryNode = hasHistoryTypeProperty(node)
@@ -189,7 +239,7 @@ module.exports = {
             return
           }
 
-          if (!isValidStateProperty(prop)) {
+          if (!isValidStateProperty(prop, version)) {
             context.report({
               node: prop,
               messageId: 'invalidStateProperty',
@@ -230,7 +280,7 @@ module.exports = {
             return
           }
 
-          if (!isValidRootStateProperty(prop)) {
+          if (!isValidRootStateProperty(prop, version)) {
             context.report({
               node: prop,
               messageId: 'invalidRootStateProperty',

diff --git a/lib/utils/getSettings.js b/lib/utils/getSettings.js
@@ -0,0 +1,19 @@
+'use strict'
+
+const defaults = {
+  version: 5
+}
+
+const supportedVersions = [4, 5]
+
+module.exports = function getSettings(context) {
+  const settings = {
+    ...defaults,
+    ...(context.settings ? context.settings.xstate : undefined)
+  }
+
+  if (!supportedVersions.includes(settings.version)) {
+    throw new Error(`XState version "${settings.version}" is not supported. Check "settings.xstate.version" in your ESLint config.`)
+  }
+  return settings
+}