kdico-vscode-ts-boilerplate

TypeScript template repository for Visual Studio Code, Dev Containers, Jest, and SonarLint.

Usage

1. Optionally delete the sample/ folder.
2. Open the project in a Dev Container which will use the resulting container from Dockerfile as the development environment.
3. Code away.

What's included?

VS Code Extensions

When using VS Code, this template will recommend the Dev Containers extension.

If installed, the Dev Containers extension will install other verified extensions listed below and will remain installed while using the development environment container. Otherwise, these must be manually installed locally.

• Docker to manage development environment containers.
• ESLint for linting support.
• Prettier - Code formatter for formatting support.
• SonarLint for static code analysis.
• EditorConfig for VS Code for other workspace settings.

SonarLint

SonarLint is included in this template for static code analysis. It will highlight areas that violate rules while writing code. For this template, the following rules apply.

• JavaScript
• TypeScript
• Docker

Dockerfile installs the requirements for the SonarLint extension. See https://docs.sonarsource.com/sonarlint/vs-code/getting-started/requirements/ for language-specific requirements.

ESLint & Style Guide

This template follows the Google TypeScript Style using gts which is configured to use ESLint and Prettier.

Debug Logs

A minimal debug logging mechanism using debug is included in this template. To enable debug logging for this template, set the DEBUG environment variable value to app which is defined in src/util/debug/logger.ts. Try running sample/sample.ts with debug enabled like below.

# bash
DEBUG=app npx ts-node ./sample/sample.ts

NPM Scripts

• prepare
  • Installs husky for pre-commit hooks.
  • On commit, runs check, lint, and test.
• test
  • Runs the unit tests.
• lint
  • Checks for lint issues.
• clear
  • Deletes the build/ folder.
• fix
  • Fixes lint issues where it can.
• compile
  • Compiles the project.
  • Creates the build/ folder.
• check
  • Checks for type errors.