Coding standards for Angular2/TypeScript

Question

I'm wondering if there's at least some community consensus on how to write reusable Angular2 code in TypeScript. I tried to summarise what I found out and what I'd like to know in context of Angular2.

Module/App directory structure and file names

In the official tutorial I see they put all code into app directory and all dependencies like node_modules or typings are in the parent directory.
Lowercase file names, .component.ts suffix for components and .service.ts for services. They put all files to the same directory which is going to be a huge mess?
One class/interface/enum per file. For classes, functions, interfaces and other names its probably best to stick to Coding guidelines for TypeScript by Microsoft?

Modules

Should modules compile and bundle themselves using postinstall npm hook? Or is it better to provide bundled version directly on git like most JavaScript libraries do?
Should I stick to system type of modules by default when I'm expecting that my module's going to be used only by browser or is it better to always use UMD?
Is there any reason to use CommonJS or AMD instead of system?

Using 3rd party modules

Should I expect that other developers will embed my modules with <script> tags or they'll load it using System.import()?
If my modules has dependencies on other JavaScript libraries, is it better to provide a bundled version of my whole module with all dependencies or just define them in package.json?

acdcjunior · Accepted Answer · 2016-02-22 19:06:59Z

4

There's the Angular 2 Style Guide (https://github.com/mgechev/angular2-style-guide), as featured in Angular2 News:

The purpose of the following style guide is to present a set of best practices and style guidelines for the development of Angular 2 applications. If you are looking for an opinionated style guide for syntax, conventions...

answered Feb 22, 2016 at 19:06

acdcjunior

136k37 gold badges341 silver badges312 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Brocco · Accepted Answer · 2016-02-22 18:39:06Z

1

Angular 1 had a community accepted style guide written by John Papa. There will be something similar created for Angular 2 in fact you can see the start of this coming together with the Tour of Heroes examples in place at angular.io

answered Feb 22, 2016 at 18:39

Brocco

65.4k12 gold badges74 silver badges77 bronze badges

Collectives™ on Stack Overflow

Coding standards for Angular2/TypeScript

Module/App directory structure and file names

Modules

Using 3rd party modules

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

Module/App directory structure and file names

Modules

Using 3rd party modules

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related