From c617e20e0065e3a9efc29cb430e8d67b0177a083 Mon Sep 17 00:00:00 2001 From: Resi Respati Date: Tue, 6 Feb 2018 18:01:40 +0700 Subject: [PATCH] [docs] Big Docs Update --- README.md | 15 ++++++++++++--- docs/README.md | 2 ++ docs/getting-started/installation.md | 12 +++++------- docs/in-depth/cookbook/one-line-powershell.md | 2 +- docs/in-depth/module-bundling.md | 2 +- docs/in-depth/typescript.md | 5 +++-- 6 files changed, 24 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d0eff61..81520ee 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,21 @@ Screeps Typescript Starter is a starting point for a Screeps AI written in Types You will need: - - Node.JS (Latest LTS is recommended) - - A Package Manager (Yarn or NPM) + - [Node.JS](https://nodejs.org/en/download) (>= 8.0.0) + - A Package Manager ([Yarn](https://yarnpkg.com/en/docs/getting-started) or [npm](https://docs.npmjs.com/getting-started/installing-node)) + - Rollup CLI (Optional, install via `npm install -g rollup`) Download the latest source [here](https://github.com/screepers/screeps-typescript-starter/archive/master.zip) and extract it to a folder. -Open the folder in your terminal and run `npm install` (or `yarn`) to install the dependencies. +Open the folder in your terminal and run your package manager to install install the required packages and TypeScript declaration files: + +```bash +# npm +npm install + +# yarn +yarn +``` Fire up your preferred editor with typescript installed and you are good to go! diff --git a/docs/README.md b/docs/README.md index ab86561..11d6511 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,8 @@ Screeps Typescript Starter is a starting point for a Screeps AI written in [Typescript](http://www.typescriptlang.org/). It provides everything you need to start writing your AI whilst leaving `main.ts` as empty as possible. +[View on GitHub](https://github.com/screepers/screeps-typescript-starter) + ## What's new (v3.0) ### Simpler setup! diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 9f9540a..ec9dbe6 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -4,21 +4,19 @@ You will need: - - Node.JS (Latest LTS is recommended) - - A Package Manager (`yarn` or `npm`) + - [Node.JS](https://nodejs.org/en/download) (>= 8.0.0) + - A Package Manager ([Yarn](https://yarnpkg.com/en/docs/getting-started) or [npm](https://docs.npmjs.com/getting-started/installing-node)) - Rollup CLI (Optional, install via `npm install -g rollup`) ## Installing `npm` modules -Run the following the command to install the required packages and TypeScript declaration files: +Open the folder in your terminal and run your package manager to install install the required packages and TypeScript declaration files: ```bash +# npm npm install -``` -Or if you're running `yarn`: - -```bash +# yarn yarn ``` diff --git a/docs/in-depth/cookbook/one-line-powershell.md b/docs/in-depth/cookbook/one-line-powershell.md index 26de760..4737910 100644 --- a/docs/in-depth/cookbook/one-line-powershell.md +++ b/docs/in-depth/cookbook/one-line-powershell.md @@ -1,6 +1,6 @@ # One-line PowerShell setup -> **TODO:** Make sure this works with v3.0. +> **Note:** As of v3.0, this no longer works. This issue is being tracked [here](https://github.com/ChrisTaylorRocks/screeps-typescript-starter-setup/issues/1). [@ChrisTaylorRocks](https://github.com/ChrisTaylorRocks) has made a PowerShell script to get the starter kit up and running with a single command. Go check it out [here](https://github.com/ChrisTaylorRocks/screeps-typescript-starter-setup)! diff --git a/docs/in-depth/module-bundling.md b/docs/in-depth/module-bundling.md index 97492aa..f6dd53d 100644 --- a/docs/in-depth/module-bundling.md +++ b/docs/in-depth/module-bundling.md @@ -20,7 +20,7 @@ From version 3.0 onwards, the starter kit uses Rollup as its main module bundler * Advanced tree-shaking (eliminates unused modules from the final bundle) * Simpler configuration (compared to Webpack) -If you're still comfortable with using Webpack, the old version of the starter kit is available here (**TODO:** legacy branch link), but moving forward, no new features will be added to the Webpack version. +If you're still comfortable with using Webpack, the old version of the starter kit is available [here](https://github.com/screepers/screeps-typescript-starter/tree/legacy/webpack), but moving forward, no new features will be added to the Webpack version. ### Note: Rollup and named exports diff --git a/docs/in-depth/typescript.md b/docs/in-depth/typescript.md index 242c7c8..3d7d984 100644 --- a/docs/in-depth/typescript.md +++ b/docs/in-depth/typescript.md @@ -2,7 +2,7 @@ TypeScript is, in our opinion, the best language to write your Screeps codebase in. It combines the familiarity of JavaScript with the power of static typing. -Static typing helps reduce the amount of bugs in your code by detecting type errors during compile time. In general, static type checkers like TypeScript and Flow [can prevent about 15%](https://blog.acolyer.org/2017/09/19/to-type-or-not-to-type-quantifying-detectable-bugs-in-javascript/) of the bugs that end up in committed code. Not only static typing, TypeScript also provides various productivity enhancements like advanced statement completion, as well as smart code refactoring. +Static type checkers like TypeScript and [Flow](https://flow.org/) help reduce the amount of bugs in your code by detecting type errors during compile time. In general, using static typing in your JavaScript code [can help prevent about 15%](https://blog.acolyer.org/2017/09/19/to-type-or-not-to-type-quantifying-detectable-bugs-in-javascript/) of the bugs that end up in committed code. Not only static typing, TypeScript also provides various productivity enhancements like advanced statement completion, as well as smart code refactoring. To read more about how TypeScript can help you in Screeps, read [this Screeps World article](https://screepsworld.com/2017/07/typescreeps-getting-started-with-ts-in-screeps/) by [@bonzaiferroni](https://github.com/bonzaiferroni). @@ -12,13 +12,14 @@ This section provides TypeScript-specific tips & tricks for you to make the The `--strict` compiler flag was introduced in TypeScript 2.3 which activates TypeScript's "strict mode". The strict mode sets all strict typechecking options to `true` by default. -As of TypeScript 2.6, the affected options are: +As of TypeScript 2.7, the affected options are: * `--noImplicitAny` * `--noImplicitThis` * `--alwaysStrict` * `--strictNullChecks` * `--strictFunctionTypes` +* `--strictPropertyInitialization` Starting from version 2.0 of the starter kit, we've enabled the `--strict` flag in `tsconfig.json`. If this gives you compile time errors, you can try setting `"strict"` to `false`, or by overriding one or more of the options listed above.