Skip to content

Latest commit

 

History

History
87 lines (66 loc) · 3.41 KB

DevTools.md

File metadata and controls

87 lines (66 loc) · 3.41 KB
Raw

Development tooling

The repo comes with tooling pre-configured for most development tasks for node.js projects built in TypeScript

Goal

The goal is to be simple, lean and automated.

  • minimize dependencies.
  • use simpler-to-understand dependencies when necessary.
  • enable a move-fast mindset.

Support for the following is baked in:

  • tslint
  • build automation
  • ava test-automation
  • test coverage (remapped to TypeScript)
  • checks dependencies for known vulnerabilities before commit.
  • CI integration - using github actions
  • Code of Conduct
  • commitizen integration

DX & minimizing tech-debt

This package take an opinioned view on the Developer-Experience with an eye towards minimizing tech-debt. There are four operations that will be part of a developer experience:

  • npm build: cleans, lints, builds and tests with coverage metrics.
  • git cz: formats commit message to ease generation of Changelogs
  • git push: a pre-push hook runs coverage-check, checks packages for updates and unpatched vulnerabilities

The process is meant to serve as an early-warning mechanism to catch issues that will cause potentially expensive mishaps or re-work later in the project life-cycle.

run-scripts

Since "lean"-ness is a primary goal, npm is used as a build tool. We use npm-run-batch to create a simple pipeline of tasks to perform for each build step.

The run-scripts used

aside: To help with these, we recommend npm-completion

commit      : uses `commitizen` to help format commit messages
clean       : `rimraf ./dist ./coverage`
build       : builds the project
build:watch : watch project files and rebuild when anything changes
test        : runs tests with coverage on generated JavaScript
secure      : checks all installed dependencies for vulnerabilities
lcheck      : compliance check of project dependency license
coverage    : prints coverage report over typescript source

Project Structure

The directory structure of a typical project:

├── LICENSE
├── README.md
├── package.json
├── scripts/              - post install scripts
├── src/                  - module source (TypeScript)
│   ├── test/
│   │   └── specs/
│   │       └── index.ts
│   └── index.ts
├── docs/                 - module documentation
├── tsconfig.dist.json    - production tsconfig
├── tsconfig.json         - development tsconfig
└── tslint.json           - tslint

In addition, these directories are auto-created by the various scripts. The coverage & build directories are .gitignored. By design, dist directories are commited to the repo. For components with non-native dependencies, which is a vast majority of the cases, this is an advantage, since it minimizes the module size for download and makes the build setup a lot simpler.

If your module includes native/compiled artifacts, this might need to be reconsidered.

├── coverage/
|   └── typescript/
|       └── index.html    - html report of typescript
└── dist/                 - Commmitted to repo. Minimizes package size