Usage

Configure a typescript-based project with linting and testing.

The project expects a folder ./src with project source files and a folder ./tests with tests in project root.

Configuration

Configure typescript,

Configure typescipt

tsconfig.json

{
  "extends": "./node_modules/@suprcrew/project-config/configs/tsconfig.base.json"
}

Usage:

./node_modules/typescript/bin/tsc

Configure linting

.eslintrc.js

module.exports = {
  extends: './node_modules/@jungehaie/se-config/dist/setup_se_development/eslintrc.js'
}

dev dependencies

• @typescript-eslint/eslint-plugin
• @typescript-eslint/parser
• eslint
• eslint-config-airbnb-base
• eslint-config-airbnb-typescript
• eslint-plugin-import

Usage

./node_modules/eslint/bin/eslint.js --color './src/**/*.ts'

Configure testing framework

jest.config.js

const config = require('./node_modules/@suprcrew/project-config/configs/jest.config.js');

module.exports = {
  ...config,
  "rootDir": "./"
}

Usage:

./node_modules/jest/bin/jest.js tests

Extend package.json

You may configure following scripts to use them via npm script runner npm run <name>.

{
  "lint": "./node_modules/eslint/bin/eslint.js --color './src/**/*.ts",
  "test:run": "./node_modules/jest/bin/jest.js tests",
  "test:watch": "./node_modules/jest/bin/jest.js tests --watch",
  "test:coverage": "./node_modules/jest/bin/jest.js tests --coverage",
  "test:watch:coverage": "./node_modules/jest/bin/jest.js tests --watch --coverage",
  "test": "npm run lint; npm run test:run",
  "build": "rm -rf ./build && npm run lint && npm run test && ./node_modules/typescript/bin/tsc"
}

Create project from template

Create a new project from our base template with configuration done.

Setup

npm i -g create-project

Install

npx create-project your-project-name suprcrew/project-template

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Deployment

Only maintainers are allowed to deploy new versions!

1. Run npm run release which will update changelog, package version and creates a publishes a release and push everything to master.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Marco Bunge
• All Contributors

License

The MIT License (MIT). Please see License File for more information.