@backtrack/preset-node

About

backtrack preset that sets up a node project.

Features

• jest with Wallaby.js, CircleCI and AppVeyor
• eslint, and prettier
• package.json scripts
• git-pre-push, git-pre-commit and prepublish hooks
• Automatic app restarts in development via nodemon
• Optional: babel with babel-preset-env
• Optional: typescript

Installation

npm install --save-dev @backtrack/preset-node

Usage

1// backtrack.config.js
2
3'use strict';
4
5module.exports = {
6	// see settings below
7	presets: [
8		[
9			'@backtrack/node',
10			{
11				mode: 'module',
12				syntax: 'node',
13			},
14		],
15	],
16};

Settings

1'use strict';
2
3module.exports = {
4	presets: [
5		[
6			'@backtrack/node',
7			{
8				/**
9				 * Project mode type
10				 *
11				 * Required
12				 *
13				 * Available modes:
14				 *     module - npm module
15				 *     app - node application
16				 *
17				 */
18				mode: 'app',
19
20				/**
21				 * Javascript syntax
22				 *
23				 * Required
24				 *
25				 * Available syntax:
26				 *     node: Target package.json's engines.node (no compilation)
27				 *
28				 *     babel: Use babel to provide latest javascript features
29				 *         - app requirements:
30				 *             - npm install --save source-map-support core-js@3
31				 *
32				 *     typescript: Use Typescript
33				 *         - requirements
34				 *             - npm install --save-dev typescript
35				 *         - app requirements:
36				 *             - npm install --save source-map-support core-js@3
37				 */
38				syntax: 'typescript',
39
40				/**
41				 * Specify node version
42				 *
43				 * module default: '>=14.15.0'
44				 * app default: '^16.13.0'
45				 */
46				nodeVersion: '^18.0.0',
47
48				/**
49				 * Enable/disable Windows-only features
50				 *
51				 * module default: true
52				 * app default: false
53				 */
54				windows: false,
55			},
56		],
57	],
58};