fix: handle import aliases

salesforcecli · Jul 23, 2024 · 17e392b · 17e392b
1 parent 127a366
commit 17e392b
Show file tree

Hide file tree

Showing 77 changed files with 344 additions and 48 deletions.
diff --git a/src/rules/command-example.ts b/src/rules/command-example.ts
@@ -28,7 +28,7 @@ export const commandExamples = createRule({
       ? {
           ClassDeclaration(node): void {
             // verify it extends SfCommand
-            if (extendsSfCommand(node) && node.id) {
+            if (extendsSfCommand(node,context) && node.id) {
               if (!node.body.body.some((member) => getClassPropertyIdentifierName(member) === 'examples')) {
                 context.report({
                   node: node.id,

diff --git a/src/rules/command-summary.ts b/src/rules/command-summary.ts
@@ -27,7 +27,7 @@ export const commandSummary = RuleCreator.withoutDocs({
       ? {
           ClassDeclaration(node): void {
             // verify it extends SfCommand
-            if (extendsSfCommand(node) && node.id) {
+            if (extendsSfCommand(node, context) && node.id) {
               if (!node.body.body.some((member) => getClassPropertyIdentifierName(member) === 'summary')) {
                 const descriptionNode = node.body.body.find(
                   (member) => getClassPropertyIdentifierName(member) === 'description'

diff --git a/src/rules/dash-h.ts b/src/rules/dash-h.ts
@@ -29,7 +29,7 @@ export const dashH = RuleCreator.withoutDocs({
             // is a flag
             if (
               isFlag(node) &&
-              ancestorsContainsSfCommand(context.getAncestors()) &&
+              ancestorsContainsSfCommand(context) &&
               node.value?.type === AST_NODE_TYPES.CallExpression &&
               node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
             ) {

diff --git a/src/rules/dash-o.ts b/src/rules/dash-o.ts
@@ -30,7 +30,7 @@ export const dashO = RuleCreator.withoutDocs({
             // is a flag
             if (
               isFlag(node) &&
-              ancestorsContainsSfCommand(context.getAncestors()) &&
+              ancestorsContainsSfCommand(context) &&
               node.value?.type === AST_NODE_TYPES.CallExpression &&
               node.value.callee?.type === AST_NODE_TYPES.MemberExpression &&
               node.value.callee.property.type === AST_NODE_TYPES.Identifier &&

diff --git a/src/rules/extract-message-command.ts b/src/rules/extract-message-command.ts
@@ -29,7 +29,7 @@ export const extractMessageCommand = RuleCreator.withoutDocs({
       ? {
           ClassDeclaration(node): void {
             // verify it extends SfCommand
-            if (extendsSfCommand(node)) {
+            if (extendsSfCommand(node, context)) {
               node.body.body
                 .filter((prop) =>
                   // this could be `undefined` but that works okay with `.includes`

diff --git a/src/rules/extract-message-flags.ts b/src/rules/extract-message-flags.ts
@@ -37,7 +37,7 @@ export const extractMessageFlags = RuleCreator.withoutDocs({
               node.key.type === AST_NODE_TYPES.Identifier &&
               (node.key.name === 'summary' || node.key.name === 'description') &&
               ancestors.some((a) => isFlag(a)) &&
-              ancestorsContainsSfCommand(ancestors)
+              ancestorsContainsSfCommand(context)
             ) {
               if (node.value.type === AST_NODE_TYPES.Literal) {
                 context.report({

diff --git a/src/rules/flag-casing.ts b/src/rules/flag-casing.ts
@@ -32,7 +32,7 @@ export const flagCasing = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           Property(node): void {
-            if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (isFlag(node) && ancestorsContainsSfCommand(context)) {
               const flagName = resolveFlagName(node);
               if (flagName && toLowerKebabCase(flagName) !== flagName) {
                 context.report({

diff --git a/src/rules/flag-cross-references.ts b/src/rules/flag-cross-references.ts
@@ -35,7 +35,7 @@ export const flagCrossReferences = RuleCreator.withoutDocs({
               node.value.type === AST_NODE_TYPES.ArrayExpression &&
               node.value.elements.every((e) => e?.type === AST_NODE_TYPES.Literal && e?.raw) &&
               propertyNames.includes(node.key.name) &&
-              ancestorsContainsSfCommand(ancestors) &&
+              ancestorsContainsSfCommand(context) &&
               ancestors.some((a) => isFlag(a))
             ) {
               const flagsNode = ancestors

diff --git a/src/rules/flag-min-max-default.ts b/src/rules/flag-min-max-default.ts
@@ -27,7 +27,7 @@ export const flagMinMaxDefault = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           Property(node): void {
-            if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (isFlag(node) && ancestorsContainsSfCommand(context)) {
               if (
                 node.value?.type === AST_NODE_TYPES.CallExpression &&
                 node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression &&

diff --git a/src/rules/flag-summary.ts b/src/rules/flag-summary.ts
@@ -30,7 +30,7 @@ export const flagSummary = RuleCreator.withoutDocs({
           Property(node): void {
             if (
               isFlag(node) &&
-              ancestorsContainsSfCommand(context.getAncestors()) &&
+              ancestorsContainsSfCommand(context) &&
               node.value?.type === AST_NODE_TYPES.CallExpression &&
               node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
             ) {

diff --git a/src/rules/get-connections-with-version.ts b/src/rules/get-connections-with-version.ts
@@ -33,7 +33,7 @@ export const getConnectionWithVersion = RuleCreator.withoutDocs({
               node.callee?.type === AST_NODE_TYPES.MemberExpression &&
               node.callee.property.type === AST_NODE_TYPES.Identifier &&
               node.callee.property?.name === 'getConnection' &&
-              ancestorsContainsSfCommand(context.getAncestors())
+              ancestorsContainsSfCommand(context)
             ) {
               context.report({
                 node: node.callee.property,

diff --git a/src/rules/id-flag-suggestions.ts b/src/rules/id-flag-suggestions.ts
@@ -32,7 +32,7 @@ export const idFlagSuggestions = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           Property(node): void {
-            if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (isFlag(node) && ancestorsContainsSfCommand(context)) {
               if (
                 (node.key.type === AST_NODE_TYPES.Identifier || node.key.type === AST_NODE_TYPES.Literal) &&
                 node.value?.type === AST_NODE_TYPES.CallExpression &&

diff --git a/src/rules/migration/encourage-alias-deprecation.ts b/src/rules/migration/encourage-alias-deprecation.ts
@@ -32,7 +32,7 @@ export const encourageAliasDeprecation = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           PropertyDefinition(node): void {
-            if (ancestorsContainsSfCommand(context.getAncestors())) {
+            if (ancestorsContainsSfCommand(context)) {
               if (node.key.type === AST_NODE_TYPES.Identifier && node.key.name === 'aliases') {
                 // but you don't have deprecateAliases = true then add id
                 if (
@@ -63,7 +63,7 @@ export const encourageAliasDeprecation = RuleCreator.withoutDocs({
               isFlag(node) &&
               node.value?.type === AST_NODE_TYPES.CallExpression &&
               node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression &&
-              ancestorsContainsSfCommand(context.getAncestors())
+              ancestorsContainsSfCommand(context)
             ) {
               const argProps = node.value.arguments[0].properties.filter(
                 ASTUtils.isNodeOfType(AST_NODE_TYPES.Property)

diff --git a/src/rules/migration/no-builtin-flags.ts b/src/rules/migration/no-builtin-flags.ts
@@ -33,7 +33,7 @@ export const noBuiltinFlags = RuleCreator.withoutDocs({
               isFlag(node) &&
               node.key.type === AST_NODE_TYPES.Identifier &&
               builtInFlagTypes.includes(node.key.name) &&
-              ancestorsContainsSfCommand(context.getAncestors())
+              ancestorsContainsSfCommand(context)
             ) {
               const toReplace = getCalleePropertyByName(node, 'builtin');
               if (toReplace) {

diff --git a/src/rules/migration/no-deprecated-properties.ts b/src/rules/migration/no-deprecated-properties.ts
@@ -25,7 +25,7 @@ export const noDeprecatedProperties = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           PropertyDefinition(node): void {
-            if (ancestorsContainsSfCommand(context.getAncestors())) {
+            if (ancestorsContainsSfCommand(context)) {
               if (
                 node.key.type === AST_NODE_TYPES.Identifier &&
                 ['supportsDevhubUsername', 'varargs'].includes(node.key.name)

diff --git a/src/rules/migration/no-filepath-flags.ts b/src/rules/migration/no-filepath-flags.ts
@@ -27,7 +27,7 @@ export const noFilepathFlags = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           Property(node): void {
-            if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (isFlag(node) && ancestorsContainsSfCommand(context)) {
               const toReplace = getCalleePropertyByName(node, 'filepath');
               if (toReplace) {
                 context.report({

diff --git a/src/rules/migration/no-id-flags.ts b/src/rules/migration/no-id-flags.ts
@@ -27,7 +27,7 @@ export const noIdFlags = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           Property(node): void {
-            if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (isFlag(node) && ancestorsContainsSfCommand(context)) {
               const toReplace = getCalleePropertyByName(node, 'id');
               if (toReplace) {
                 context.report({

diff --git a/src/rules/migration/no-number-flags.ts b/src/rules/migration/no-number-flags.ts
@@ -27,7 +27,7 @@ export const noNumberFlags = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           Property(node): void {
-            if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (isFlag(node) && ancestorsContainsSfCommand(context)) {
               const toReplace = getCalleePropertyByName(node, 'number');
               if (toReplace) {
                 context.report({

diff --git a/src/rules/migration/no-this-flags.ts b/src/rules/migration/no-this-flags.ts
@@ -37,9 +37,9 @@ export const noThisFlags = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           MemberExpression(node): void {
-            if (MemberExpressionIsThisDotFoo(node, 'flags') && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (MemberExpressionIsThisDotFoo(node, 'flags') && ancestorsContainsSfCommand(context)) {
               // it's ok if there's a this.flags on the class...
-              const classAbove = getSfCommand(context.getAncestors());
+              const classAbove = getSfCommand(context);
               if (!classAbove) {
                 return;
               }

diff --git a/src/rules/migration/no-this-org.ts b/src/rules/migration/no-this-org.ts
@@ -32,9 +32,9 @@ export const noThisOrg = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           MemberExpression(node): void {
-            if (MemberExpressionIsThisDotFoo(node, 'org') && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (MemberExpressionIsThisDotFoo(node, 'org') && ancestorsContainsSfCommand(context)) {
               // it's ok if there's a this.org on the class...
-              const classAbove = getSfCommand(context.getAncestors());
+              const classAbove = getSfCommand(context);
               if (!classAbove) {
                 return;
               }

diff --git a/src/rules/migration/no-this-ux.ts b/src/rules/migration/no-this-ux.ts
@@ -35,7 +35,7 @@ export const noThisUx = RuleCreator.withoutDocs({
           MemberExpression(node): void {
             if (
               MemberExpressionContainsMemberExpressionThisDotFoo(node, 'ux') &&
-              ancestorsContainsSfCommand(context.getAncestors())
+              ancestorsContainsSfCommand(context)
             ) {
               // spinner cases
               if (node.property.type === AST_NODE_TYPES.Identifier && spinnerMigration.has(node.property.name)) {

diff --git a/src/rules/migration/no-time-flags.ts b/src/rules/migration/no-time-flags.ts
@@ -29,7 +29,7 @@ export const noTimeFlags = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           Property(node): void {
-            if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (isFlag(node) && ancestorsContainsSfCommand(context)) {
               if (
                 (node.key.type === AST_NODE_TYPES.Identifier || node.key.type === AST_NODE_TYPES.Literal) &&
                 node.value.type === AST_NODE_TYPES.CallExpression &&

diff --git a/src/rules/migration/no-username-properties.ts b/src/rules/migration/no-username-properties.ts
@@ -61,7 +61,7 @@ export const noUsernameProperties = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           PropertyDefinition(node): void {
-            if (ancestorsContainsSfCommand(context.getAncestors())) {
+            if (ancestorsContainsSfCommand(context)) {
               if (node.key.type === AST_NODE_TYPES.Identifier && propertyMap.has(node.key.name)) {
                 const mappedMetadata = propertyMap.get(node.key.name);
                 if (!mappedMetadata) {
@@ -85,7 +85,7 @@ export const noUsernameProperties = RuleCreator.withoutDocs({
 
                 // add the flag if not already present
 
-                const outerClass = getSfCommand(ancestors);
+                const outerClass = getSfCommand(context);
                 if (!outerClass) {
                   return;
                 }

diff --git a/src/rules/migration/sfdx-flags-property.ts b/src/rules/migration/sfdx-flags-property.ts
@@ -28,7 +28,7 @@ export const sfdxFlagsProperty = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           PropertyDefinition(node): void {
-            if (ancestorsContainsSfCommand(context.getAncestors())) {
+            if (ancestorsContainsSfCommand(context)) {
               if (node.key.type === AST_NODE_TYPES.Identifier && node.key.name === 'flagsConfig') {
                 context.report({
                   node,

diff --git a/src/rules/migration/should-parse-flags.ts b/src/rules/migration/should-parse-flags.ts
@@ -30,7 +30,7 @@ export const shouldParseFlags = RuleCreator.withoutDocs({
             if (isRunMethod(node) && node.value?.body?.body) {
               // OK, looks like a run method has a type annotation
               const ancestors = context.getAncestors();
-              const classDeclaration = getSfCommand(ancestors);
+              const classDeclaration = getSfCommand(context);
               if (
                 // and it has flags to be parsed
                 classDeclaration?.body?.body?.some((prop) => isFlagsStaticProperty(prop))

diff --git a/src/rules/migration/use-sf-command-flags.ts b/src/rules/migration/use-sf-command-flags.ts
@@ -32,7 +32,7 @@ export const useSfCommandFlags = RuleCreator.withoutDocs({
               node.value?.callee?.type === AST_NODE_TYPES.MemberExpression &&
               node.value?.callee?.object?.type === AST_NODE_TYPES.Identifier &&
               node.value?.callee?.object?.name === 'flags' &&
-              ancestorsContainsSfCommand(context.getAncestors())
+              ancestorsContainsSfCommand(context)
             ) {
               const range = node.value.callee.object.range;
               context.report({

diff --git a/src/rules/no-args-parse-without-strict-false.ts b/src/rules/no-args-parse-without-strict-false.ts
@@ -43,8 +43,7 @@ export const noArgsParseWithoutStrictFalse = RuleCreator.withoutDocs({
               )
             ) {
               // Verify that the class has strict = false
-              const ancestors = context.getAncestors();
-              const sfCommand = getSfCommand(ancestors);
+              const sfCommand = getSfCommand(context);
               if (!sfCommand) {
                 return;
               }

diff --git a/src/rules/no-default-depends-on-flags.ts b/src/rules/no-default-depends-on-flags.ts
@@ -29,7 +29,7 @@ export const noDefaultDependsOnFlags = RuleCreator.withoutDocs({
             // is a flag
             if (
               isFlag(node) &&
-              ancestorsContainsSfCommand(context.getAncestors()) &&
+              ancestorsContainsSfCommand(context) &&
               node.value?.type === AST_NODE_TYPES.CallExpression &&
               node.value.arguments?.[0]?.type === AST_NODE_TYPES.ObjectExpression
             ) {

diff --git a/src/rules/no-duplicate-short-characters.ts b/src/rules/no-duplicate-short-characters.ts
@@ -30,7 +30,7 @@ export const noDuplicateShortCharacters = RuleCreator.withoutDocs({
           PropertyDefinition(node): void {
             // is "public static flags" property
             if (
-              ancestorsContainsSfCommand(context.getAncestors()) &&
+              ancestorsContainsSfCommand(context) &&
               node.value?.type === AST_NODE_TYPES.ObjectExpression &&
               isFlagsStaticProperty(node)
             ) {

diff --git a/src/rules/no-hyphens-aliases.ts b/src/rules/no-hyphens-aliases.ts
@@ -37,7 +37,7 @@ export const noHyphenAliases = RuleCreator.withoutDocs({
               node.parent.parent.key.name === 'aliases' &&
               node.parent.parent.parent?.parent?.parent &&
               isFlag(node.parent.parent.parent?.parent?.parent) &&
-              ancestorsContainsSfCommand(context.getAncestors())
+              ancestorsContainsSfCommand(context)
             ) {
               context.report({
                 node,

diff --git a/src/rules/no-json-flag.ts b/src/rules/no-json-flag.ts
@@ -26,7 +26,7 @@ export const jsonFlag = RuleCreator.withoutDocs({
     return isInCommandDirectory(context)
       ? {
           Property(node): void {
-            if (isFlag(node) && ancestorsContainsSfCommand(context.getAncestors())) {
+            if (isFlag(node) && ancestorsContainsSfCommand(context)) {
               if (node.key.type === AST_NODE_TYPES.Identifier && node.key.name === 'json') {
                 context.report({
                   node,

diff --git a/src/rules/no-split-examples.ts b/src/rules/no-split-examples.ts
@@ -40,7 +40,7 @@ export const noSplitExamples = RuleCreator.withoutDocs({
               node.value.callee.object.callee.property.name === 'getMessage' &&
               node.value.callee.property.type === AST_NODE_TYPES.Identifier &&
               node.value.callee.property.name === 'split' &&
-              extendsSfCommand(node.parent.parent)
+              extendsSfCommand(node.parent.parent, context)
             ) {
               const target = node.value;
               const fixedText = context

diff --git a/src/rules/no-unnecessary-aliases.ts b/src/rules/no-unnecessary-aliases.ts
@@ -34,7 +34,7 @@ export const noUnnecessaryAliases = RuleCreator.withoutDocs({
               node.parent.parent.key.type === AST_NODE_TYPES.Identifier &&
               node.parent.parent.key.name === 'aliases' &&
               context.getPhysicalFilename &&
-              ancestorsContainsSfCommand(context.getAncestors())
+              ancestorsContainsSfCommand(context)
             ) {
               const parentLength = node.parent.elements.length;
               const cmdParts = getCommandNameParts(context.getPhysicalFilename());

diff --git a/src/rules/no-unnecessary-properties.ts b/src/rules/no-unnecessary-properties.ts
@@ -36,7 +36,7 @@ export const noUnnecessaryProperties = RuleCreator.withoutDocs({
               node.parent?.type === AST_NODE_TYPES.ClassBody &&
               node.parent.parent?.type === AST_NODE_TYPES.ClassDeclaration &&
               node.value &&
-              extendsSfCommand(node.parent.parent)
+              extendsSfCommand(node.parent.parent, context)
             ) {
               // properties that default to false
               if (

diff --git a/src/rules/only-extend-sfCommand.ts b/src/rules/only-extend-sfCommand.ts
@@ -24,11 +24,33 @@ export const onlyExtendSfCommand = RuleCreator.withoutDocs({
   },
   defaultOptions: [],
   create(context) {
+    // function extendsSfCommand(node: TSESTree.ClassDeclaration, context: RuleContext<any, any>): boolean {
+    //   // Track imported classes and their aliases
+    //   const importedClasses = new Map();
+    //
+    //   for (const node of (context.sourceCode).ast.body) {
+    //     if (node.type === 'ImportDeclaration') {
+    //       node.specifiers.forEach(specifier => {
+    //         if (specifier.type === 'ImportSpecifier' && specifier.imported.name === 'SfCommand') {
+    //           importedClasses.set(specifier.local.name, 'SfCommand');
+    //         }
+    //         // Handle import aliases
+    //         else if (specifier.type === 'ImportSpecifier' && specifier.local.name !== specifier.imported.name) {
+    //           importedClasses.set(specifier.local.name, specifier.imported.name);
+    //         }
+    //       })
+    //     }
+    //   }
+    //
+    //   return node.superClass?.type === AST_NODE_TYPES.Identifier && (importedClasses.get(node.superClass.name) == 'SfCommand');
+    // }
+
     return isInCommandDirectory(context)
       ? {
         ClassDeclaration(node): void {
           // verify it extends SfCommand
-          if (!extendsSfCommand(node) && node.id) {
+          // importedClasses.has()
+          if (!extendsSfCommand(node, context) && node.id) {
               context.report({
                 node: node.id,
                 messageId: 'message',

diff --git a/src/rules/read-only-properties.ts b/src/rules/read-only-properties.ts
@@ -35,7 +35,7 @@ export const readOnlyProperties = RuleCreator.withoutDocs({
               props.includes(node.key.name) &&
               node.parent?.type === AST_NODE_TYPES.ClassBody &&
               node.parent.parent?.type === AST_NODE_TYPES.ClassDeclaration &&
-              extendsSfCommand(node.parent.parent)
+              extendsSfCommand(node.parent.parent,context)
             ) {
               if (!node.readonly) {
                 context.report({

diff --git a/src/rules/run-matches-class-type.ts b/src/rules/run-matches-class-type.ts
@@ -31,7 +31,7 @@ export const runMatchesClassType = RuleCreator.withoutDocs({
             if (isRunMethod(node) && node.value.returnType?.typeAnnotation.type === AST_NODE_TYPES.TSTypeReference) {
               // OK, run method has a type annotation.  Now we need to check if the class extends SfCommand and get the <type parameter>
               const ancestors = context.getAncestors();
-              const classDeclaration = getSfCommand(ancestors);
+              const classDeclaration = getSfCommand(context);
 
               if (classDeclaration) {
                 // get the text for the two nodes