angular-docs-cn/style-guide.md at 4767f107fbc5a6c8fa6f7723bae76e2a05df18c1

69 KiB

Raw Blame History

@title Style Guide

@intro Write Angular with style.

@description Welcome to the Angular Style Guide

Purpose

Looking for an opinionated guide to Angular syntax, conventions, and application structure? Step right in! This style guide presents our preferred conventions and, as importantly, explains why.

Style vocabulary

Each guideline describes either a good or bad practice, and all have a consistent presentation.

The wording of each guideline indicates how strong the recommendation is.


**Do** is one that should always be followed.
_Always_ might be a bit too strong of a word.
Guidelines that literally should always be followed are extremely rare.
On the other hand, you need a really unusual case for breaking a *Do* guideline.


**Consider** guidelines should generally be followed.
If you fully understand the meaning behind the guideline and have a good reason to deviate, then do so. Please strive to be consistent.


**Avoid** indicates something you should almost never do. Code examples to *avoid* have an unmistakeable red header.

File structure conventions

Some code examples display a file that has one or more similarly named companion files. For example, hero.component.ts and hero.component.html.

The guideline will use the shortcut hero.component.ts|html|css|spec to represent those various files. Using this shortcut makes this guide's file structures easier to read and more terse.

{@a toc}

Single responsibility
Naming
Coding conventions
App structure and Angular modules
Components
Directives
Services
Data services
Lifecycle hooks
Appendix

Single responsibility

Apply the Single Responsibility Principle (SPR) to all components, services, and other symbols. This helps make the app cleaner, easier to read and maintain, and more testable.

Rule of One

Style 01-01


**Do** define one thing, such as a service or component, per file.


**Consider** limiting files to 400 lines of code.

**Why?** One component per file makes it far easier to read, maintain, and avoid collisions with teams in source control.

**Why?** One component per file avoids hidden bugs that often arise when combining components in a file where they may share variables, create unwanted closures, or unwanted coupling with dependencies.

**Why?** A single component can be the default export for its file which facilitates lazy loading with the router.

The key is to make the code more reusable, easier to read, and less mistake prone.

The following negative example defines the AppComponent, bootstraps the app, defines the Hero model object, and loads heroes from the server ... all in the same file. Don't do this.

{@example 'style-guide/ts/src/01-01/app/heroes/hero.component.avoid.ts'}

It is a better practice to redistribute the component and its supporting classes into their own, dedicated files.

{@example 'style-guide/ts/src/01-01/main.ts'} {@example 'style-guide/ts/src/01-01/app/app.module.ts'} {@example 'style-guide/ts/src/01-01/app/app.component.ts'} {@example 'style-guide/ts/src/01-01/app/heroes/heroes.component.ts'} {@example 'style-guide/ts/src/01-01/app/heroes/shared/hero.service.ts'} {@example 'style-guide/ts/src/01-01/app/heroes/shared/hero.model.ts'} {@example 'style-guide/ts/src/01-01/app/heroes/shared/mock-heroes.ts'}

As the app grows, this rule becomes even more important. Back to top

Small functions

Style 01-02


**Do** define small functions


**Consider** limiting to no more than 75 lines.

**Why?** Small functions are easier to test, especially when they do one thing and serve one purpose.

**Why?** Small functions promote reuse.

**Why?** Small functions are easier to read.

**Why?** Small functions are easier to maintain.

**Why?** Small functions help avoid hidden bugs that come with large functions that share variables with external scope, create unwanted closures, or unwanted coupling with dependencies.

Naming

Naming conventions are hugely important to maintainability and readability. This guide recommends naming conventions for the file name and the symbol name.

General Naming Guidelines

Style 02-01


**Do** use consistent names for all symbols.


**Do** follow a pattern that describes the symbol's feature then its type. The recommended pattern is `feature.type.ts`.

**Why?** Naming conventions help provide a consistent way to find content at a glance. Consistency within the project is vital. Consistency with a team is important. Consistency across a company provides tremendous efficiency.

**Why?** The naming conventions should simply help find desited code faster and make it easier to understand.

**Why?** Names of folders and files should clearly convey their intent. For example, `app/heroes/hero-list.component.ts` may contain a component that manages a list of heroes.

Separate file names with dots and dashes

Style 02-02


**Do** use dashes to separate words in the descriptive name.


**Do** use dots to separate the descriptive name from the type.


**Do** use consistent type names for all components following a pattern that describes the component's feature then its type. A recommended pattern is `feature.type.ts`.


**Do** use conventional type names including `.service`, `.component`, `.pipe`, `.module`, and `.directive`. 
Invent additional type names if you must but take care not to create too many.

**Why?** Type names provide a consistent way to quickly identify what is in the file.

**Why?** Type names make it easy to find a specific file type using an editor or IDE's fuzzy search techniques.

**Why?** Unabbreviated type names such as `.service` are descriptive and unambiguous. Abbreviations such as `.srv`, `.svc`, and `.serv` can be confusing.

**Why?** Type names provide pattern matching for any automated tasks.

Symbols and file names

Style 02-03


**Do** use consistent names for all assets named after what they represent.


**Do** use upper camel case for class names.


**Do** match the name of the symbol to the name of the file.


**Do** append the symbol name with the conventional suffix (such as `Component`, 
`Directive`, `Module`, `Pipe`, or `Service`) for a thing of that type.


**Do** give the filename the conventional suffix (such as `.component.ts`, `.directive.ts`, 
`.module.ts`, `.pipe.ts`, or `.service.ts`) for a file of that type.

**Why?** Consistent conventions make it easy to quickly identify and reference assets of different types.

<th>
  Symbol Name
</th>


<th>
  File Name
</th>

<td>

  <code-example>
    @Component({ ... })        
            export class AppComponent { }
  </code-example>


</td>


<td>
  app.component.ts
</td>

<td>

  <code-example>
    @Component({ ... })        
            export class HeroesComponent { }
  </code-example>


</td>


<td>
  heroes.component.ts
</td>

<td>

  <code-example>
    @Component({ ... })        
            export class HeroListComponent { }
  </code-example>


</td>


<td>
  hero-list.component.ts
</td>

<td>

  <code-example>
    @Component({ ... })        
            export class HeroDetailComponent { }
  </code-example>


</td>


<td>
  hero-detail.component.ts
</td>

<td>

  <code-example>
    @Directive({ ... })        
            export class ValidationDirective { }
  </code-example>


</td>


<td>
  validation.directive.ts
</td>

<td>

  <code-example>
    @NgModule({ ... })        
            export class AppModule
  </code-example>


</td>


<td>
  app.module.ts
</td>

<td>

  <code-example>
    @Pipe({ name: 'initCaps' })        
            export class InitCapsPipe implements PipeTransform { }
  </code-example>


</td>


<td>
  init-caps.pipe.ts
</td>

<td>

  <code-example>
    @Injectable()        
            export class UserProfileService { }
  </code-example>


</td>


<td>
  user-profile.service.ts
</td>

Service names

Style 02-04


**Do** use consistent names for all services named after their feature.


**Do** suffix a service class name with Service. 
For example, something that gets data or heroes 
should be called a `DataService` or a `HeroService`.

A few terms are unambiguously services. They typically 
indicate agency by ending in "er". You may prefer to name 
a service that logs messages `Logger` rather than `LoggerService`. 
Decide if this exception is agreeable in your project. 
As always, strive for consistency.

**Why?** Provides a consistent way to quickly identify and reference services.

**Why?** Clear service names such as `Logger` do not require a suffix.

**Why?** Service names such as `Credit` are nouns and require a suffix and should be named with a suffix when it is not obvious if it is a service or something else.

<th>
  Symbol Name
</th>


<th>
  File Name
</th>

<td>

  <code-example>
    @Injectable()        
            export class HeroDataService { }
  </code-example>


</td>


<td>
  hero-data.service.ts
</td>

<td>

  <code-example>
    @Injectable()        
            export class CreditService { }
  </code-example>


</td>


<td>
  credit.service.ts
</td>

<td>

  <code-example>
    @Injectable()        
            export class Logger { }
  </code-example>


</td>


<td>
  logger.service.ts
</td>

Bootstrapping

Style 02-05


**Do** put bootstrapping and platform logic for the app in a file named `main.ts`.


**Do** include error handling in the bootstrapping logic.


**Avoid** putting app logic in the `main.ts`. Instead, consider placing it in a component or service.

**Why?** Follows a consistent convention for the startup logic of an app.

**Why?** Follows a familiar convention from other technology platforms.

{@example 'style-guide/ts/src/02-05/main.ts'}

Directive selectors

Style 02-06


**Do** Use lower camel case for naming the selectors of directives.

**Why?** Keeps the names of the properties defined in the directives that are bound to the view consistent with the attribute names.

**Why?** The Angular HTML parser is case sensitive and will recognize lower camel case.

Custom prefix for components

Style 02-07


**Do** use a hyphenated, lowercase element selector value (e.g. `admin-users`).


**Do** use a custom prefix for a component selector. 
For example, the prefix `toh` represents from **T**our **o**f **H**eroes and the prefix `admin` represents an admin feature area.


**Do** use a prefix that identifies the feature area or the app itself.

**Why?** Prevents element name collisions with components in other apps and with native HTML elements.

**Why?** Makes it easier to promote and share the component in other apps.

**Why?** Components are easy to identify in the DOM.

{@example 'style-guide/ts/src/02-07/app/heroes/hero.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/02-07/app/users/users.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/02-07/app/heroes/hero.component.ts' region='example'}

{@example 'style-guide/ts/src/02-07/app/users/users.component.ts' region='example'}

Custom prefix for directives

Style 02-08


**Do** use a custom prefix for the selector of directives (e.g, the prefix `toh` from **T**our **o**f **H**eroes).


**Do** spell non-element selectors in lower camel case unless the selector is meant to match a native HTML attribute.

**Why?** Prevents name collisions.

**Why?** Directives are easily identified.

{@example 'style-guide/ts/src/02-08/app/shared/validate.directive.avoid.ts' region='example'}

{@example 'style-guide/ts/src/02-08/app/shared/validate.directive.ts' region='example'}

Pipe names

Style 02-09


**Do** use consistent names for all pipes, named after their feature.

**Why?** Provides a consistent way to quickly identify and reference pipes.

<th>
  Symbol Name
</th>


<th>
  File Name
</th>

<td>

  <code-example>
    @Pipe({ name: 'ellipsis' })        
            export class EllipsisPipe implements PipeTransform { }
  </code-example>


</td>


<td>
  ellipsis.pipe.ts
</td>

<td>

  <code-example>
    @Pipe({ name: 'initCaps' })        
            export class InitCapsPipe implements PipeTransform { }
  </code-example>


</td>


<td>
  init-caps.pipe.ts
</td>

Unit test file names

Style 02-10


**Do** name test specification files the same as the component they test.


**Do** name test specification files with a suffix of `.spec`.

**Why?** Provides a consistent way to quickly identify tests.

**Why?** Provides pattern matching for [karma](http://karma-runner.github.io/) or other test runners.

<th>
  Symbol Name
</th>


<th>
  File Name
</th>

<td>
  Components
</td>


<td>
  heroes.component.spec.ts      hero-list.component.spec.ts      hero-detail.component.spec.ts
</td>

<td>
  Services
</td>


<td>
  logger.service.spec.ts      hero.service.spec.ts      filter-text.service.spec.ts
</td>

<td>
  Pipes
</td>


<td>
  ellipsis.pipe.spec.ts      init-caps.pipe.spec.ts
</td>

End-to-End (E2E) test file names

Style 02-11


**Do** name end-to-end test specification files after the feature they test with a suffix of `.e2e-spec`.

**Why?** Provides a consistent way to quickly identify end-to-end tests.

**Why?** Provides pattern matching for test runners and build automation.

<th>
  Symbol Name
</th>


<th>
  File Name
</th>

<td>
  End to End Tests
</td>


<td>
  app.e2e-spec.ts      heroes.e2e-spec.ts
</td>

Angular NgModule names

Style 02-12


**Do** append the symbol name with the suffix `Module`.


**Do** give the file name the `.module.ts` extension.


**Do** name the module after the feature and folder it resides in.

**Why?** Provides a consistent way to quickly identify and reference modules.

**Why?** Upper camel case is conventional for identifying objects that can be instantiated using a constructor.

**Why?** Easily identifies the module as the root of the same named feature.


**Do** suffix a _RoutingModule_ class name with `RoutingModule`.


**Do** end the filename of a _RoutingModule_ with `-routing.module.ts`.

**Why?** A `RoutingModule` is a module dedicated exclusively to configuring the Angular router. A consistent class and file name convention make these modules easy to spot and verify.

<th>
  Symbol Name
</th>


<th>
  File Name
</th>

<td>

  <code-example>
    @NgModule({ ... })        
            export class AppModule { }
  </code-example>


</td>


<td>
  app.module.ts
</td>

<td>

  <code-example>
    @NgModule({ ... })        
            export class HeroesModule { }
  </code-example>


</td>


<td>
  heroes.module.ts
</td>

<td>

  <code-example>
    @NgModule({ ... })        
            export class VillainsModule { }
  </code-example>


</td>


<td>
  villains.module.ts
</td>

<td>

  <code-example>
    @NgModule({ ... })        
            export class AppRoutingModule { }
  </code-example>


</td>


<td>
  app-routing.module.ts
</td>

<td>

  <code-example>
    @NgModule({ ... })        
            export class HeroesRoutingModule { }
  </code-example>


</td>


<td>
  heroes-routing.module.ts        
</td>

Coding conventions

Have consistent set of coding, naming, and whitespace conventions.

Classes

Style 03-01


**Do** use upper camel case when naming classes.

**Why?** Follows conventional thinking for class names.

**Why?** Classes can be instantiated and construct an instance. By convention, upper camel case indicates a constructable asset.

{@example 'style-guide/ts/src/03-01/app/core/exception.service.avoid.ts' region='example'}

{@example 'style-guide/ts/src/03-01/app/core/exception.service.ts' region='example'}

Constants

Style 03-02


**Do** declare variables with `const` if their values should not change during the application lifetime.

**Why?** Conveys to readers that the value is invariant.

**Why?** TypeScript helps enforce that intent by requiring immediate initialization and by preventing subsequent re-assignment.


**Consider** spelling `const` variables in lower camel case.

**Why?** Lower camel case variable names (`heroRoutes`) are easier to read and understand than the traditional UPPER_SNAKE_CASE names (`HERO_ROUTES`).

**Why?** The tradition of naming constants in UPPER_SNAKE_CASE reflects an era before the modern IDEs that quickly reveal the `const` declaration. TypeScript itself prevents accidental reassignment.


**Do** tolerate _existing_ `const` variables that are spelled in UPPER_SNAKE_CASE.

**Why?** The tradition of UPPER_SNAKE_CASE remains popular and pervasive, especially in third party modules. It is rarely worth the effort to change them at the risk of breaking existing code and documentation.

{@example 'style-guide/ts/src/03-02/app/core/data.service.ts'}

Interfaces

Style 03-03


**Do** name an interface using upper camel case.


**Consider** naming an interface without an `I` prefix.


**Consider** using a class instead of an interface.

**Why?** TypeScript guidelines discourage the `I` prefix.

**Why?** A class alone is less code than a _class-plus-interface_.

**Why?** A class can act as an interface (use `implements` instead of `extends`).

**Why?** An interface-class can be a provider lookup token in Angular dependency injection.

{@example 'style-guide/ts/src/03-03/app/core/hero-collector.service.avoid.ts' region='example'}

{@example 'style-guide/ts/src/03-03/app/core/hero-collector.service.ts' region='example'}

Properties and methods

Style 03-04


**Do** use lower camel case to name properties and methods.


**Avoid** prefixing private properties and methods with an underscore.

**Why?** Follows conventional thinking for properties and methods.

**Why?** JavaScript lacks a true private property or method.

**Why?** TypeScript tooling makes it easy to identify private vs public properties and methods.

{@example 'style-guide/ts/src/03-04/app/core/toast.service.avoid.ts' region='example'}

{@example 'style-guide/ts/src/03-04/app/core/toast.service.ts' region='example'}

Import line spacing

Style 03-06


**Consider** leaving one empty line between third party imports and application imports.


**Consider** listing import lines alphabetized by the module.


**Consider** listing destructured imported symbols alphabetically.

**Why?** The empty line separates _your_ stuff from _their_ stuff.

**Why?** Alphabetizing makes it easier to read and locate symbols.

{@example 'style-guide/ts/src/03-06/app/heroes/shared/hero.service.avoid.ts' region='example'}

{@example 'style-guide/ts/src/03-06/app/heroes/shared/hero.service.ts' region='example'}

Application structure and Angular modules

Have a near-term view of implementation and a long-term vision. Start small but keep in mind where the app is heading down the road.

All of the app's code goes in a folder named src. All feature areas are in their own folder, with their own Angular module.

All content is one asset per file. Each component, service, and pipe is in its own file. All third party vendor scripts are stored in another folder and not in the src folder. You didn't write them and you don't want them cluttering src. Use the naming conventions for files in this guide. Back to top

LIFT

Style 04-01


**Do** structure the app such that you can `L`ocate code quickly, 
`I`dentify the code at a glance, 
keep the `F`lattest structure you can, and 
`T`ry to be DRY.


**Do** define the structure to follow these four basic guidelines, listed in order of importance.

**Why?** LIFT Provides a consistent structure that scales well, is modular, and makes it easier to increase developer efficiency by finding code quickly. To confirm your intuition about a particular structure, ask: _can I quickly open and start work in all of the related files for this feature_?

Locate

Style 04-02


**Do** make locating code intuitive, simple and fast.

**Why?** To work efficiently you must be able to find files quickly, especially when you do not know (or do not remember) the file _names_. Keeping related files near each other in an intuitive location saves time. A descriptive folder structure makes a world of difference to you and the people who come after you.

Identify

Style 04-03


**Do** name the file such that you instantly know what it contains and represents.


**Do** be descriptive with file names and keep the contents of the file to exactly one component.


**Avoid** files with multiple components, multiple services, or a mixture.

**Why?** Spend less time hunting and pecking for code, and become more efficient. Longer file names are far better than _short-but-obscure_ abbreviated names.

It may be advantageous to deviate from the one-thing-per-file rule when you have a set of small, closely-related features that are better discovered and understood in a single file than as multiple files. Be wary of this loophole. Back to top

Flat

Style 04-04


**Do** keep a flat folder structure as long as possible.


**Consider** creating sub-folders when a folder reaches seven or more files.


**Consider** configuring the IDE to hide distracting, irrelevant files such as generated `.js` and `.js.map` files.

**Why?** No one wants to search for a file through seven levels of folders. A flat structure is easy to scan.

On the other hand,  
<a href="https://en.wikipedia.org/wiki/The_Magical_Number_Seven,_Plus_or_Minus_Two" target="_blank">psychologists believe</a>  
that humans start to struggle when the number of adjacent interesting things exceeds nine.  
So when a folder has ten or more files, it may be time to create subfolders.   
  
Base your decision on your comfort level.   
Use a flatter structure until there is an obvious value to creating a new folder.

T-DRY (Try to be DRY)

Style 04-05


**Do** be DRY (Don't Repeat Yourself)


**Avoid** being so DRY that you sacrifice readability.

**Why?** Being DRY is important, but not crucial if it sacrifices the other elements of LIFT. That's why it's called _T-DRY_. For example, it's redundant to name a component, `hero-view.component.html` because a component is obviously a view. But if something is not obvious or departs from a convention, then spell it out.

Overall structural guidelines

Style 04-06


**Do** start small but keep in mind where the app is heading down the road.


**Do** have a near term view of implementation and a long term vision.


**Do** put all of the app's code in a folder named `src`.


**Consider** creating a folder for a component when it has multiple accompanying files (`.ts`, `.html`, `.css` and `.spec`).

**Why?** Helps keep the app structure small and easy to maintain in the early stages, while being easy to evolve as the app grows.

**Why?** Components often have four files (e.g. `*.html`, `*.css`, `*.ts`, and `*.spec.ts`) and can clutter a folder quickly.

{@a file-tree} Here is a compliant folder and file structure:

<project root> src app core core.module.ts

      <aio-file>
        exception.service.ts|spec.ts
      </aio-file>


      <aio-file>
        user-profile.service.ts|spec.ts
      </aio-file>


    </aio-folder>


    <aio-folder>
      heroes
      <aio-folder>
        hero
        <aio-file>
          hero.component.ts|html|css|spec.ts
        </aio-file>


      </aio-folder>


      <aio-folder>
        hero-list
        <aio-file>
          hero-list.component.ts|html|css|spec.ts
        </aio-file>


      </aio-folder>


      <aio-folder>
        shared
        <aio-file>
          hero-button.component.ts|html|css|spec.ts
        </aio-file>


        <aio-file>
          hero.model.ts
        </aio-file>


        <aio-file>
          hero.service.ts|spec.ts
        </aio-file>


      </aio-folder>


      <aio-file>
        heroes.component.ts|html|css|spec.ts
      </aio-file>


      <aio-file>
        heroes.module.ts
      </aio-file>


      <aio-file>
        heroes-routing.module.ts
      </aio-file>


    </aio-folder>


    <aio-folder>
      shared
      <aio-file>
        shared.module.ts
      </aio-file>


      <aio-file>
        init-caps.pipe.ts|spec.ts
      </aio-file>


      <aio-file>
        text-filter.component.ts|spec.ts
      </aio-file>


      <aio-file>
        text-filter.service.ts|spec.ts
      </aio-file>


    </aio-folder>


    <aio-folder>
      villains
      <aio-folder>
        villain
        <aio-file>
          ...
        </aio-file>


      </aio-folder>


      <aio-folder>
        villain-list
        <aio-file>
          ...
        </aio-file>


      </aio-folder>


      <aio-folder>
        shared
        <aio-file>
          ...
        </aio-file>


      </aio-folder>


      <aio-file>
        villains.component.ts|html|css|spec.ts
      </aio-file>


      <aio-file>
        villains.module.ts
      </aio-file>


      <aio-file>
        villains-routing.module.ts
      </aio-file>


    </aio-folder>


    <aio-file>
      app.component.ts|html|css|spec.ts
    </aio-file>


    <aio-file>
      app.module.ts
    </aio-file>


    <aio-file>
      app-routing.module.ts
    </aio-file>


  </aio-folder>


  <aio-file>
    main.ts
  </aio-file>


  <aio-file>
    index.html
  </aio-file>


  <aio-file>
    ...
  </aio-file>


</aio-folder>


<aio-file>
  node_modules/...
</aio-file>


<aio-file>
  ...
</aio-file>

While components in dedicated folders are widely preferred, another option for small apps is to keep components flat (not in a dedicated folder). This adds up to four files to the existing folder, but also reduces the folder nesting. Whatever you choose, be consistent. Back to top

Folders-by-feature structure

Style 04-07


**Do** create folders named for the feature area they represent.

**Why?** A developer can locate the code, identify what each file represents at a glance, the structure is as flat as it can be, and there are no repetitive or redundant names.

**Why?** The LIFT guidelines are all covered.

**Why?** Helps reduce the app from becoming cluttered through organizing the content and keeping them aligned with the LIFT guidelines.

**Why?** When there are a lot of files (e.g. 10+), locating them is easier with a consistent folder structure and more difficult in a flat structure.


**Do** create an Angular module for each feature area.

**Why?** Angular modules make it easy to lazy load routable features.

**Why?** Angular modules make it easier to isolate, test, and re-use features.

Refer to this _folder and file structure_ example.

App root module

Style 04-08


**Do** create an Angular module in the app's root folder (e.g., in `/src/app`).

**Why?** Every app requires at least one root Angular module.


**Consider** naming the root module `app.module.ts`.

**Why?** Makes it easier to locate and identify the root module.

{@example 'style-guide/ts/src/04-08/app/app.module.ts' region='example'}

Feature modules

Style 04-09


**Do** create an Angular module for all distinct features in an application (e.g. `Heroes` feature).


**Do** place the feature module in the same named folder as the feature area (.e.g `app/heroes`).


**Do** name the feature module file reflecting the name of the feature area and folder (e.g. `app/heroes/heroes.module.ts`)


**Do** name the feature module symbol reflecting the name of the feature area, folder, and file (e.g. `app/heroes/heroes.module.ts` defines `HeroesModule`)

**Why?** A feature module can expose or hide its implementation from other modules.

**Why?** A feature module identifies distinct sets of related components that comprise the feature area.

**Why?** A feature module can easily be routed to both eagerly and lazily.

**Why?** A feature module defines clear boundaries between specific functionality and other application features.

**Why?** A feature module helps clarify and make it easier to assign development responsibilities to different teams.

**Why?** A feature module can easily be isolated for testing.

Shared feature module

Style 04-10


**Do** create a feature module named `SharedModule` in a `shared` folder (e.g. `app/shared/shared.module.ts` defines `SharedModule`).


**Do** declare components, directives, and pipes in a shared module when those 
items will be re-used and referenced by the components declared in other feature modules.


**Consider** using the name SharedModule, when the contents of a shared 
module are referenced across the entire application.


**Do** not provide services in shared modules. Services are usually 
singletons that are provided once for the entire application or 
in a particular feature module.


**Do** import all modules required by the assets in the `SharedModule` (e.g. `CommonModule` and `FormsModule`).

**Why?** `SharedModule` will contain components, directives and pipes that may need features from another common module (e.g. `ngFor` in `CommonModule`).


**Do** declare all components, directives, and pipes in the `SharedModule`.


**Do** export all symbols from the `SharedModule` that other feature modules need to use.

**Why?** `SharedModule` exists to make commonly used components, directives and pipes available for use in the templates of components in many other modules.


**Avoid** specifying app-wide singleton providers in a `SharedModule`. Intentional singletons are OK. Take care.

**Why?** A lazy loaded feature module that imports that shared module will make its own copy of the service and likely have undesireable results.

**Why?** You don't want each module to have its own separate instance of singleton services. Yet there is a real danger of that happening if the `SharedModule` provides a service.

src app shared shared.module.ts

    <aio-file>
      init-caps.pipe.ts|spec.ts
    </aio-file>


    <aio-file>
      text-filter.component.ts|spec.ts
    </aio-file>


    <aio-file>
      text-filter.service.ts|spec.ts
    </aio-file>


  </aio-folder>


  <aio-file>
    app.component.ts|html|css|spec.ts
  </aio-file>


  <aio-file>
    app.module.ts
  </aio-file>


  <aio-file>
    app-routing.module.ts
  </aio-file>


</aio-folder>


<aio-file>
  main.ts
</aio-file>


<aio-file>
  index.html
</aio-file>

... {@example 'style-guide/ts/src/04-10/app/shared/shared.module.ts'} {@example 'style-guide/ts/src/04-10/app/shared/init-caps.pipe.ts'} {@example 'style-guide/ts/src/04-10/app/shared/filter-text/filter-text.component.ts'} {@example 'style-guide/ts/src/04-10/app/shared/filter-text/filter-text.service.ts'} {@example 'style-guide/ts/src/04-10/app/heroes/heroes.component.ts'} {@example 'style-guide/ts/src/04-10/app/heroes/heroes.component.html'}

Core feature module

Style 04-11


**Consider** collecting numerous, auxiliary, single-use classes inside a core module
to simplify the apparent structure of a feature module.


**Consider** calling the application-wide core module, `CoreModule`.
Importing `CoreModule` into the root `AppModule` reduces its complexity 
and emphasizes its role as orchestrator of the application as a whole.


**Do** create a feature module named `CoreModule` in a `core` folder (e.g. `app/core/core.module.ts` defines `CoreModule`).


**Do** put a singleton service whose instance wil be shared throughout the application in the `CoreModule` (e.g. `ExceptionService` and `LoggerService`).


**Do** import all modules required by the assets in the `CoreModule` (e.g. `CommonModule` and `FormsModule`).

**Why?** `CoreModule` provides one or more singleton services. Angular registers the providers with the app root injector, making a singleton instance of each service available to any component that needs them, whether that component is eagerly or lazily loaded.

**Why?** `CoreModule` will contain singleton services. When a lazy loaded module imports these, it will get a new instance and not the intended app-wide singleton.


**Do** gather application-wide, single use components in the `CoreModule`.
Import it once (in the `AppModule`) when the app starts and never import it anywhere else. (e.g. `NavComponent` and `SpinnerComponent`).

**Why?** Real world apps can have several single-use components (e.g., spinners, message toasts, and modal dialogs) that appear only in the `AppComponent` template. They are not imported elsewhere so they're not shared in that sense. Yet they're too big and messy to leave loose in the root folder.


**Avoid** importing the `CoreModule` anywhere except in the `AppModule`.

**Why?** A lazily loaded feature module that directly imports the `CoreModule` will make its own copy of services and likely have undesireable results.

**Why?** An eagerly loaded feature module already has access to the `AppModule`'s injector, and thus the `CoreModule`'s services.


**Do** export all symbols from the `CoreModule` that the `AppModule` will import and make available for other feature modules to use.

**Why?** `CoreModule` exists to make commonly used singleton services available for use in the many other modules.

**Why?** You want the entire app to use the one, singleton instance. You don't want each module to have its own separate instance of singleton services. Yet there is a real danger of that happening accidentally if the `CoreModule` provides a service.

src app core core.module.ts

    <aio-file>
      logger.service.ts|spec.ts
    </aio-file>


    <aio-folder>
      nav
      <aio-file>
        nav.component.ts|html|css|spec.ts
      </aio-file>


    </aio-folder>


    <aio-folder>
      spinner
      <aio-file>
        spinner.component.ts|html|css|spec.ts
      </aio-file>


      <aio-file>
        spinner.service.ts|spec.ts
      </aio-file>


    </aio-folder>


  </aio-folder>


  <aio-file>
    app.component.ts|html|css|spec.ts
  </aio-file>


  <aio-file>
    app.module.ts
  </aio-file>


  <aio-file>
    app-routing.module.ts
  </aio-file>


</aio-folder>


<aio-file>
  main.ts
</aio-file>


<aio-file>
  index.html
</aio-file>

... {@example 'style-guide/ts/src/04-11/app/app.module.ts' region='example'} {@example 'style-guide/ts/src/04-11/app/core/core.module.ts'} {@example 'style-guide/ts/src/04-11/app/core/logger.service.ts'} {@example 'style-guide/ts/src/04-11/app/core/nav/nav.component.ts'} {@example 'style-guide/ts/src/04-11/app/core/nav/nav.component.html'} {@example 'style-guide/ts/src/04-11/app/core/spinner/spinner.component.ts'} {@example 'style-guide/ts/src/04-11/app/core/spinner/spinner.component.html'} {@example 'style-guide/ts/src/04-11/app/core/spinner/spinner.service.ts'}

AppModule is a little smaller because many app/root classes have moved to other modules. AppModule is stable because you will add future components and providers to other modules, not this one. AppModule delegates to imported modules rather than doing work. AppModule is focused on its main task, orchestrating the app as a whole. Back to top

Prevent re-import of the core module

Style 04-12

Only the root AppModule should import the CoreModule.


**Do** guard against reimporting of `CoreModule` and fail fast by adding guard logic.

**Why?** Guards against reimporting of the `CoreModule`.

**Why?** Guards against creating multiple instances of assets intended to be singletons.

{@example 'style-guide/ts/src/04-12/app/core/module-import-guard.ts'} {@example 'style-guide/ts/src/04-12/app/core/core.module.ts'}

Lazy Loaded folders

Style 04-13

A distinct application feature or workflow may be lazy loaded or loaded on demand rather than when the application starts.


**Do** put the contents of lazy loaded features in a *lazy loaded folder*.
A typical *lazy loaded folder* contains a *routing component*, its child components, and their related assets and modules.

**Why?** The folder makes it easy to identify and isolate the feature content.

Never directly import lazy loaded folders

Style 04-14


**Avoid** allowing modules in sibling and parent folders to directly import a module in a *lazy loaded feature*.

**Why?** Directly importing and using a module will load it immediately when the intention is to load it on demand.

Components

Component selector names

Style 05-02


**Do** use _dashed-case_ or _kebab-case_ for naming the element selectors of components.

**Why?** Keeps the element names consistent with the specification for [Custom Elements](https://www.w3.org/TR/custom-elements/).

{@example 'style-guide/ts/src/05-02/app/heroes/shared/hero-button/hero-button.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/05-02/app/heroes/shared/hero-button/hero-button.component.ts' region='example'} {@example 'style-guide/ts/src/05-02/app/app.component.html'}

Components as elements

Style 05-03


**Do** give components an _element_ selector, as opposed to _attribute_ or _class_ selectors.

**Why?** components have templates containing HTML and optional Angular template syntax. They display content. Developers place components on the page as they would native HTML elements and WebComponents.

**Why?** It is easier to recognize that a symbol is a component by looking at the template's html.

{@example 'style-guide/ts/src/05-03/app/heroes/shared/hero-button/hero-button.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/05-03/app/app.component.avoid.html'}

{@example 'style-guide/ts/src/05-03/app/heroes/shared/hero-button/hero-button.component.ts' region='example'} {@example 'style-guide/ts/src/05-03/app/app.component.html'}

Extract templates and styles to their own files

Style 05-04


**Do** extract templates and styles into a separate file, when more than 3 lines.


**Do** name the template file `[component-name].component.html`, where [component-name] is the component name.


**Do** name the style file `[component-name].component.css`, where [component-name] is the component name.


**Do** specify _component-relative_ URLs, prefixed with `./`, and add `moduleId: module.id` to the component metadata.

**Why?** Large, inline templates and styles obscure the component's purpose and implementation, reducing readability and maintainability.

**Why?** In most editors, syntax hints and code snippets aren't available when developing inline templates and styles. The Angular TypeScript Language Service (forthcoming) promises to overcome this deficiency for HTML templates in those editors that support it; it won't help with CSS styles.

**Why?** A _component relative_ URL requires no change when you move the component files, as long as the files stay together.

**Why?** The JIT compiler requires the `moduleId` for relative URLs; the AOT compiler, which doesn't need it, safely ignores this property.

**Why?** The `./` prefix is standard syntax for relative URLs; don't depend on Angular's current ability to do without that prefix.

{@example 'style-guide/ts/src/05-04/app/heroes/heroes.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/05-04/app/heroes/heroes.component.ts' region='example'} {@example 'style-guide/ts/src/05-04/app/heroes/heroes.component.html'} {@example 'style-guide/ts/src/05-04/app/heroes/heroes.component.css'}

Decorate input and output properties

Style 05-12


**Do** use the `@Input` and `@Output` class decorators instead of the `inputs` and `outputs` properties of the 
`@Directive` and `@Component` metadata:


**Consider** placing `@Input()` or `@Output()` on the same line as the property it decorates.

**Why?** It is easier and more readable to identify which properties in a class are inputs or outputs.

**Why?** If you ever need to rename the property or event name associated with `@Input` or `@Output`, you can modify it in a single place.

**Why?** The metadata declaration attached to the directive is shorter and thus more readable.

**Why?** Placing the decorator on the same line _usually_ makes for shorter code and still easily identifies the property as an input or output. Put it on the line above when doing so is clearly more readable.

{@example 'style-guide/ts/src/05-12/app/heroes/shared/hero-button/hero-button.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/05-12/app/heroes/shared/hero-button/hero-button.component.ts' region='example'}

Avoid aliasing inputs and outputs

Style 05-13


**Avoid** _input_ and _output_ aliases except when it serves an important purpose.

**Why?** Two names for the same property (one private, one public) is inherently confusing.

**Why?** You should use an alias when the directive name is also an _input_ property, and the directive name doesn't describe the property.

{@example 'style-guide/ts/src/05-13/app/heroes/shared/hero-button/hero-button.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/05-13/app/app.component.avoid.html'}

{@example 'style-guide/ts/src/05-13/app/heroes/shared/hero-button/hero-button.component.ts' region='example'} {@example 'style-guide/ts/src/05-13/app/heroes/shared/hero-highlight.directive.ts'} {@example 'style-guide/ts/src/05-13/app/app.component.html'}

Member sequence

Style 05-14


**Do** place properties up top followed by methods.


**Do** place private members after public members, alphabetized.

**Why?** Placing members in a consistent sequence makes it easy to read and helps instantly identify which members of the component serve which purpose.

{@example 'style-guide/ts/src/05-14/app/shared/toast/toast.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/05-14/app/shared/toast/toast.component.ts' region='example'}

Delegate complex component logic to services

Style 05-15


**Do** limit logic in a component to only that required for the view. All other logic should be delegated to services.


**Do** move reusable logic to services and keep components simple and focused on their intended purpose.

**Why?** Logic may be reused by multiple components when placed within a service and exposed via a function.

**Why?** Logic in a service can more easily be isolated in a unit test, while the calling logic in the component can be easily mocked.

**Why?** Removes dependencies and hides implementation details from the component.

**Why?** Keeps the component slim, trim, and focused.

{@example 'style-guide/ts/src/05-15/app/heroes/hero-list/hero-list.component.avoid.ts'}

{@example 'style-guide/ts/src/05-15/app/heroes/hero-list/hero-list.component.ts' region='example'}

Don't prefix output properties

Style 05-16


**Do** name events without the prefix `on`.


**Do** name event handler methods with the prefix `on` followed by the event name.

**Why?** This is consistent with built-in events such as button clicks.

**Why?** Angular allows for an [alternative syntax](template-syntax.html#binding-syntax) `on-*`. If the event itself was prefixed with `on` this would result in an `on-onEvent` binding expression.

{@example 'style-guide/ts/src/05-16/app/heroes/hero.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/05-16/app/app.component.avoid.html'}

{@example 'style-guide/ts/src/05-16/app/heroes/hero.component.ts' region='example'} {@example 'style-guide/ts/src/05-16/app/app.component.html'}

Put presentation logic in the component class

Style 05-17


**Do** put presentation logic in the component class, and not in the template.

**Why?** Logic will be contained in one place (the component class) instead of being spread in two places.

**Why?** Keeping the component's presentation logic in the class instead of the template improves testability, maintainability, and reusability.

{@example 'style-guide/ts/src/05-17/app/heroes/hero-list/hero-list.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/05-17/app/heroes/hero-list/hero-list.component.ts' region='example'}

Directives

Use directives to enhance an element

Style 06-01


**Do** use attribute directives when you have presentation logic without a template.

**Why?** Attributes directives don't have an associated template.

**Why?** An element may have more than one attribute directive applied.

{@example 'style-guide/ts/src/06-01/app/shared/highlight.directive.ts' region='example'}

{@example 'style-guide/ts/src/06-01/app/app.component.html'}

HostListener/HostBinding decorators versus host metadata

Style 06-03


**Consider** preferring the `@HostListener` and `@HostBinding` to the 
`host` property of the `@Directive` and `@Component` decorators.


**Do** be consistent in your choice.

**Why?** The property associated with `@HostBinding` or the method associated with `@HostListener` can be modified only in a single place - in the directive's class. If you use the `host` metadata property, you must modify both the property declaration inside the controller, and the metadata associated with the directive.

{@example 'style-guide/ts/src/06-03/app/shared/validator.directive.ts'}

Compare with the less preferred host metadata alternative.

**Why?** The `host` metadata is only one term to remember and doesn't require extra ES imports.

{@example 'style-guide/ts/src/06-03/app/shared/validator2.directive.ts'}

Services

Services are singletons

Style 07-01


**Do** use services as singletons within the same injector. Use them for sharing data and functionality.

**Why?** Services are ideal for sharing methods across a feature area or an app.

**Why?** Services are ideal for sharing stateful in-memory data.

{@example 'style-guide/ts/src/07-01/app/heroes/shared/hero.service.ts' region='example'}

Single responsibility

Style 07-02


**Do** create services with a single responsibility that is encapsulated by its context.


**Do** create a new service once the service begins to exceed that singular purpose.

**Why?** When a service has multiple responsibilities, it becomes difficult to test.

**Why?** When a service has multiple responsibilities, every component or service that injects it now carries the weight of them all.

Providing a service

Style 07-03


**Do** provide services to the Angular injector at the top-most component where they will be shared.

**Why?** The Angular injector is hierarchical.

**Why?** When providing the service to a top level component, that instance is shared and available to all child components of that top level component.

**Why?** This is ideal when a service is sharing methods or state.

**Why?** This is not ideal when two different components need different instances of a service. In this scenario it would be better to provide the service at the component level that needs the new and separate instance.

{@example 'style-guide/ts/src/07-03/app/app.component.ts'} {@example 'style-guide/ts/src/07-03/app/heroes/hero-list/hero-list.component.ts'}

Use the @Injectable() class decorator

Style 07-04


**Do** use the `@Injectable` class decorator instead of the `@Inject` parameter decorator when using types as tokens for the dependencies of a service.

**Why?** The Angular Dependency Injection (DI) mechanism resolves a service's own dependencies based on the declared types of that service's constructor parameters.

**Why?** When a service accepts only dependencies associated with type tokens, the `@Injectable()` syntax is much less verbose compared to using `@Inject()` on each individual constructor parameter.

{@example 'style-guide/ts/src/07-04/app/heroes/shared/hero-arena.service.avoid.ts' region='example'}

{@example 'style-guide/ts/src/07-04/app/heroes/shared/hero-arena.service.ts' region='example'}

Data Services

Talk to the server through a service

Style 08-01


**Do** refactor logic for making data operations and interacting with data to a service.


**Do** make data services responsible for XHR calls, local storage, stashing in memory, or any other data operations.

**Why?** The component's responsibility is for the presentation and gathering of information for the view. It should not care how it gets the data, just that it knows who to ask for it. Separating the data services moves the logic on how to get it to the data service, and lets the component be simpler and more focused on the view.

**Why?** This makes it easier to test (mock or real) the data calls when testing a component that uses a data service.

**Why?** The details of data management, such as headers, HTTP methods, caching, error handling, and retry logic, are irrelevant to components and other data consumers.

A data service encapsulates these details. It's easier to evolve these   
details inside the service without affecting its consumers. And it's   
easier to test the consumers with mock service implementations.

Lifecycle hooks

Use Lifecycle hooks to tap into important events exposed by Angular. Back to top

Implement lifecycle hook interfaces

Style 09-01


**Do** implement the lifecycle hook interfaces.

**Why?** Lifecycle interfaces prescribe typed method signatures. use those signatures to flag spelling and syntax mistakes.

{@example 'style-guide/ts/src/09-01/app/heroes/shared/hero-button/hero-button.component.avoid.ts' region='example'}

{@example 'style-guide/ts/src/09-01/app/heroes/shared/hero-button/hero-button.component.ts' region='example'}

Appendix

Useful tools and tips for Angular. Back to top

Codelyzer

Style A-01


**Do** use [codelyzer](https://www.npmjs.com/package/codelyzer) to follow this guide.


**Consider** adjusting the rules in codelyzer to suit your needs.

File templates and snippets

Style A-02


**Do** use file templates or snippets to help follow consistent styles and patterns. Here are templates and/or snippets for some of the web development editors and IDEs.


**Consider** using [snippets](https://marketplace.visualstudio.com/items?itemName=johnpapa.Angular2) for [Visual Studio Code](https://code.visualstudio.com/) that follow these styles and guidelines.

<a href="https://marketplace.visualstudio.com/items?itemName=johnpapa.Angular2">
  <img src="https://github.com/johnpapa/vscode-angular2-snippets/raw/master/images/use-extension.gif" width="80%" alt="Use Extension">
</a>  

**Consider** using [snippets](https://atom.io/packages/angular-2-typescript-snippets) for [Atom](https://atom.io/) that follow these styles and guidelines.

**Consider** using [snippets](https://github.com/orizens/sublime-angular2-snippets) for [Sublime Text](http://www.sublimetext.com/) that follow these styles and guidelines.

**Consider** using [snippets](https://github.com/mhartington/vim-angular2-snippets) for [Vim](http://www.vim.org/) that follow these styles and guidelines.

69 KiB Raw Blame History

Purpose

Style vocabulary

File structure conventions

Table of contents

Single responsibility

Rule of One

Small functions

Naming

General Naming Guidelines

Separate file names with dots and dashes

Symbols and file names

Service names

Bootstrapping

Directive selectors

Custom prefix for components

Custom prefix for directives

Pipe names

Unit test file names

End-to-End (E2E) test file names

Angular NgModule names

Coding conventions

Classes

Constants

Interfaces

Properties and methods

Import line spacing

Application structure and Angular modules

LIFT

Locate

Identify

Flat

T-DRY (Try to be DRY)

Overall structural guidelines

Folders-by-feature structure

App root module

Feature modules

Shared feature module

Core feature module

Prevent re-import of the core module

Lazy Loaded folders

Never directly import lazy loaded folders

Components

Component selector names

Components as elements

Extract templates and styles to their own files

Decorate input and output properties

Avoid aliasing inputs and outputs

Member sequence

Delegate complex component logic to services

Don't prefix output properties

Put presentation logic in the component class

Directives

Use directives to enhance an element

HostListener/HostBinding decorators versus host metadata

Services

Services are singletons

Single responsibility

Providing a service

Use the @Injectable() class decorator

Data Services

Talk to the server through a service

Lifecycle hooks

Implement lifecycle hook interfaces

Appendix

Codelyzer

File templates and snippets

69 KiB

Raw Blame History