Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 2.48 KB

library.md

File metadata and controls

94 lines (63 loc) · 2.48 KB
Raw

Scaffolding for a library

Changelog

Version : 1.0.0
Angular version: 5.*
Last update : 04/04/2018

Summary

  • Seed
  • Linters

Seed

You should use a seed like Angular Seed or at least the Angular CLI to create the scaffolding of the application.

Example

Install the Angular CLI:

npm install -g @angular/cli

Then create your new project:

ng new PROJECT-NAME
cd PROJECT-NAME
ng serve

Linters

TSLint

Use TSLinter to help you maintain a good syntax for TypeScript.
Create a tslint.json file on the root folder (which is already generated when creating a new project with Angular CLI).
Copy this sample if you want a prebuild linter.

Then install the package if it is not installed yet:

npm install tslint --save-dev

Using WebStorm

You should enable the live TSLinter from WebStorm settings to ensure that the linter is always working and help you coding safer and faster.
To do so, CTRL + ALT + S and search TSLint.
Then check Enable.
WebStorm will automatically search the corresponding configuration file.

StyleLint

Use StyleLint to help you maintain a good syntax for your CSS.
Create a .stylelintrc file on the root folder.
Copy this sample if you want a prebuild linter.

Then install the package:

npm install stylelint --save-dev

Standard rules

Instead of creating my own rules from scratch, I use a standard one.
You should install it:

npm install stylelint-config-standard --save-dev

Ignore

To avoid watching and analyzing useless files, like minified ones or bundles ones, you can simply ignore them.
Create a .stylelintignore file on the root folder.
Copy this sample if you want a prebuild StyleLint ignore.

Using WebStorm

You should enable the live StyleLint from WebStorm settings to ensure that the linter is always working and help you coding safer and faster.
To do so, CTRL + ALT + S and search StyleLint.
Then check Enable.
WebStorm will automatically search the corresponding configuration file.

Using SASS

As a Front-End developer, I did not encourage you to use CSS.
Instead you should use a preprocessor like SASS, LESS or Stylus.
Since SASS is already installed with the Angular CLI, I recommand his usage.
Copy this sample if you want a prebuild linter using SASS.