1.1.173 • Published 5 years ago

@stencila/typescript-boilerplate v1.1.173

Weekly downloads
241
License
Apache-2.0
Repository
github
Last release
5 years ago

@stencila/typescript-boilerplate

What

An opinionated tooling setup for Typescript projects including,

  • typescript for compiling Typescript
  • jest for testing
  • typedoc for source code documentation
  • ts-node and ts-node-dev for running scripts during development

Usage

Just use this as an example when creating a new project. Check out the package.json and add or modify other files as needed...

A tsconfig.json file that extends or modifies the Typescript configuration in dev-config e.g.

{
  "extends": "@stencila/dev-config/tsconfig.json",
  "compilerOptions": {
    /* Enable experimental support for ES7 decorators. */
    "experimentalDecorators": true
  }
}

Add a jest configuration object to your package.json:

  // …
  "jest": {
    "preset": "ts-jest",
    "testEnvironment": "node",
    "testMatch": [
      "**/tests/**/*.test.ts"
    ]
  },
  // …

Create a typedoc.json file or modify the one in dev-config

{
  "out": "./docs",
  "readme": "./README.md"
}

Add scripts to your package.json file for running tests, collecting coverage, building the package and generating documetation:

  // …
  "scripts": {
    "test": "jest",
    "test:cover": "jest --collectCoverage",
    "test:watch": "jest --watch",
    "build": "tsc",
    "docs": "typedoc src"
  },
  // …
  1. Add main, types and other entries in your package.json file to point to the compiled files in the dist folder:
  // …
  "main": "dist/src/index.js",
  "types": "dist/src/index.d.ts",
  "bin": "dist/src/cli.js",
  // …
  1. Add the following folders to your .gitignore file:
/coverage
/dist
/docs
StenciladevTypescriptboilerplateconfiguration
@infinitebrahmanuniverse/nolb-_sten@everything-registry/sub-chunk-872
1.1.173

5 years ago

1.1.172

5 years ago

1.1.171

5 years ago

1.1.170

5 years ago

1.1.169

5 years ago

1.1.168

5 years ago

1.1.167

5 years ago

1.1.166

5 years ago

1.1.165

5 years ago

1.1.164

5 years ago

1.1.163

5 years ago

1.1.162

5 years ago

1.1.161

5 years ago

1.1.160

5 years ago

1.1.159

5 years ago

1.1.158

5 years ago

1.1.157

5 years ago

1.1.156

5 years ago

1.1.155

5 years ago

1.1.154

5 years ago

1.1.153

5 years ago

1.1.152

5 years ago

1.1.151

5 years ago

1.1.149

5 years ago

1.1.150

5 years ago

1.1.148

5 years ago

1.1.147

5 years ago

1.1.144

5 years ago

1.1.146

5 years ago

1.1.145

5 years ago

1.1.143

5 years ago

1.1.142

5 years ago

1.1.141

5 years ago

1.1.140

5 years ago

1.1.139

5 years ago

1.1.138

5 years ago

1.1.137

5 years ago

1.1.136

5 years ago

1.1.135

5 years ago

1.1.134

5 years ago

1.1.133

5 years ago

1.1.132

5 years ago

1.1.131

5 years ago

1.1.130

5 years ago

1.1.129

5 years ago

1.1.128

5 years ago

1.1.127

5 years ago

1.1.126

5 years ago

1.1.125

5 years ago

1.1.122

5 years ago

1.1.124

5 years ago

1.1.123

5 years ago

1.1.121

5 years ago

1.1.120

5 years ago

1.1.119

5 years ago

1.1.118

5 years ago

1.1.117

5 years ago

1.1.116

5 years ago

1.1.115

5 years ago

1.1.114

5 years ago

1.1.113

5 years ago

1.1.112

5 years ago

1.1.111

5 years ago

1.1.110

5 years ago

1.1.109

5 years ago

1.1.108

5 years ago

1.1.107

5 years ago

1.1.106

5 years ago

1.1.105

5 years ago

1.1.104

5 years ago

1.1.103

5 years ago

1.1.102

5 years ago

1.1.101

5 years ago

1.1.100

5 years ago

1.1.99

5 years ago

1.1.98

5 years ago

1.1.96

5 years ago

1.1.97

5 years ago

1.1.95

5 years ago

1.1.94

5 years ago

1.1.93

5 years ago

1.1.92

5 years ago

1.1.89

5 years ago

1.1.91

5 years ago

1.1.90

5 years ago

1.1.88

5 years ago

1.1.87

5 years ago

1.1.86

5 years ago

1.1.85

5 years ago

1.1.84

5 years ago

1.1.83

5 years ago

1.1.82

5 years ago

1.1.78

5 years ago

1.1.79

5 years ago

1.1.81

5 years ago

1.1.80

5 years ago

1.1.77

5 years ago

1.1.76

5 years ago

1.1.74

6 years ago

1.1.73

6 years ago

1.1.75

6 years ago

1.1.72

6 years ago

1.1.70

6 years ago

1.1.71

6 years ago

1.1.69

6 years ago

1.1.68

6 years ago

1.1.67

6 years ago

1.1.66

6 years ago

1.1.65

6 years ago

1.1.64

6 years ago

1.1.63

6 years ago

1.1.59

6 years ago

1.1.58

6 years ago

1.1.62

6 years ago

1.1.61

6 years ago

1.1.60

6 years ago

1.1.56

6 years ago

1.1.55

6 years ago

1.1.57

6 years ago

1.1.52

6 years ago

1.1.51

6 years ago

1.1.54

6 years ago

1.1.53

6 years ago

1.1.50

6 years ago

1.1.49

6 years ago

1.1.48

6 years ago

1.1.47

6 years ago

1.1.45

6 years ago

1.1.46

6 years ago

1.1.44

6 years ago

1.1.43

6 years ago

1.1.39

6 years ago

1.1.41

6 years ago

1.1.40

6 years ago

1.1.42

6 years ago

1.1.38

6 years ago

1.1.37

6 years ago

1.1.36

6 years ago

1.1.35

6 years ago

1.1.34

6 years ago

1.1.33

6 years ago

1.1.32

6 years ago

1.1.31

6 years ago

1.1.29

6 years ago

1.1.28

6 years ago

1.1.30

6 years ago

1.1.27

6 years ago

1.1.26

6 years ago

1.1.25

6 years ago

1.1.24

6 years ago

1.1.23

6 years ago

1.1.22

6 years ago

1.1.21

6 years ago

1.1.20

6 years ago

1.1.19

6 years ago

1.1.18

6 years ago

1.1.17

6 years ago

1.1.16

6 years ago

1.1.15

6 years ago

1.1.14

6 years ago

1.1.10

6 years ago

1.1.9

6 years ago

1.1.8

6 years ago

1.1.7

6 years ago

1.1.6

6 years ago

1.1.5

6 years ago

1.1.4

6 years ago

1.1.4-alpha.5

6 years ago

1.1.4-alpha.4

6 years ago

1.1.4-alpha.3

6 years ago

1.1.4-alpha.1

6 years ago

1.1.4-alpha.0

6 years ago

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago