node-setup

Connected Cars JavaScript/TypeScript development setup

Use

1npm install --save-dev @connectedcars/setup

Automatic

Initiate project

1./node_modules/.bin/setup init

Update dependencies

1./node_modules/.bin/setup update

Flags

-f, --force             Whether to override/remove existing configuration
-h, --help              Output usage information
-t, --template [value]  Which template to use (defaults to "node")
-v, --verbose           Whether to enable verbose logging
-V, --version           Output the version number

Manual

Extend existing configurations from node_modules/setup:

• Babel
• ESlint
• Jest
• TypeScript

And manually install needed dependencies:

• package.json

VSCode

Extensions

Required:

• EditorConfig
• eslint

Sugested:

• jest-runner

extensions.json

1{
2  "recommendations": ["dbaeumer.vscode-eslint", "firsttris.vscode-jest-runner", "editorconfig.editorconfig"]
3}

launch.json

1{
2  "version": "0.2.0",
3  "configurations": [
4    {
5      "type": "node",
6      "name": "vscode-jest-tests",
7      "request": "launch",
8      "args": [
9        "--runInBand",
10        "--coverage=false"
11      ],
12      "cwd": "${workspaceFolder}",
13      "console": "integratedTerminal",
14      "internalConsoleOptions": "neverOpen",
15      "program": "${workspaceFolder}/node_modules/jest/bin/jest"
16    },
17    {
18      "name": "setup init",
19      "type": "node",
20      "request": "launch",
21      "protocol": "inspector",
22      "cwd": "${workspaceRoot}",
23      "preLaunchTask": "npm: build:js",
24      "outFiles": [
25        "${workspaceRoot}/build/dist/**/**.js"
26      ],
27      "program": "${workspaceFolder}/bin/setup.ts",
28      "sourceMaps": true,
29      "args": [
30        "init"
31      ],
32      "env": {
33        "TEMPLATES_PATH": "${workspaceFolder}/templates"
34      },
35      "internalConsoleOptions": "openOnSessionStart"
36    }
37  ]
38}

settings.json

1{
2  "typescript.tsdk": "node_modules/typescript/lib",
3  "eslint.enable": true,
4  "eslint.validate": [
5    "javascript",
6    "typescript"
7  ],
8  "files.autoSave": "off",
9  "files.exclude": {
10    "**/.git": true,
11    "**/.DS_Store": true,
12    "build": true
13  },
14  "git.ignoreLimitWarning": true,
15  "[javascripts][javascriptreact][typescript][typescriptreact][json]": {
16    "editor.formatOnSave": false,
17    "editor.codeActionsOnSave": {
18      "source.fixAll.eslint": true
19    }
20  },
21  "[json][jsonc]": {
22    "editor.formatOnSave": true
23  }
24}

tasks.json

1{
2    // See https://go.microsoft.com/fwlink/?LinkId=733558
3    // for the documentation about the tasks.json format
4    "version": "2.0.0",
5    "tasks": [
6        {
7            "type": "npm",
8            "script": "build:js",
9            "group": "build",
10            "problemMatcher": []
11        }
12    ]
13}