This starter project contains
- Typescript
- i18n-node
- tape for testing
- istanbul coverage
- tslint & eslint
- Templating by nunjucks
- express
- winston for logging
1.- Globally install yarn
You can find instruction at https://yarnpkg.com/en/docs/install
2.- Setup your IDE (if you didn't already):
- Enable typescript to read from tsconfig.json
- Enable tslint to read from tslint.json
- Enable eslint to read from .eslintrc
3.- Setup the project:
Run all the following commands in the root of your project
Run $ yarn and it will install all the dependencies.
$ yarn dev
$ yarn test
You must name your test <name>.spec.ts and save the file in the same folder of the file you are testing.
For example, tests for server.ts should be in server.spec.ts
|-- src
|-- utils.ts
|-- utils.spec.ts
|-- server.ts
|-- server.spec.ts
$ yarn cover
Running coverage will display the coverage percentage in the console.
It will also create a ./coverage folder with an index.html where you can view the results in a browser.
Typescript documentation can be found at http://www.typescriptlang.org/docs/tutorial.html
Typescript configuration can be found at http://www.typescriptlang.org/docs/handbook/tsconfig-json.html
This project uses i18n-node for localization.
A couple of ways to change the language:
- Pass the language as a query parameter using
lang(Ex: http://localhost:3000/?lang=es) - Set the cookie
langwith the language (Ex: en-US or es)
In templates, translation can be done by using the translate (for regular translations) and pluralTranslate (for plural translations) functions:
Ex:
In en-US.json:
{
"main_title": "Node.js and Typescript Example",
"dogs": "[0] no dog|[2,5] some dogs|[6,11] many dogs|[12,36] dozens of dogs|a horde of %s dogs|[100,] too many dogs"
}In index.njk:
<div>{{ translate('main_title') }}</div>
<div>{{ pluralTranslate('dogs', 100) }}</div>Expected result:
<div>Node.js and Typescript Example</div>
<div>too many dogs</div>const { Logger } = require('./src/utils');
logger.debug("debug message");
logger.info("info message");
logger.warn("warn message");
logger.error("error message");const { Debug } = require('./src/utils');
const debug = Debug('filename');
debug("this is a test"); // If the environment variable appName has been set to NodeApp (see server.ts),
// the debug output would be <date> NodeApp:filename this is a testA Node.js and Browser-based JavaScript Template Engine. Documentation available at http://mozilla.github.io/nunjucks/.
Lightweight simple translation module for node.js / express.js with dynamic json storage. Uses common __('...') syntax in app and templates. Documentation available at https://github.com/mashpie/i18n-node.
Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. More information is available at http://expressjs.com/.
Help secure Express apps with various HTTP headers. Documentation can be found at https://github.com/helmetjs/helmet.
A simple and universal logging library. Documentation can be found at https://github.com/winstonjs/winston.
Hierarchical node.js configuration with files, environment variables, command-line arguments, and atomic object merging. Documentation can be found at https://www.npmjs.com/package/nconf
This micro-lib allows you to provide a script which sets an environment using unix style and have it work on windows too.
I decided to use the Tape test module after reading https://medium.com/javascript-scene/why-i-use-tape-instead-of-mocha-so-should-you-6aa105d8eaf4#.mo56gj6jk.
Formatted TAP output like Mocha's spec reporter.
Used for code coverage. Documentation can be found at https://gotwarlost.github.io/istanbul/.
Nodemon is a utility that will monitor for any changes in your source and automatically restart the server. Documentation can be found at http://nodemon.io/.
Run commands concurrently cross platform. With the --kill-others switch, all commands are killed if one dies.
Used to output debugging messages