Skip to content

Latest commit

 

History

History
593 lines (429 loc) · 5.77 KB

no-outputs-metadata-property.md

File metadata and controls

593 lines (429 loc) · 5.77 KB

@angular-eslint/no-outputs-metadata-property

Disallows usage of the outputs metadata property. See more at https://angular.io/styleguide#style-05-12

  • Type: suggestion

Rule Options

The rule does not have any configuration options.


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/no-outputs-metadata-property": [
      "error"
    ]
  }
}

❌ Invalid Code

@Component({
  outputs: [
  ~~~~~~~~~~
    'id: foo'
  ],
  ~
  selector: 'app-test'
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

❌ Invalid Code

@Directive({
  outputs: [
  ~~~~~~~~~~
    'id: foo'
  ],
  ~
  selector: 'app-test'
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

❌ Invalid Code

@Component({
  outputs,
  ~~~~~~~
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

❌ Invalid Code

@Directive({
  outputs: [],
  ~~~~~~~~~~~
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

❌ Invalid Code

const test = [];
@Component({
  'outputs': test,
  ~~~~~~~~~~~~~~~
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

❌ Invalid Code

@Directive({
  ['outputs']: undefined,
  ~~~~~~~~~~~~~~~~~~~~~~
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

❌ Invalid Code

function outputs() {
  return [];
}

@Component({
  [`outputs`]: outputs(),
  ~~~~~~~~~~~~~~~~~~~~~~
})
class Test {}



✅ - Toggle examples of correct code for this rule

Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

@Component()
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

@Directive({})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

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



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

@Directive({
  selector: 'app-test',
  template: 'Hello'
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

@Component({
  selector: 'app-test',
  queries: {},
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

const outputs = 'providers';
@Directive({
  [outputs]: [],
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

@NgModule({
  bootstrap: [Foo]
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

@Component({
  selector: 'foo',
  hostDirectives: [{
    directive: CdkMenuItem,
    outputs: ['cdkMenuItemTriggered: triggered'],
  }]
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

@Component({
  selector: 'foo',
  'hostDirectives': [{
    directive: CdkMenuItem,
    outputs: ['cdkMenuItemTriggered: triggered'],
  }]
})
class Test {}



Default Config

{
  "rules": {
    "@angular-eslint/no-outputs-metadata-property": [
      "error"
    ]
  }
}

✅ Valid Code

@Component({
  selector: 'foo',
  ['hostDirectives']: [{
    directive: CdkMenuItem,
    outputs: ['cdkMenuItemTriggered: triggered'],
  }]
})
class Test {}