@amazon-devices/eslint-plugin-kepler 0.1.8 → 0.1.13

package/dist/rules/performance/CheckSubscription.js

@@ -1,150 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.CheckSubscription = void 0;
-var _Constants = require("../../utils/Constants");
-// Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
-// AMAZON PROPRIETARY/CONFIDENTIAL
-// You may not use this file except in compliance with the terms and conditions
-// set forth in the accompanying LICENSE.TXT file.
-// THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
-// DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
-// IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
-
-const moreUrlMessage = `See ${_Constants.VEGA_BEST_PRACTICE_URL}#listeners-event-subscriptions-and-timers for more.`;
-const CheckSubscription = exports.CheckSubscription = {
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'Checks if subscriptions are set to be cleaned up',
-      recommended: true,
-      category: 'Performance'
-    },
-    fixable: 'code',
-    schema: [],
-    messages: {
-      failedToKeepSubscription: `Subscription must be kept in variable so that it can be cleaned up on the component is detached.  ${moreUrlMessage}`,
-      missingCleanUp: `Subscription \`{{varName}}\` is not cleaned up.  ${moreUrlMessage}`
-    }
-  },
-  create(context) {
-    const addListenerFuncs = new Set();
-    const subscriptionVars = new Set();
-    const subscriptionCollections = new Set();
-    const stateManagerVars = new Set();
-
-    // Return true if the given node is a call to adding a listener.
-    // Ex. `addInputListener(..)` or `appStateManager.addAppStateListener(...)`
-    function isExpressionToAddListener(node) {
-      if (node.callee.type === 'Identifier') {
-        return addListenerFuncs.has(node.callee.name);
-      }
-      if (node.callee.type === 'MemberExpression') {
-        if (node.callee.object.type === 'Identifier' && stateManagerVars.has(node.callee.object.name) && node.callee.property.type === 'Identifier' && node.callee.property.name === 'addAppStateListener') {
-          return true;
-        }
-      }
-      return false;
-    }
-    return {
-      // Collect variables containing functions to add listener.
-      // Ex. `const ${var} = useAddKeplerAppStateListenerCallback()`
-      'VariableDeclarator[init.callee.name = /^useAdd(KeplerAppState|UserInput)ListenerCallback$/]': node => {
-        if (node.id.type === 'Identifier') {
-          const varName = node.id.name;
-          addListenerFuncs.add(varName);
-        }
-      },
-      // Collect variables containing AppStateManager.
-      // Ex. `const ${varName} = useKeplerAppStateManager()`
-      'VariableDeclarator[init.callee.name = /^useKeplerAppStateManager$/]': node => {
-        if (node.id.type === 'Identifier') {
-          const varName = node.id.name;
-          stateManagerVars.add(varName);
-        }
-      },
-      // Check the code adding listeners and collect variables containing subscriptions.
-      // Warn code like `useEffect(() => {...; ${addListenerFunc}(....); ...}`
-      // Collect vars like `useEffect(() => {...; ${subscriptionVar} = ${addListenerFunc}(....); ...}`
-      // or `useEffect(() => {...; ${subscriptionCollection}.push(${addListenerFunc}(....)); ...}`
-      "CallExpression[callee.name='useEffect'] :function CallExpression": node => {
-        if (isExpressionToAddListener(node)) {
-          const sourceCode = context.sourceCode ?? context.getSourceCode();
-          const ancestors = sourceCode.getAncestors?.(node) ?? context.getAncestors();
-          if (ancestors.length >= 1) {
-            const parent = ancestors[ancestors.length - 1];
-            if (parent.type === 'VariableDeclarator' && parent.id.type == 'Identifier') {
-              // [const|let|var] ${var} = ${addListenerFunc}(....)
-              subscriptionVars.add(parent.id.name);
-              return;
-            } else if (parent.type === 'AssignmentExpression' && parent.left.type == 'Identifier') {
-              // ${var} = ${addListenerFunc}(....)
-              subscriptionVars.add(parent.left.name);
-              return;
-            } else if (parent.type === 'CallExpression' && parent.arguments[0] === node && parent.callee.type === 'MemberExpression') {
-              const callee = parent.callee;
-              if (
-              // ${collection}.[add|push](${addListenerFunc}(....));
-              callee.property.type === 'Identifier' && ['add', 'push'].includes(callee.property.name) && callee.object.type === 'Identifier') {
-                subscriptionCollections.add(callee.object.name);
-                return;
-              }
-            }
-          }
-          context.report({
-            node: node,
-            messageId: 'failedToKeepSubscription'
-          });
-        }
-      },
-      // Remove subscription vars that are cleaned up in a function returned by the effect function.
-      // Ex. `useEffect(() => {...; return () => ${subscriptionVar}.remove()});`
-      "CallExpression[callee.name='useEffect'] :function ReturnStatement CallExpression[callee.property.name='remove']": removeCall => {
-        if (removeCall.callee.type === 'MemberExpression') {
-          const callee = removeCall.callee;
-          if (callee.object.type === 'Identifier' && subscriptionVars.has(callee.object.name)) {
-            subscriptionVars.delete(callee.object.name);
-          }
-        }
-      },
-      // Remove subscription collections that are cleaned up in a function returned by the effect function.
-      // Ex. `useEffect(() => {...; return () => ${subscriptionCollection}.forEach(s => s.remove())});`
-      "CallExpression[callee.name='useEffect'] :function ReturnStatement CallExpression[callee.property.name='forEach']": forEachCall => {
-        if (forEachCall.callee.type === 'MemberExpression') {
-          const callee = forEachCall.callee;
-          if (callee.object.type === 'Identifier' && subscriptionCollections.has(callee.object.name)) {
-            // Though it would be more precise to check if each subscription is removed in the function passed to `forEach`,
-            // it's overkill. Let's accept false-negative by now.
-            subscriptionCollections.delete(callee.object.name);
-          }
-        }
-      },
-      // Report all subscription vars and collections that are not removed at the exit of `useEffect` call
-      "CallExpression[callee.name='useEffect']:exit": node => {
-        for (const varName of subscriptionVars) {
-          context.report({
-            node,
-            messageId: 'missingCleanUp',
-            data: {
-              varName
-            }
-          });
-        }
-        for (const varName of subscriptionCollections) {
-          context.report({
-            node,
-            messageId: 'missingCleanUp',
-            data: {
-              varName
-            }
-          });
-        }
-        subscriptionVars.clear();
-        subscriptionCollections.clear();
-      }
-    };
-  }
-};

package/dist/rules/performance/DetectSplashScreen.js

@@ -1,62 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DetectSplashScreen = void 0;
-var _KeplerESLintPluginStateManager = require("../../state/KeplerESLintPluginStateManager");
-var _RuleUtils = require("../../utils/RuleUtils");
-// Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
-// AMAZON PROPRIETARY/CONFIDENTIAL
-// You may not use this file except in compliance with the terms and conditions
-// set forth in the accompanying LICENSE.TXT file.
-// THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
-// DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
-// IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
-
-const USE_PREVENT_HIDE_SPLASH_SCREEN = 'usePreventHideSplashScreen';
-const USE_HIDE_SPLASH_SCREEN_CALLBACK = 'useHideSplashScreenCallback';
-const DetectSplashScreen = exports.DetectSplashScreen = {
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'usePreventHideSplashScreen() should be used to natively render splash screen, for better App launch performance',
-      recommended: true,
-      category: 'Performance'
-    },
-    fixable: 'code',
-    schema: []
-  },
-  create(context) {
-    const usePreventHideSplashScreenAliases = new Set();
-    const useHideSplashScreenCallbackAliases = new Set();
-    return {
-      VariableDeclarator(node) {
-        // Check usePreventHideSplashScreen()
-        if ((0, _RuleUtils.isFunctionAssignedToVariable)(node, USE_PREVENT_HIDE_SPLASH_SCREEN) || (0, _RuleUtils.isModuleFunctionAssignedToVariable)(node, USE_PREVENT_HIDE_SPLASH_SCREEN)) {
-          usePreventHideSplashScreenAliases.add(node.id['name']);
-        }
-        // Check useHideSplashScreenCallback()
-        else if ((0, _RuleUtils.isFunctionAssignedToVariable)(node, USE_HIDE_SPLASH_SCREEN_CALLBACK) || (0, _RuleUtils.isModuleFunctionAssignedToVariable)(node, USE_HIDE_SPLASH_SCREEN_CALLBACK)) {
-          useHideSplashScreenCallbackAliases.add(node.id['name']);
-        }
-      },
-      CallExpression(node) {
-        // Check usePreventHideSplashScreen()
-        if ((0, _RuleUtils.isDirectCall)(node, USE_PREVENT_HIDE_SPLASH_SCREEN) || (0, _RuleUtils.isAliasCall)(node, USE_PREVENT_HIDE_SPLASH_SCREEN, usePreventHideSplashScreenAliases) || (0, _RuleUtils.isNamespacedCall)(node, USE_PREVENT_HIDE_SPLASH_SCREEN)) {
-          const keplerESLintState = _KeplerESLintPluginStateManager.KeplerESLintPluginStateManager.getInstance().getKeplerESLintState();
-          keplerESLintState.splashScreen.usePreventHideSplashScreenFound = true;
-          _KeplerESLintPluginStateManager.KeplerESLintPluginStateManager.getInstance().setKeplerESLintState(keplerESLintState);
-        }
-
-        // Check useHideSplashScreenCallback()
-        else if ((0, _RuleUtils.isDirectCall)(node, USE_HIDE_SPLASH_SCREEN_CALLBACK) || (0, _RuleUtils.isAliasCall)(node, USE_HIDE_SPLASH_SCREEN_CALLBACK, useHideSplashScreenCallbackAliases) || (0, _RuleUtils.isNamespacedCall)(node, USE_HIDE_SPLASH_SCREEN_CALLBACK)) {
-          const keplerESLintState = _KeplerESLintPluginStateManager.KeplerESLintPluginStateManager.getInstance().getKeplerESLintState();
-          keplerESLintState.splashScreen.useHideSplashScreenCallbackFound = true;
-          _KeplerESLintPluginStateManager.KeplerESLintPluginStateManager.getInstance().setKeplerESLintState(keplerESLintState);
-        }
-      }
-    };
-  }
-};

package/dist/rules/performance/DetectUseReportFullyDrawn.js

@@ -1,50 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DetectUseReportFullyDrawn = void 0;
-var _KeplerESLintPluginStateManager = require("../../state/KeplerESLintPluginStateManager");
-var _RuleUtils = require("../../utils/RuleUtils");
-// Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
-// AMAZON PROPRIETARY/CONFIDENTIAL
-// You may not use this file except in compliance with the terms and conditions
-// set forth in the accompanying LICENSE.TXT file.
-// THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
-// DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
-// IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
-
-const USE_REPORT_FULLY_DRAWN_FUNCTION_NAME = 'useReportFullyDrawn';
-const DetectUseReportFullyDrawn = exports.DetectUseReportFullyDrawn = {
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'useReportFullyDrawn() callback should be used to measure Time to Fully Drawn',
-      recommended: true,
-      category: 'Performance'
-    },
-    fixable: 'code',
-    schema: []
-  },
-  create(context) {
-    const useReportFullyDrawnAliases = new Set();
-    return {
-      VariableDeclarator(node) {
-        if ((0, _RuleUtils.isFunctionAssignedToVariable)(node, USE_REPORT_FULLY_DRAWN_FUNCTION_NAME)) {
-          useReportFullyDrawnAliases.add(node.id['name']);
-        }
-        if ((0, _RuleUtils.isModuleFunctionAssignedToVariable)(node, USE_REPORT_FULLY_DRAWN_FUNCTION_NAME)) {
-          useReportFullyDrawnAliases.add(node.id['name']);
-        }
-      },
-      CallExpression(node) {
-        if ((0, _RuleUtils.isDirectCall)(node, USE_REPORT_FULLY_DRAWN_FUNCTION_NAME) || (0, _RuleUtils.isAliasCall)(node, USE_REPORT_FULLY_DRAWN_FUNCTION_NAME, useReportFullyDrawnAliases) || (0, _RuleUtils.isNamespacedCall)(node, USE_REPORT_FULLY_DRAWN_FUNCTION_NAME)) {
-          const keplerESLintState = _KeplerESLintPluginStateManager.KeplerESLintPluginStateManager.getInstance().getKeplerESLintState();
-          keplerESLintState.fullyDrawn.useReportFullyDrawnFound = true;
-          _KeplerESLintPluginStateManager.KeplerESLintPluginStateManager.getInstance().setKeplerESLintState(keplerESLintState);
-        }
-      }
-    };
-  }
-};

package/dist/rules/performance/FlatList.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.FlatList = void 0;
-var _Constants = require("../../utils/Constants");
-/* eslint-disable @typescript-eslint/explicit-function-return-type */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-const FLATLIST_PERF_REQD_PROPS = ['initialNumToRender', 'windowSize', 'removeClippedSubviews', 'maxToRenderPerBatch', 'updateCellsBatchingPeriod'];
-const FlatList = exports.FlatList = {
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'FlatList causes performance overhead and should be used carefully',
-      recommended: true,
-      category: 'Performance'
-    },
-    fixable: 'code',
-    schema: []
-  },
-  create(context) {
-    return {
-      JSXOpeningElement(node) {
-        if (node.name.name === 'FlatList') {
-          const currentFlatListPropNames = node.attributes.map(attr => attr.name.name);
-          const missingProps = FLATLIST_PERF_REQD_PROPS.filter(prop => !currentFlatListPropNames.includes(prop));
-          if (missingProps.length > 0) {
-            context.report({
-              node,
-              message: `FlatList missing props: '${missingProps}'.  FlatList performance is not fully unlocked without these props.  ` + `See ${_Constants.VEGA_BEST_PRACTICE_URL}#flatlist for more.`
-            });
-          }
-        }
-      }
-    };
-  }
-};

package/dist/rules/systemDistributedLibs/SDLPackageVersionCheck.js

@@ -1,136 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.SDLPackageVersionCheck = void 0;
-var _sdlHelpers = require("./sdlHelpers");
-var _sdlRuleMessages = require("./sdlRuleMessages");
-// Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
-// AMAZON PROPRIETARY/CONFIDENTIAL
-// You may not use this file except in compliance with the terms and conditions
-// set forth in the accompanying LICENSE.TXT file.
-// THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
-// DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
-// IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
-
-/* eslint-disable @typescript-eslint/explicit-function-return-type */ // ESLint Rule API uses complex inferred types
-/* eslint-disable @typescript-eslint/no-explicit-any */ // AST node types are complex, using any for simplicity
-
-/**
- * ESLint rule to validate SDL package versions in package.json
- */
-const SDLPackageVersionCheck = exports.SDLPackageVersionCheck = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: 'Validates that SDL dependencies use proper semantic versioning with ~ or < prefixes',
-      recommended: true,
-      category: 'System Distributed Libraries'
-    },
-    schema: [{
-      type: 'object',
-      properties: {
-        semverGuidance: {
-          oneOf: [{
-            type: 'string',
-            enum: ['minor', 'patch', 'auto']
-          }]
-        }
-      },
-      additionalProperties: false
-    }]
-  },
-  create(context) {
-    const options = context.options[0] || {};
-    const isMinorUpgradeMode = (0, _sdlHelpers.determineMinorUpdateMode)(options.semverGuidance);
-    return {
-      JSONProperty(node) {
-        // Only check properties in dependencies and peerDependencies
-        const parent = node.parent;
-        if (parent?.type === 'JSONObjectExpression' && parent.parent?.type === 'JSONProperty') {
-          const grandParent = parent.parent;
-          if (grandParent.key?.type === 'JSONLiteral') {
-            const sectionName = grandParent.key.value;
-            if (['dependencies', 'peerDependencies'].includes(sectionName)) {
-              // Check if this property is an SDL package
-              if (node.key?.type === 'JSONLiteral' && node.value?.type === 'JSONLiteral') {
-                const packageName = node.key.value;
-                const version = node.value.value;
-                const isSDLPackage = (0, _sdlHelpers.isSystemDistributedLibrary)(packageName);
-                if (isSDLPackage && typeof version === 'string') {
-                  // Check for greater-than operators (error in both modes)
-                  if ((0, _sdlHelpers.hasGreaterThanOperators)(version)) {
-                    context.report({
-                      node: node.value,
-                      message: _sdlRuleMessages.GREATER_THAN_VERSION_ERROR
-                    });
-                    return;
-                  }
-
-                  // Check for wildcards - but allow patch-only wildcards like "2.0.x"
-                  if ((0, _sdlHelpers.hasWildcards)(version)) {
-                    // If it's a patch-only wildcard, it's allowed in conservative mode
-                    if (!(0, _sdlHelpers.allowsPatchUpgrades)(version)) {
-                      if (isMinorUpgradeMode) {
-                        context.report({
-                          node: node.value,
-                          message: _sdlRuleMessages.MINOR_UPGRADE_MODE_WILDCARD_WARNING
-                        });
-                      } else {
-                        context.report({
-                          node: node.value,
-                          message: _sdlRuleMessages.WILDCARD_VERSION_ERROR
-                        });
-                      }
-                      return;
-                    }
-                  }
-
-                  // Check for locked versions or partial ranges (flagged in both modes)
-                  if ((0, _sdlHelpers.isLockedOrPartialRange)(version)) {
-                    if (isMinorUpgradeMode) {
-                      context.report({
-                        node: node.value,
-                        message: _sdlRuleMessages.MINOR_UPGRADE_MODE_LOCKED_VERSION_WARNING
-                      });
-                    } else {
-                      context.report({
-                        node: node.value,
-                        message: _sdlRuleMessages.LOCKED_VERSION_WARNING
-                      });
-                    }
-                    return;
-                  }
-                  if (isMinorUpgradeMode) {
-                    // Pre-release mode: flag major upgrades or prohibiting minor upgrades
-                    if ((0, _sdlHelpers.allowsMajorUpgrades)(version)) {
-                      context.report({
-                        node: node.value,
-                        message: _sdlRuleMessages.MAJOR_UPGRADE_WARNING
-                      });
-                    } else if ((0, _sdlHelpers.prohibitsMinorUpgrades)(version)) {
-                      context.report({
-                        node: node.value,
-                        message: _sdlRuleMessages.PROHIBITS_MINOR_WARNING
-                      });
-                    }
-                  } else {
-                    // Conservative mode: flag minor or major upgrades
-                    if ((0, _sdlHelpers.allowsMinorUpgrades)(version) || (0, _sdlHelpers.allowsMajorUpgrades)(version)) {
-                      context.report({
-                        node: node.value,
-                        message: _sdlRuleMessages.MINOR_OR_MAJOR_UPGRADE_WARNING
-                      });
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    };
-  }
-};

package/dist/rules/systemDistributedLibs/SDLPackageVersionCheckImports.js

@@ -1,58 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.SDLPackageVersionCheckImports = void 0;
-var _sdlHelpers = require("./sdlHelpers");
-var _sdlRuleMessages = require("./sdlRuleMessages");
-// Copyright 2025 Amazon.com, Inc. or its affiliates. All rights reserved.
-// AMAZON PROPRIETARY/CONFIDENTIAL
-// You may not use this file except in compliance with the terms and conditions
-// set forth in the accompanying LICENSE.TXT file.
-// THESE MATERIALS ARE PROVIDED ON AN "AS IS" BASIS. AMAZON SPECIFICALLY
-// DISCLAIMS, WITH RESPECT TO THESE MATERIALS, ALL WARRANTIES, EXPRESS,
-// IMPLIED, OR STATUTORY, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
-
-/* eslint-disable @typescript-eslint/explicit-function-return-type */ // ESLint Rule API uses complex inferred types
-/* eslint-disable @typescript-eslint/no-explicit-any */ // AST node types are complex, using any for simplicity
-
-/**
- * ESLint rule to flag imports of system distributed libraries
- */
-const SDLPackageVersionCheckImports = exports.SDLPackageVersionCheckImports = {
-  meta: {
-    type: 'suggestion',
-    docs: {
-      description: 'Flags imports of system distributed libraries with informational messages',
-      recommended: true,
-      category: 'System Distributed Libraries'
-    },
-    schema: [{
-      type: 'object',
-      properties: {
-        semverGuidance: {
-          oneOf: [{
-            type: 'string',
-            enum: ['minor', 'patch', 'auto']
-          }]
-        }
-      },
-      additionalProperties: false
-    }]
-  },
-  create(context) {
-    return {
-      ImportDeclaration(node) {
-        const importSource = node.source.value;
-        if ((0, _sdlHelpers.isSystemDistributedLibrary)(importSource)) {
-          context.report({
-            node: node.source,
-            message: `${importSource} ${_sdlRuleMessages.SBL_IMPORT_MESSAGE}`
-          });
-        }
-      }
-    };
-  }
-};