1.1.173 • Published 3 years ago

@stencila/typescript-boilerplate v1.1.173

Weekly downloads
241
License
Apache-2.0
Repository
github
Last release
3 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

3 years ago

1.1.172

3 years ago

1.1.171

3 years ago

1.1.170

3 years ago

1.1.169

3 years ago

1.1.168

3 years ago

1.1.167

3 years ago

1.1.166

3 years ago

1.1.165

3 years ago

1.1.164

3 years ago

1.1.163

3 years ago

1.1.162

3 years ago

1.1.161

3 years ago

1.1.160

3 years ago

1.1.159

3 years ago

1.1.158

3 years ago

1.1.157

3 years ago

1.1.156

3 years ago

1.1.155

3 years ago

1.1.154

3 years ago

1.1.153

3 years ago

1.1.152

3 years ago

1.1.151

3 years ago

1.1.149

3 years ago

1.1.150

3 years ago

1.1.148

3 years ago

1.1.147

3 years ago

1.1.144

3 years ago

1.1.146

3 years ago

1.1.145

3 years ago

1.1.143

3 years ago

1.1.142

3 years ago

1.1.141

3 years ago

1.1.140

3 years ago

1.1.139

3 years ago

1.1.138

3 years ago

1.1.137

3 years ago

1.1.136

3 years ago

1.1.135

3 years ago

1.1.134

3 years ago

1.1.133

3 years ago

1.1.132

3 years ago

1.1.131

3 years ago

1.1.130

3 years ago

1.1.129

3 years ago

1.1.128

3 years ago

1.1.127

4 years ago

1.1.126

4 years ago

1.1.125

4 years ago

1.1.122

4 years ago

1.1.124

4 years ago

1.1.123

4 years ago

1.1.121

4 years ago

1.1.120

4 years ago

1.1.119

4 years ago

1.1.118

4 years ago

1.1.117

4 years ago

1.1.116

4 years ago

1.1.115

4 years ago

1.1.114

4 years ago

1.1.113

4 years ago

1.1.112

4 years ago

1.1.111

4 years ago

1.1.110

4 years ago

1.1.109

4 years ago

1.1.108

4 years ago

1.1.107

4 years ago

1.1.106

4 years ago

1.1.105

4 years ago

1.1.104

4 years ago

1.1.103

4 years ago

1.1.102

4 years ago

1.1.101

4 years ago

1.1.100

4 years ago

1.1.99

4 years ago

1.1.98

4 years ago

1.1.96

4 years ago

1.1.97

4 years ago

1.1.95

4 years ago

1.1.94

4 years ago

1.1.93

4 years ago

1.1.92

4 years ago

1.1.89

4 years ago

1.1.91

4 years ago

1.1.90

4 years ago

1.1.88

4 years ago

1.1.87

4 years ago

1.1.86

4 years ago

1.1.85

4 years ago

1.1.84

4 years ago

1.1.83

4 years ago

1.1.82

4 years ago

1.1.78

4 years ago

1.1.79

4 years ago

1.1.81

4 years ago

1.1.80

4 years ago

1.1.77

4 years ago

1.1.76

4 years ago

1.1.74

4 years ago

1.1.73

4 years ago

1.1.75

4 years ago

1.1.72

4 years ago

1.1.70

4 years ago

1.1.71

4 years ago

1.1.69

4 years ago

1.1.68

4 years ago

1.1.67

4 years ago

1.1.66

4 years ago

1.1.65

4 years ago

1.1.64

4 years ago

1.1.63

4 years ago

1.1.59

4 years ago

1.1.58

4 years ago

1.1.62

4 years ago

1.1.61

4 years ago

1.1.60

4 years ago

1.1.56

4 years ago

1.1.55

4 years ago

1.1.57

4 years ago

1.1.52

4 years ago

1.1.51

4 years ago

1.1.54

4 years ago

1.1.53

4 years ago

1.1.50

4 years ago

1.1.49

4 years ago

1.1.48

4 years ago

1.1.47

4 years ago

1.1.45

4 years ago

1.1.46

4 years ago

1.1.44

4 years ago

1.1.43

4 years ago

1.1.39

4 years ago

1.1.41

4 years ago

1.1.40

4 years ago

1.1.42

4 years ago

1.1.38

4 years ago

1.1.37

4 years ago

1.1.36

4 years ago

1.1.35

4 years ago

1.1.34

4 years ago

1.1.33

4 years ago

1.1.32

4 years ago

1.1.31

4 years ago

1.1.29

4 years ago

1.1.28

4 years ago

1.1.30

4 years ago

1.1.27

4 years ago

1.1.26

4 years ago

1.1.25

4 years ago

1.1.24

4 years ago

1.1.23

4 years ago

1.1.22

4 years ago

1.1.21

4 years ago

1.1.20

4 years ago

1.1.19

4 years ago

1.1.18

4 years ago

1.1.17

4 years ago

1.1.16

4 years ago

1.1.15

4 years ago

1.1.14

4 years ago

1.1.10

4 years ago

1.1.9

5 years ago

1.1.8

5 years ago

1.1.7

5 years ago

1.1.6

5 years ago

1.1.5

5 years ago

1.1.4

5 years ago

1.1.4-alpha.5

5 years ago

1.1.4-alpha.4

5 years ago

1.1.4-alpha.3

5 years ago

1.1.4-alpha.1

5 years ago

1.1.4-alpha.0

5 years ago

1.1.3

5 years ago

1.1.2

5 years ago

1.1.1

5 years ago