Changed name of eslint-plugin-amplify-backend-rules so it is now scoped (#2714)

ShadowCat567 · Vieltojarvi · web-flow · commit 0bba9c58a2c0 · 2025-04-14T15:30:50.000-07:00
* update lint rule package to be in amplify scope

* changeset

* changed changeset

---------

Co-authored-by: Vieltojarvi &lt;lvielto@amazon.com&gt;
diff --git a/.changeset/empty-rooms-taste.md b/.changeset/empty-rooms-taste.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -7,7 +7,7 @@ module.exports = {
   extends: [
     'eslint:recommended',
     'plugin:@typescript-eslint/recommended',
-    'plugin:amplify-backend-rules/recommended',
+    'plugin:@aws-amplify/amplify-backend-rules/recommended',
     'plugin:jsdoc/recommended-typescript-error',
     'plugin:promise/recommended',
     'prettier',
@@ -30,7 +30,7 @@ module.exports = {
   },
   plugins: [
     '@typescript-eslint',
-    'amplify-backend-rules',
+    '@aws-amplify/amplify-backend-rules',
     'unicorn',
     'jsdoc',
     'import',
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -57,6 +57,7 @@
   "devDependencies": {
     "@actions/core": "^1.10.1",
     "@actions/github": "^6.0.0",
+    "@aws-amplify/eslint-plugin-amplify-backend-rules": "^0.0.2",
     "@aws-sdk/client-amplify": "^3.750.0",
     "@aws-sdk/client-cloudformation": "^3.750.0",
     "@aws-sdk/client-cloudwatch-logs": "^3.750.0",
@@ -80,7 +81,6 @@
     "eslint": "^8.38.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-config-xo-typescript": "^0.57.0",
-    "eslint-plugin-amplify-backend-rules": "^0.0.2",
     "eslint-plugin-check-file": "^2.6.2",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsdoc": "^50.6.9",
diff --git a/packages/backend-ai/src/conversation/factory.ts b/packages/backend-ai/src/conversation/factory.ts
@@ -199,5 +199,5 @@ export type DefineConversationHandlerFunctionProps = {
 export const defineConversationHandlerFunction = (
   props: DefineConversationHandlerFunctionProps,
 ): ConversationHandlerFunctionFactory =>
-  // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+  // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
   new DefaultConversationHandlerFunctionFactory(props, new Error().stack);
diff --git a/packages/backend-auth/src/factory.ts b/packages/backend-auth/src/factory.ts
@@ -101,7 +101,7 @@ export class AmplifyAuthFactory implements ConstructFactory<BackendAuth> {
    */
   constructor(
     private readonly props: AmplifyAuthProps,
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     private readonly importStack = new Error().stack,
   ) {
     if (AmplifyAuthFactory.factoryCount > 0) {
@@ -263,5 +263,5 @@ const roleNameIsAuthRoleName = (roleName: string): roleName is AuthRoleName => {
 export const defineAuth = (
   props: AmplifyAuthProps,
 ): ConstructFactory<BackendAuth> =>
-  // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+  // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
   new AmplifyAuthFactory(props, new Error().stack);
diff --git a/packages/backend-auth/src/lambda/.eslintrc.json b/packages/backend-auth/src/lambda/.eslintrc.json
@@ -1,6 +1,6 @@
 {
   "rules": {
     "no-console": "off",
-    "amplify-backend-rules/prefer-amplify-errors": "off"
+    "@aws-amplify/amplify-backend-rules/prefer-amplify-errors": "off"
   }
 }
diff --git a/packages/backend-auth/src/reference_factory.ts b/packages/backend-auth/src/reference_factory.ts
@@ -92,7 +92,7 @@ export class AmplifyReferenceAuthFactory
    */
   constructor(
     private readonly props: AmplifyReferenceAuthProps,
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     private readonly importStack = new Error().stack,
   ) {
     if (AmplifyAuthFactory.factoryCount > 0) {
@@ -234,7 +234,7 @@ export const referenceAuth = (
 ): ConstructFactory<BackendReferenceAuth> => {
   return new AmplifyReferenceAuthFactory(
     props,
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     new Error().stack,
   );
 };
diff --git a/packages/backend-function/src/lambda-shims/invoke_ssm_shim.ts b/packages/backend-function/src/lambda-shims/invoke_ssm_shim.ts
@@ -17,7 +17,7 @@ setInterval(
       try {
         // Attempt to log error
         console.debug(error);
-        // eslint-disable-next-line amplify-backend-rules/no-empty-catch
+        // eslint-disable-next-line @aws-amplify/amplify-backend-rules/no-empty-catch
       } catch {
         // Do nothing if logging fails
       }
diff --git a/packages/create-amplify/src/project_root_validator.ts b/packages/create-amplify/src/project_root_validator.ts
@@ -22,7 +22,7 @@ export class ProjectRootValidator {
   validate = async (): Promise<void> => {
     const testPath = path.resolve(this.projectRoot, 'amplify');
     if (this.exists(testPath)) {
-      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
       throw new Error(
         `An amplify directory already exists at ${testPath}. If you are trying to run an Amplify Gen 2 command inside an Amplify Gen 1 project we recommend creating the project in another directory. Learn more about AWS Amplify Gen 2: ${amplifyLearnMoreUrl}`,
       );
diff --git a/packages/eslint-rules/package.json b/packages/eslint-rules/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "eslint-plugin-amplify-backend-rules",
+  "name": "@aws-amplify/eslint-plugin-amplify-backend-rules",
   "private": true,
   "version": "0.0.2",
   "type": "commonjs",
diff --git a/packages/eslint-rules/src/index.ts b/packages/eslint-rules/src/index.ts
@@ -19,16 +19,16 @@ export const rules: Record<string, unknown> = {
 
 export const configs = {
   recommended: {
-    plugins: ['amplify-backend-rules'],
+    plugins: ['@aws-amplify/amplify-backend-rules'],
     rules: {
-      'amplify-backend-rules/amplify-error-name': 'error',
-      'amplify-backend-rules/amplify-error-no-instanceof': 'error',
-      'amplify-backend-rules/backend-output-client-error-no-instanceof':
+      '@aws-amplify/amplify-backend-rules/amplify-error-name': 'error',
+      '@aws-amplify/amplify-backend-rules/amplify-error-no-instanceof': 'error',
+      '@aws-amplify/amplify-backend-rules/backend-output-client-error-no-instanceof':
         'error',
-      'amplify-backend-rules/no-empty-catch': 'error',
-      'amplify-backend-rules/prefer-amplify-errors': 'off',
-      'amplify-backend-rules/no-amplify-errors': 'off',
-      'amplify-backend-rules/propagate-error-cause': 'error',
+      '@aws-amplify/amplify-backend-rules/no-empty-catch': 'error',
+      '@aws-amplify/amplify-backend-rules/prefer-amplify-errors': 'off',
+      '@aws-amplify/amplify-backend-rules/no-amplify-errors': 'off',
+      '@aws-amplify/amplify-backend-rules/propagate-error-cause': 'error',
     },
     overrides: [
       {
@@ -44,7 +44,7 @@ export const configs = {
         ],
         excludedFiles: ['**/*.test.ts'],
         rules: {
-          'amplify-backend-rules/prefer-amplify-errors': 'error',
+          '@aws-amplify/amplify-backend-rules/prefer-amplify-errors': 'error',
         },
       },
       {
@@ -55,7 +55,7 @@ export const configs = {
           'packages/deployed-backend-client/src/**',
         ],
         rules: {
-          'amplify-backend-rules/no-amplify-errors': 'error',
+          '@aws-amplify/amplify-backend-rules/no-amplify-errors': 'error',
         },
       },
     ],
diff --git a/packages/form-generator/src/local_codegen_graphql_form_generator.ts b/packages/form-generator/src/local_codegen_graphql_form_generator.ts
@@ -227,13 +227,13 @@ export class LocalGraphqlFormGenerator implements GraphqlFormGenerator {
             ([key]) => key.toLowerCase() === model.toLowerCase(),
           );
           if (!entry) {
-            // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+            // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
             throw new Error(`Could not find specified model ${model}`);
           }
           prev.push(entry);
           return prev;
         }
-        // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+        // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
         throw new Error(`Could not find specified model ${model}`);
       },
       [],
diff --git a/packages/form-generator/src/s3_string_object_fetcher.ts b/packages/form-generator/src/s3_string_object_fetcher.ts
@@ -19,7 +19,7 @@ export class S3StringObjectFetcher {
     );
     const schema = await getSchemaCommandResult.Body?.transformToString();
     if (!schema) {
-      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
       throw new Error('Error on parsing output schema');
     }
     return schema;
diff --git a/packages/model-generator/src/create_graphql_document_generator.ts b/packages/model-generator/src/create_graphql_document_generator.ts
@@ -29,11 +29,11 @@ export const createGraphqlDocumentGenerator = ({
   awsClientProvider,
 }: GraphqlDocumentGeneratorFactoryParams): GraphqlDocumentGenerator => {
   if (!backendIdentifier) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error('`backendIdentifier` must be defined');
   }
   if (!awsClientProvider) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error('`awsClientProvider` must be defined');
   }
 
@@ -46,7 +46,7 @@ export const createGraphqlDocumentGenerator = ({
     );
     const apiId = output[graphqlOutputKey]?.payload.awsAppsyncApiId;
     if (!apiId) {
-      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
       throw new Error(`Unable to determine AppSync API ID.`);
     }
 
diff --git a/packages/model-generator/src/create_graphql_models_generator.ts b/packages/model-generator/src/create_graphql_models_generator.ts
@@ -61,11 +61,11 @@ const createGraphqlModelsGeneratorFromBackendIdentifier = ({
   awsClientProvider,
 }: GraphqlModelsFromBackendIdentifierParams): GraphqlModelsGenerator => {
   if (!backendIdentifier) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error('`backendIdentifier` must be defined');
   }
   if (!awsClientProvider) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error('`awsClientProvider` must be defined');
   }
 
@@ -92,11 +92,11 @@ export const createGraphqlModelsFromS3UriGenerator = ({
   awsClientProvider,
 }: GraphqlModelsFromS3UriGeneratorFactoryParams): GraphqlModelsGenerator => {
   if (!modelSchemaS3Uri) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error('`modelSchemaS3Uri` must be defined');
   }
   if (!awsClientProvider) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error('`awsClientProvider` must be defined');
   }
   return new StackMetadataGraphqlModelsGenerator(
@@ -122,7 +122,7 @@ const getModelSchema = async (
   const modelSchemaS3Uri =
     output[graphqlOutputKey]?.payload.amplifyApiModelSchemaS3Uri;
   if (!modelSchemaS3Uri) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error(`Cannot find model schema at amplifyApiModelSchemaS3Uri`);
   }
 
diff --git a/packages/model-generator/src/create_graphql_types_generator.ts b/packages/model-generator/src/create_graphql_types_generator.ts
@@ -29,11 +29,11 @@ export const createGraphqlTypesGenerator = ({
   awsClientProvider,
 }: GraphqlTypesGeneratorFactoryParams): GraphqlTypesGenerator => {
   if (!backendIdentifier) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error('`backendIdentifier` must be defined');
   }
   if (!awsClientProvider) {
-    // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+    // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
     throw new Error('`awsClientProvider` must be defined');
   }
 
@@ -46,7 +46,7 @@ export const createGraphqlTypesGenerator = ({
     );
     const apiId = output[graphqlOutputKey]?.payload.awsAppsyncApiId;
     if (!apiId) {
-      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
       throw new Error(`Unable to determine AppSync API ID.`);
     }
 
diff --git a/packages/model-generator/src/generate_api_code.ts b/packages/model-generator/src/generate_api_code.ts
@@ -145,7 +145,7 @@ export class ApiCodeGenerator {
         return this.generateIntrospectionApiCode();
       }
       default:
-        // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+        // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
         throw new Error(
           `${
             (props as GenerateApiCodeProps).format as string
diff --git a/packages/model-generator/src/graphql_document_generator.ts b/packages/model-generator/src/graphql_document_generator.ts
@@ -29,7 +29,7 @@ export class AppSyncGraphqlDocumentGenerator
     const schema = await this.fetchSchema();
 
     if (!schema) {
-      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
       throw new Error('Invalid schema');
     }
 
diff --git a/packages/model-generator/src/graphql_models_generator.ts b/packages/model-generator/src/graphql_models_generator.ts
@@ -35,7 +35,7 @@ export class StackMetadataGraphqlModelsGenerator
     const schema = await this.fetchSchema();
 
     if (!schema) {
-      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
       throw new Error('Invalid schema');
     }
 
diff --git a/packages/model-generator/src/graphql_types_generator.ts b/packages/model-generator/src/graphql_types_generator.ts
@@ -32,7 +32,7 @@ export class AppSyncGraphqlTypesGenerator implements GraphqlTypesGenerator {
     const schema = await this.fetchSchema();
 
     if (!schema) {
-      // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
       throw new Error('Invalid schema');
     }
 
diff --git a/packages/model-generator/src/s3_string_object_fetcher.ts b/packages/model-generator/src/s3_string_object_fetcher.ts
@@ -21,7 +21,7 @@ export class S3StringObjectFetcher {
       );
       const schema = await getSchemaCommandResult.Body?.transformToString();
       if (!schema) {
-        // eslint-disable-next-line amplify-backend-rules/prefer-amplify-errors
+        // eslint-disable-next-line @aws-amplify/amplify-backend-rules/prefer-amplify-errors
         throw new Error('Error on parsing output schema');
       }
       return schema;
diff --git a/packages/platform-core/src/usage-data/usage_data_emitter.ts b/packages/platform-core/src/usage-data/usage_data_emitter.ts
@@ -45,7 +45,7 @@ export class DefaultUsageDataEmitter implements UsageDataEmitter {
         dimensions,
       });
       await this.send(data);
-      // eslint-disable-next-line amplify-backend-rules/no-empty-catch
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/no-empty-catch
     } catch {
       // Don't propagate errors related to not being able to send telemetry
     }
@@ -62,7 +62,7 @@ export class DefaultUsageDataEmitter implements UsageDataEmitter {
         dimensions,
       });
       await this.send(data);
-      // eslint-disable-next-line amplify-backend-rules/no-empty-catch
+      // eslint-disable-next-line @aws-amplify/amplify-backend-rules/no-empty-catch
     } catch {
       // Don't propagate errors related to not being able to send telemetry
     }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"rules": {`
`3`	`3`	`"no-console": "off",`
`4`		`- "amplify-backend-rules/prefer-amplify-errors": "off"`
	`4`	`+ "@aws-amplify/amplify-backend-rules/prefer-amplify-errors": "off"`
`5`	`5`	`}`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ setInterval(`
`17`	`17`	`try {`
`18`	`18`	`// Attempt to log error`
`19`	`19`	`console.debug(error);`
`20`		`- // eslint-disable-next-line amplify-backend-rules/no-empty-catch`
	`20`	`+ // eslint-disable-next-line @aws-amplify/amplify-backend-rules/no-empty-catch`
`21`	`21`	`} catch {`
`22`	`22`	`// Do nothing if logging fails`
`23`	`23`	`}`