[Feature Request] Custom Rule: Require new line after import statements.

[lucasklaassen]

Bug Report

• TSLint version:5.9.1
• TypeScript version:2.7.2
• Running TSLint via: (pick one) VSCode

TypeScript code being linted

import { NgModule } from '@angular/core';
import { NgbModule } from '../../../../node_modules/@ng-bootstrap/ng-bootstrap';
import { SharedModule } from '../../shared/shared.module';
import { ClubMembersRoutingModule } from './club-members-routing.module';
import { ClubMembersComponent } from './club-members.component';
@NgModule({
  imports: [
    SharedModule,
    ClubMembersRoutingModule,
    NgbModule
  ],
  declarations: [
    ClubMembersComponent
  ]
})
export class ClubMembersModule {}

with tslint.json configuration:

"new-line-after-imports": true

Actual behavior

Right now there's no rule to require a new line to be included after the import statements in a typescript file. Below in the expected behavior, I've listed how the code sample above should be linted.

Expected behavior

import { NgModule } from '@angular/core';
import { NgbModule } from '../../../../node_modules/@ng-bootstrap/ng-bootstrap';
import { SharedModule } from '../../shared/shared.module';
import { ClubMembersRoutingModule } from './club-members-routing.module';
import { ClubMembersComponent } from './club-members.component';
// New Line Required Here
@NgModule({
  imports: [
    SharedModule,
    ClubMembersRoutingModule,
    NgbModule
  ],
  declarations: [
    ClubMembersComponent
  ]
})
export class ClubMembersModule {}

[rafaelss95]

What if imports doesn't come at the top of file (btw this could be another good rule)? How can we handle this case?

[stocksr]

I would also like a rule (option on this rule) to prevent extra newlines inside the import block.

[omniscient]

@stocksr : This should be a separate request since there is already "import-spacing": true rule in place.

[amazzoccone]

Maybe we should think in rules for Typescript Decorators, because the package doesn't have any about it. Something like "newline-before-decorator"?

For example, in Stencil, you could have the following code:

  @State() device: IDevice;
  constructor() {
    ..
  }

and there is no rule to force a line between decorator and method.

[adidahiya]

Sorry, I don't think we will add new formatting rules at this point. See #4534. You can maintain this rule in a custom rule set package if you'd like.