README

A set of simple Typescript examples.

Conventional Commits

NOTE: This repo has switched to conventional commits. It requires pre-commit and commitizen to help with controlling this.

# install pre-commmit (prerequisite for commitizen)
brew install pre-commit
brew install commitizen
# conventional commits extension
code --install-extension vivaxy.vscode-conventional-commits

# install hooks
pre-commit install --install-hooks --overwrite --config .pre-commit-config.yaml

Contents

• README
  • Conventional Commits
  • Contents
  • Snippets
  • Troubleshooting
  • Github Actions
  • NX
  • Upgrading
  • 00 - Project templates using hygen
  • 01 - Basic cmdline
  • 02 - Templating
  • 03 - Testing
  • 05 - Promises
  • 06 - Dockerise Browser based Typescript
  • 08 - Use pino logger in typescript
  • 09 - Publish npm package for use as npx
  • 11 - Simple swagger typescript
  • 12 - Buildpack
  • 13 - Echo Service using TSOA
  • 15 - Demoscene Banner
  • 16 - OpenTelemetry Honeycomb
  • 17 - Redis
  • 20 - Hygen Templates
  • 21 - JSON Schema
  • 23 - Faking json data
  • 24 - Packages
  • 26 - Job Server
  • 27 - quokka
  • 28 - container debugging
  • 29 - container debugging for express
  • 30 - dockerignore filter commit
  • 32 - scripting AWS
  • Resources

Snippets

Useful snippets to help

Troubleshooting

If having trouble with nvm use with xcode crashing with exceptions.

xcodebuild -runFirstLaunch

Github Actions

Actions help .github/ACTIONS.md

NX

NX help 00_nx/README.md

Upgrading

If we're upgrading NPM packages there's some advice in UPGRADING.md

00 - Project templates using hygen

Example hygen templates to speed up project creation.
README.md

01 - Basic cmdline

Demonstrates a simple cmdline application (copy these steps)
README.md

02 - Templating

Demonstrates how to use typescript to template a file
README.md

03 - Testing

Demonstrates how to test typescript code (including debugging)
README.md

05 - Promises

Demonstrates how to use promises
README.md

06 - Dockerise Browser based Typescript

Demonstrate how to build a docker container containing typescript transpiled application
README.md

08 - Use pino logger in typescript

Demonstrates how to use pino logger in typescript
README.md

09 - Publish npm package for use as npx

Demonstrates how to package a typescript tool to npm to be run as npx
README.md

11 - Simple swagger typescript

Demonstrates a simple swagger interface
README.md

12 - Buildpack

Demonstrates a simple cmdline application packaged in a buildpack
README.md

13 - Echo Service using TSOA

Demonstrates a simple echo service using TSOA
README.md

15 - Demoscene Banner

Demonstrate creating a ascii banner from an old demoscene font.
README.md

16 - OpenTelemetry Honeycomb

Demonstrate using opentelemetry with a simple cli tool
README.md

17 - Redis

Demonstrate how to connect and use Redis from typescript
README.md

20 - Hygen Templates

Demonstrate how to use hygen as a template.
README.md

21 - JSON Schema

Demonstrate how to work JSONSchema to validate and generate types.
README.md

23 - Faking json data

Demonstrates generating fake json data.
README.md

24 - Packages

Demonstrate some examples of how to develop and use custom packages.
README.md

26 - Job Server

Demonstrates building a job monitor in an express server.
README.md

27 - quokka

Demonstrate some quokka examples
README.md

28 - container debugging

Demonstrate how to debug typescript applications in the container.
README.md

29 - container debugging for express

Demonstrate how to debug typescript express applications in the container.
README.md

30 - dockerignore filter commit

Demonstrate checking if a commit should trigger docker build
README.md

32 - scripting AWS

Demonstrate examples of using TS as a language for scripting against AWS.
README.md

Resources

• typescript book