Skip to content

Latest commit

 

History

History
607 lines (456 loc) · 6.24 KB

sort-ngmodule-metadata-arrays.md

File metadata and controls

607 lines (456 loc) · 6.24 KB
Raw

@angular-eslint/sort-ngmodule-metadata-arrays

⚠️ THIS RULE IS DEPRECATED

Ensures ASC alphabetical order for NgModule metadata arrays for easy visual scanning

  • Type: suggestion
  • 🔧 Supports autofix (--fix)

Rule Options

The rule accepts an options object with the following properties:

interface Options {
  /**
   * A string with a BCP 47 language tag.
   *
   * Default: `"en-US"`
   */
  locale?: string;
}

Usage Examples

The following examples are generated automatically from the actual unit tests within the plugin, so you can be assured that their behavior is accurate based on the current commit.


❌ - Toggle examples of incorrect code for this rule

Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

❌ Invalid Code

@NgModule({
  imports: [aModule, bModule, DModule, cModule]
                                       ~~~~~~~
})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

❌ Invalid Code

@NgModule({
  'declarations': [
    AComponent,
    cPipe,
    bDirective,
    ~~~~~~~~~~
    DComponent,
  ],
})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

❌ Invalid Code

@NgModule({
  ['exports']: [
    AComponent,
    cPipe,
    bDirective,
    ~~~~~~~~~~
    DComponent,
  ],
})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

❌ Invalid Code

@NgModule({
  [`bootstrap`]: [
    AppModule2,
    AppModule3,
    AppModule1,
    ~~~~~~~~~~
  ]
})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

❌ Invalid Code

@NgModule({
  schemas: [
    A_SCHEMA,
    C_SCHEMA,
    B_SCHEMA,
    ~~~~~~~~
  ]
})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

❌ Invalid Code

@NgModule({
  providers: [
    AProvider,
    {
      provide: 'myprovider',
      useClass: MyProvider,
    },
    cProvider,
    bProvider,
    ~~~~~~~~~
    DProvider,
  ]
})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

❌ Invalid Code

@NgModule({
  bootstrap,
  declarations: declarations,
  providers: providers(),
  schemas: [],
  [imports]: [
    aModule,
    bModule,
    DModule,
    cModule,
    ~~~~~~~
  ],
})
class Test {}


Custom Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error",
      {
        "locale": "cs-CZ"
      }
    ]
  }
}

❌ Invalid Code

@NgModule({
  imports: [chModule, dModule]
                      ~~~~~~~
})
class Test {}


✅ - Toggle examples of correct code for this rule

Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

✅ Valid Code

class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

✅ Valid Code

@NgModule()
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

✅ Valid Code

@NgModule({})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

✅ Valid Code

const options = {};
@NgModule(options)
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

✅ Valid Code

@NgModule({
  bootstrap: [
    AppModule1,
    AppModule2,
    AppModule3,
  ],
  'declarations': [
    AComponent,
    bDirective,
    cPipe,
    DComponent,
    VariableComponent,
  ],
  ['imports']: [
    _foo,
    AModule,
    bModule,
    cModule,
    DModule,
  ],
  [`providers`]: [
    AProvider,
    {
      provide: 'myprovider',
      useClass: MyProvider,
    },
    bProvider,
    cProvider,
    DProvider,
  ],
})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

✅ Valid Code

@Component({
  providers: [
    DeclarationD,
    DeclarationA,
  ]
})
class Test {}


Default Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error"
    ]
  }
}

✅ Valid Code

@NgModule({
  providers: [
    {
      provide: 'myprovider',
      useFactory: myProviderFactory,
      deps: [TOKEN_Z, ClassX, ClassA, TOKEN_A],
    },
  ],
})
class Test {}


Custom Config

{
  "rules": {
    "@angular-eslint/sort-ngmodule-metadata-arrays": [
      "error",
      {
        "locale": "cs-CZ"
      }
    ]
  }
}

✅ Valid Code

@Component({
  providers: [
    DatepickerProvider,
    ChipsProvider,
  ]
})
class Test {}