2.0.0-alpha.2 release

Author: enact-bot

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 The following is a curated list of changes in the Enact eslint plugin:
 
+## [2.0.0-alpha.2] - (February 20, 2025)
+
+* Updated Enact ESLint config to v9 including eslint related modules.
+
 ## [2.0.0-alpha.1] - (December 6, 2024)
 
 * Fixed a deprecation warning regarding nodejs.

README.md

@@ -66,7 +66,7 @@ With ESLint 2.x.x+:
 }
 ```
 
-Finally, enable all of the rules that you would like to use:
+Finally, enable all the rules that you would like to use:
 
 ```json
   "rules": {
@@ -79,7 +79,7 @@ Finally, enable all of the rules that you would like to use:
 
 # List of supported rules
 
-* [enact/kind-name](docs/rules/kind-name.md): Prevent missing `name` in a Enact component definition
+* [enact/kind-name](docs/rules/kind-name.md): Prevent missing `name` in an Enact component definition
 * [enact/display-name](docs/rules/display-name.md): Prevent missing `displayName` in a React component definitions without false-flagging Enact kinds
 * [enact/prop-types](docs/rules/prop-types.md): Prevent missing props validation in a React component definition
 * [enact/no-module-exports-import](docs/rules/no-module-exports-import.md): Disallow module.exports with import statements (see [webpack issue #4039](https://github.com/webpack/webpack/issues/4039))

docs/rules/display-name.md

@@ -41,7 +41,7 @@ See [display-name at eslint-plugin-react](https://github.com/yannickcr/eslint-pl
 
 For this rule to work we need to detect React components, this could be very hard since components could be declared in a lot of ways.
 
-For now we should detect components created with:
+For now, we should detect components created with:
 
 * `createReactClass()`
 * an ES6 class that inherit from `React.Component` or `Component`

docs/rules/prop-types.md

@@ -59,7 +59,7 @@ const Hello = kind({
   name: 'Example',
   propTypes: {
     firstname: React.PropTypes.string.isRequired,
-    middlename: React.PropTypes.string.isRequired
+    middlename: React.PropTypes.string.isRequired,
     lastname: React.PropTypes.string.isRequired
   },
   render: function ({firstname, ...rest}) {

index.js

@@ -25,22 +25,26 @@ module.exports = {
   rules: exportedRules,
   configs: {
     recommended: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true
+      languageOptions: {
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true
+          }
         }
       },
       rules: {
         'enact/prop-types': 2,
         'enact/kind-name': 2,
         'enact/display-name': 2,
         'enact/no-module-exports-import': 1
-      },
+      }
     },
     all: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true
+      languageOptions: {
+        parserOptions: {
+          ecmaFeatures: {
+            jsx: true
+          }
         }
       },
       rules: allRules

lib/rules/display-name.js

@@ -90,9 +90,9 @@ module.exports = {
     }
 
     /**
-     * Checks if the component have a name set by the transpiler
+     * Checks if the component has a name set by the transpiler
      * @param {ASTNode} node The AST node being checked.
-     * @returns {Boolean} True ifcomponent have a name, false if not.
+     * @returns {Boolean} True if component has a name, false if not.
      */
     function hasTranspilerName(node) {
       var namedObjectAssignment = (

lib/rules/kind-name.js

@@ -1,5 +1,5 @@
 /**
- * Prevent missing name string property in a Enact kind component definition
+ * Prevent missing name string property in an Enact kind component definition
  *
  * Based on the React display-name rule created by Yannick Croissant
  *     https://github.com/yannickcr/eslint-plugin-react
@@ -96,7 +96,7 @@ module.exports = {
     /**
      * Checks if the component have a name set by the transpiler
      * @param {ASTNode} node The AST node being checked.
-     * @returns {Boolean} True ifcomponent have a name, false if not.
+     * @returns {Boolean} True if component have a name, false if not.
      */
     function hasTranspilerName(node) {
       var namedObjectAssignment = (

lib/rules/no-module-exports-import.js

@@ -8,7 +8,6 @@
  */
 
 var {minimatch} = require('minimatch');
-var path = require('path');
 
 module.exports = {
 	meta: {
@@ -31,7 +30,7 @@ module.exports = {
 		var options = context.options[0] || {};
 
 		return {
-			ImportDeclaration: function ImportDeclaration(node) {
+			ImportDeclaration: function ImportDeclaration() {
 				usesES6Imports = true;
 			},
 			MemberExpression: function MemberExpression(node) {

lib/rules/prop-types.js

@@ -1,5 +1,5 @@
 /**
- * Prevent missing props validation in a Enact kind component definition
+ * Prevent missing props validation in an Enact kind component definition
  *
  * Based on the React prop-type rule created by Yannick Croissant
  *     https://github.com/yannickcr/eslint-plugin-react
@@ -69,8 +69,8 @@ module.exports = {
 
     /**
      * Helper for accessing the current scope in the stack.
-     * @param {string} key The name of the identifier to access. If omitted, returns the full scope.
-     * @param {ASTNode} value If provided sets the new value for the identifier.
+     * @param {string} [key] The name of the identifier to access. If omitted, returns the full scope.
+     * @param {ASTNode} [value] If provided sets the new value for the identifier.
      * @returns {Object|ASTNode} Either the whole scope or the ASTNode associated with the given identifier.
      */
     function typeScope(key, value) {
@@ -90,7 +90,7 @@ module.exports = {
      */
     function isPropTypesUsage(node) {
       var isClassUsage = (
-        (utils.getParentES6Component() || utils.getParentES5Component()) &&
+        (utils.getParentES6Component(node) || utils.getParentES5Component(node)) &&
         node.object.type === 'ThisExpression' && node.property.name === 'props'
       );
       var isStatelessFunctionUsage = node.object.name === 'props';
@@ -104,7 +104,7 @@ module.exports = {
      */
     function isAnnotatedClassPropsDeclaration(node) {
       if (node && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition')) {
-        var tokens = context.getFirstTokens(node, 2);
+        let tokens = sourceCode.getFirstTokens ? sourceCode.getFirstTokens(node, 2) : context.getFirstTokens(node, 2);
         if (
           node.typeAnnotation && (
             tokens[0].value === 'props' ||
@@ -124,7 +124,7 @@ module.exports = {
       */
     function isAnnotatedFunctionPropsDeclaration(node) {
       if (node && node.params && node.params.length) {
-        var tokens = context.getFirstTokens(node.params[0], 2);
+        let tokens = sourceCode.getFirstTokens ? sourceCode.getFirstTokens(node.params[0], 2) : context.getFirstTokens(node.params[0], 2);
         var isAnnotated = node.params[0].typeAnnotation;
         var isDestructuredProps = node.params[0].type === 'ObjectPattern';
         var isProps = tokens[0].value === 'props' || (tokens[1] && tokens[1].value === 'props');
@@ -170,7 +170,7 @@ module.exports = {
       // Special case for class properties
       // (babel-eslint does not expose property name so we have to rely on tokens)
       if (node && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition')) {
-        var tokens = context.getFirstTokens(node, 2);
+        let tokens = sourceCode.getFirstTokens ? sourceCode.getFirstTokens(node, 2) : context.getFirstTokens(node, 2);
         if (
           tokens[0].value === 'propTypes' ||
           (tokens[1] && tokens[1].value === 'propTypes')
@@ -257,7 +257,7 @@ module.exports = {
             // this is the last key, accept everything
             return true;
           }
-          // non trivial, check all of them
+          // non-trivial, check all of them
           var unionTypes = propType.children;
           var unionPropType = {};
           for (var k = 0, z = unionTypes.length; k < z; k++) {
@@ -312,12 +312,12 @@ module.exports = {
 
     /**
      * Retrieve the name of a key node
-     * @param {ASTNode} node The AST node with the key.
+     * @param {Object|ASTNode} node The AST node with the key.
      * @return {string} the name of the key
      */
     function getKeyValue(node) {
       if (node.type === 'ObjectTypeProperty') {
-        var tokens = context.getFirstTokens(node, 1);
+        let tokens = sourceCode.getFirstTokens ? sourceCode.getFirstTokens(node, 1) : context.getFirstTokens(node, 1);
         return tokens[0].value;
       }
       var key = node.key || node.argument || node.property;
@@ -451,7 +451,7 @@ module.exports = {
     /**
      * Creates the representation of the React props type annotation for the component.
      * The representation is used to verify nested used properties.
-     * @param {ASTNode} annotation Type annotation for the props class property.
+     * @param {Object|ASTNode} annotation Type annotation for the props class property.
      * @return {Object|Boolean} The representation of the declaration, true means
      *    the property is declared without the need for further analysis.
      */
@@ -511,8 +511,8 @@ module.exports = {
      * Check if we are in a class constructor
      * @return {boolean} true if we are in a class constructor, false if not
      */
-    function inConstructor() {
-      var scope = context.getScope();
+    function inConstructor(node) {
+      let scope = sourceCode.getScope ? sourceCode.getScope(node) : context.getScope();
       while (scope) {
         if (scope.block && scope.block.parent && scope.block.parent.kind === 'constructor') {
           return true;
@@ -529,7 +529,7 @@ module.exports = {
      */
     function getPropertyName(node) {
       var isDirectProp = DIRECT_PROPS_REGEX.test(sourceCode.getText(node));
-      var isInClassComponent = utils.getParentES6Component() || utils.getParentES5Component();
+      var isInClassComponent = utils.getParentES6Component(node) || utils.getParentES5Component(node);
       var isNotInConstructor = !inConstructor(node);
 
       if (isInClassComponent && utils.isKindComponent(isInClassComponent)) {
@@ -576,7 +576,7 @@ module.exports = {
      * @param {ASTNode} node The AST node being marked.
      */
     function markComputedPropTypes(node) {
-      var component = components.get(utils.getParentComponent());
+      var component = components.get(utils.getParentComponent(node));
       var computed = component && component.computedProps || [];
       for(var i=0; i<node.properties.length; i++) {
         if(node.properties[i] && node.properties[i].key && node.properties[i].key.name) {
@@ -593,7 +593,7 @@ module.exports = {
      * @param {ASTNode} node The AST node being marked.
      */
     function markHandlersPropTypes(node) {
-      var component = components.get(utils.getParentComponent());
+      var component = components.get(utils.getParentComponent(node));
       var handlers = component && component.handlersProps || [];
       for(var i=0; i<node.properties.length; i++) {
         if(node.properties[i] && node.properties[i].key && node.properties[i].key.name) {
@@ -608,6 +608,7 @@ module.exports = {
     /**
      * Mark a prop type as used
      * @param {ASTNode} node The AST node being marked.
+     * @param {Array} [parentNames] The list of parent names.
      */
     function markPropTypesAsUsed(node, parentNames) {
       parentNames = parentNames || [];
@@ -692,7 +693,7 @@ module.exports = {
             // let {firstname} = props
             var directDestructuring =
               node.init.name === 'props' &&
-              (utils.getParentStatelessComponent() || inConstructor())
+              (utils.getParentStatelessComponent(node) || inConstructor(node))
             ;
 
             if (thisDestructuring) {
@@ -710,7 +711,7 @@ module.exports = {
           throw new Error(node.type + ' ASTNodes are not handled by markPropTypesAsUsed');
       }
 
-      var component = components.get(utils.getParentComponent());
+      var component = components.get(utils.getParentComponent(node));
       var usedPropTypes = component && component.usedPropTypes || [];
 
       switch (type) {
@@ -764,7 +765,7 @@ module.exports = {
     /**
      * Mark a prop type as declared
      * @param {ASTNode} node The AST node being checked.
-     * @param {propTypes} node The AST node containing the proptypes
+     * @param {Object|ASTNode} propTypes The AST node containing the proptypes.
      */
     function markPropTypesAsDeclared(node, propTypes) {
       var componentNode = node;
@@ -819,7 +820,7 @@ module.exports = {
           }
           break;
         case 'Identifier':
-          var variablesInScope = variable.variablesInScope(context);
+          var variablesInScope = variable.variablesInScope(sourceCode, context, componentNode)
           for (var i = 0, j = variablesInScope.length; i < j; i++) {
             if (variablesInScope[i].name !== propTypes.name) {
               continue;
@@ -845,7 +846,7 @@ module.exports = {
 
     /**
      * Reports undeclared proptypes for a given component
-     * handlers can be used in computed, but not vice-versa.
+     * handlers can be used in computed, but not vice versa.
      * handlers and computed props can't reference others declared
      * only in the same place.
      * @param {Object} component The component to process
@@ -889,7 +890,7 @@ module.exports = {
      * This method also resolves type aliases where possible.
      *
      * @param {ASTNode} node The annotation or a node containing the type annotation.
-     * @returns {ASTNode} The resolved type annotation for the node.
+     * @returns {Object|ASTNode} The resolved type annotation for the node.
      */
     function resolveTypeAnnotation(node) {
       var annotation = node.typeAnnotation || node;
@@ -999,7 +1000,7 @@ module.exports = {
         var directDestructuring =
           destructuring &&
           node.init.name === 'props' &&
-          (utils.getParentStatelessComponent() || inConstructor())
+          (utils.getParentStatelessComponent(node) || inConstructor(node))
         ;
 
         if (!thisDestructuring && !directDestructuring) {