lagner/typescript-guidelines

TypeScript writing guidelines

Typescript Guidebook

Welcome to the TypeScript Guidebook.

This guidebook suppliments the official TypeScript Handbook while focusing on how to get the most out of TypeScript with minimal effort.

It will cover anything and everything you need when writing TypeScript, from how to use the language, to coding style and any tool that may be useful.

Highlights

• Stay true to JavaScript
• Use TypeScript as a gradual type system on top of JavaScript.
• Focus on code efficiency
• Focus on tool compatibility
  • IDE / Editors
    • Visual Studio Code
    • Atom
    • WebStorm
  • Linter
    • tslint

Watch this repo

I'll periodically update this repo. You can click the watch button if you want to be notified.

Disclaimer

Recently I do most of my work in VS Code. So if you find that some of the guidelines doesn't work well in your IDE, let me know and we can see how to get it working on your IDE.

Table of Contents

• Introduction
  • What is TypeScript
  • TypeScript Resources
• JavaScript Syntax
  • Array
  • Arrow Function
  • Async Await
  • Class
  • Decorator
  • Default Function Parameter
  • Error
  • Import Export
  • Object Descructuring
  • Object Literal
  • Property Accessor
  • Variable Assignment
  • Variable Declaration
• TypeScript Syntax
  • Basic Types
  • Interfaces
  • Type Assertion
  • Modules
• Files and Projects
  • Compiler Options
  • Files
  • Code Organization
  • tsconfig.json
  • package.json
  • Converting from JavaScript
• Coding Practice
  • Testing
• Typings
  • Functions
  • Overloading
  • Namespaces and Modules
  • Shape of typings
  • tslint configuration
• Tooling
  • tslint.json
• draft File structures
• draft Types
• draft Objects
• draft Destructuring
• draft Strings
• draft Functions
• draft Control statements
• draft Modules
• draft Iterators and Generators
• draft Properties
• draft Variables
• draft Hoisting
• draft Comparison Operators & Equality
• draft Blocks
• draft Comments
• draft Whitespaces
• draft Commas
• draft Semicolons
• draft Type Casting & Coercion
• draft Naming Conventions
• draft Events
• draft ECMAScript 6 Styles

Contributing

• Follow the markdown style guide

• Each section heading should be neutral, e.g. "var keyword" instead of "avoid var"

  Why? The heading would be used as link. So if the style guide suggestion changes, keeping the heading neutral would avoid broken links.