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

package/dist/utils/RuleUtils.js

@@ -0,0 +1,128 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isAliasCall = isAliasCall;
+exports.isBrazilRepo = void 0;
+exports.isDirectCall = isDirectCall;
+exports.isFunctionAssignedToVariable = isFunctionAssignedToVariable;
+exports.isModuleFunctionAssignedToVariable = isModuleFunctionAssignedToVariable;
+exports.isNamespacedCall = isNamespacedCall;
+exports.isSDLProject = void 0;
+var fs = _interopRequireWildcard(require("fs"));
+var path = _interopRequireWildcard(require("path"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+// 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 NODE_TYPE_IDENTIFIER = 'Identifier';
+const NODE_TYPE_MEMBER_EXPRESSION = 'MemberExpression';
+
+/**
+ * Returns true if the provided function is assigned to a variable.
+ * e.g.
+ *      import { useReportFullyDrawn } from '@amazon-devices/kepler-performance-api';
+ *      const reportFullyDrawn = useReportFullyDrawn;
+ * @param node
+ * @param functionName
+ * @returns
+ */
+function isFunctionAssignedToVariable(node, functionName) {
+  if (node.init?.type === NODE_TYPE_IDENTIFIER && node.init.name === functionName) {
+    if (node.id.type === NODE_TYPE_IDENTIFIER) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Returns true if the provided function accessed through module, is assigned to a variable
+ * e.g.
+ *      import * as keplerPerfModule from '@amazon-devices/kepler-performance-api';
+ *      const reportFullyDrawn = keplerPerfModule.useReportFullyDrawn;
+ * @param node
+ * @param functionName
+ * @returns
+ */
+function isModuleFunctionAssignedToVariable(node, functionName) {
+  if (node.init?.type === NODE_TYPE_MEMBER_EXPRESSION && node.init.property.type === NODE_TYPE_IDENTIFIER && node.init.property.name === functionName) {
+    if (node.id.type === NODE_TYPE_IDENTIFIER) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Checks if a function call is a direct call to the function.
+ * e.g.
+ *      import { useReportFullyDrawn } from '@amazon-devices/kepler-performance-api';
+ *      useReportFullyDrawn();
+ * @param node
+ * @param functionName
+ * @returns
+ */
+function isDirectCall(node, functionName) {
+  return node.callee.type === NODE_TYPE_IDENTIFIER && node.callee.name === functionName;
+}
+
+/**
+ * Checks if a function call is an alias call to the function.
+ * e.g.
+ * a)
+ *    import { useReportFullyDrawn } from '@amazon-devices/kepler-performance-api';
+ *    const reportFullyDrawn = useReportFullyDrawn;
+ *    reportFullyDrawn();
+ *
+ * b)
+ *    import * as keplerPerfModule from '@amazon-devices/kepler-performance-api';
+ *    const reportFullyDrawn = keplerPerfModule.useReportFullyDrawn;
+ *    reportFullyDrawn();
+ *
+ * @param node
+ * @param functionName
+ * @param aliases
+ * @returns
+ */
+function isAliasCall(node, functionName, aliases) {
+  return node.callee.type === NODE_TYPE_IDENTIFIER && aliases.has(node.callee.name);
+}
+
+/**
+ * Checks if a function call is a namespaced call to the function.
+ * e.g.
+ *      import * as keplerPerfModule from '@amazon-devices/kepler-performance-api';
+ *      keplerPerfModule.useReportFullyDrawn();
+ * @param node
+ * @param functionName
+ * @returns
+ */
+function isNamespacedCall(node, functionName) {
+  return node.callee.type === NODE_TYPE_MEMBER_EXPRESSION && node.callee.property.type === NODE_TYPE_IDENTIFIER && node.callee.property.name === functionName;
+}
+const fileExists = (fileName, projectRoot = process.cwd()) => {
+  const configPath = path.join(projectRoot, fileName);
+  return fs.existsSync(configPath);
+};
+
+/**
+ * Checks if the current repository is a Brazil repository by looking for a Config file in the root folder.
+ * @returns true if Config file exists in root, false otherwise
+ */
+const isBrazilRepo = () => fileExists('Config');
+
+/**
+ * Checks if the current repository is a Vega SDL project by looking for kepler-system-conf.toml file in the root folder.
+ * @returns true if kepler-system-conf.toml file exists in root, false otherwise
+ */
+exports.isBrazilRepo = isBrazilRepo;
+const isSDLProject = () => fileExists('kepler-system-conf.toml');
+exports.isSDLProject = isSDLProject;

package/package.json

@@ -1 +1 @@
-{"name": "@amazon-devices/eslint-plugin-kepler", "version": "0.1.4", "description": "An ESLint Plugin to suggest Kepler App Development best practices", "main": "dist/index.js", "files": ["dist", "THIRD_PARTY_NOTICES.txt"], "scripts": {"test": "jest --colors", "lint": "eslint src __tests__ --ext .js,.ts,.tsx", "lint:fix": "eslint src __tests__ --ext .js,.ts,.tsx --fix", "typeCheck": "tsc --noEmit", "bundle": "webpack", "build": "npm-run-all lint typeCheck test bundle", "format": "prettier --config .prettierrc 'src/**/*.ts' '__tests__/**/*.ts' --write", "checkLicenses": "license-checker --production --exclude MIT,Apache-2.0,BSD-2-Clause,BSD-3-Clause,ISC,0BSD,Python-2.0", "genAttribution": "generate-attribution -o ./.attr && mv .attr/attribution.txt ./dist/LICENSE-THIRD-PARTY && rm -rf .attr"}, "devDependencies": {"@amazon-devices/kepler-telemetry-service-config": "*", "@amazon-devices/kepler-telemetry-service-typescript-client": "*", "@babel/cli": "^7.26.4", "@babel/core": "^7.26.9", "@babel/preset-env": "^7.26.9", "@babel/preset-typescript": "^7.26.0", "@eslint/js": "^8.12.0", "@trivago/prettier-plugin-sort-imports": "^5.2.1", "@types/eslint": "^8.4.1", "@types/jest": "^29.5.14", "@types/node": "^22.10.2", "@typescript-eslint/eslint-plugin": "^8.18.0", "@typescript-eslint/parser": "^8.18.0", "@typescript-eslint/types": "^8.18.0", "@typescript-eslint/utils": "^8.18.0", "babel-loader": "^9.2.1", "babel-plugin-transform-remove-console": "^6.9.4", "eslint": "^8.12.0", "globals": "^15.13.0", "husky": "^9.1.7", "jest": "^29.7.0", "license-checker": "^25.0.1", "npm-run-all": "^4.1.5", "oss-attribution-generator": "^1.7.1", "prettier-plugin-organize-imports": "^4.1.0", "ts-jest": "^29.2.5", "ts-node": "^10.9.2", "typescript": "^5.7.2", "typescript-eslint": "^8.18.0", "webpack": "^5.98.0", "webpack-cli": "^6.0.1"}, "dependencies": {"chalk": "^4.1.2", "toml": "^3.0.0", "uuid": "^11.0.0"}, "peerDependencies": {"eslint": ">=8.12.0"}, "husky": {"hooks": {"pre-commit": "npm run format"}}, "license": "See license in LICENSE"}
+{"name": "@amazon-devices/eslint-plugin-kepler", "version": "0.1.8", "description": "An ESLint Plugin to suggest Vega App Development best practices", "main": "dist/index.js", "files": ["dist", "THIRD_PARTY_NOTICES.txt"], "scripts": {"test": "jest --colors", "lint": "eslint src __tests__ --ext .js,.ts,.tsx", "lint:fix": "eslint src __tests__ --ext .js,.ts,.tsx --fix", "typeCheck": "tsc --noEmit", "bundle": "webpack", "clean": "rm -rf node_modules && rm package-lock.json && rm -rf dist", "compile": "babel src -d dist --extensions '.ts,.tsx'", "build": "npm-run-all lint typeCheck test compile", "rebuild": "rm -rf ./dist && npm run compile", "watch": "node scripts/watch.js", "format": "prettier --config .prettierrc 'src/**/*.ts' '__tests__/**/*.ts' --write", "checkLicenses": "license-checker --production --exclude MIT,Apache-2.0,BSD-2-Clause,BSD-3-Clause,ISC,0BSD,Python-2.0", "genAttribution": "generate-attribution -o ./.attr && mv .attr/attribution.txt ./dist/LICENSE-THIRD-PARTY && rm -rf .attr"}, "devDependencies": {"@babel/cli": "^7.26.4", "@babel/core": "^7.26.9", "@babel/preset-env": "^7.26.9", "@babel/preset-typescript": "^7.26.0", "@eslint/js": "^8.12.0", "@trivago/prettier-plugin-sort-imports": "^5.2.1", "@types/eslint": "^8.4.1", "@types/jest": "^29.5.14", "@types/node": "^22.10.2", "@types/semver": "^7.7.0", "@typescript-eslint/eslint-plugin": "^8.18.0", "@typescript-eslint/parser": "^8.18.0", "@typescript-eslint/types": "^8.18.0", "@typescript-eslint/utils": "^8.18.0", "babel-loader": "^9.2.1", "babel-plugin-transform-remove-console": "^6.9.0", "eslint": "^8.12.0", "globals": "^15.13.0", "husky": "^9.1.7", "jest": "^29.7.0", "license-checker": "^25.0.1", "npm-run-all": "^4.1.5", "oss-attribution-generator": "^1.7.1", "prettier-plugin-organize-imports": "^4.1.0", "ts-jest": "^29.2.5", "ts-node": "^10.9.2", "typescript": "^5.7.2", "typescript-eslint": "^8.18.0", "webpack": "^5.100.2", "webpack-cli": "^6.0.1"}, "dependencies": {"chalk": "^4.1.2", "jsonc-eslint-parser": ">=2.0.0", "semver": "^7.7.2", "toml": "^3.0.0", "uuid": "^11.0.0", "@amazon-devices/kepler-telemetry-service-config": "*", "@amazon-devices/kepler-telemetry-service-typescript-client": "*"}, "peerDependencies": {"eslint": ">=8.12.0", "jsonc-eslint-parser": ">=2.0.0"}, "husky": {"hooks": {"pre-commit": "npm run format"}}, "license": "See license in LICENSE"}

package/dist/formatters/default.js.LICENSE.txt

@@ -1 +0,0 @@
-/*! safe-buffer. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */