@tios/build

This module is modified from @loopback/build.

This module contains a set of common scripts and default configurations to build tios or other TypeScript modules, including:

• cx-tsc: Use tsc to compile typescript files
• cx-eslint: Run eslint
• cx-prettier: Run prettier
• cx-mocha: Run mocha to execute test cases
• cx-nyc: Run nyc

These scripts first try to locate the CLI from target project dependencies and fall back to bundled ones in @tios/build.

Basic use

To use @tios/build for your package:

1. Run the following command to add @tios/build as a dev dependency.

npm i @tios/build --save-dev

2. Configure your project package.json as follows:

"scripts": {
    "build": "cx-tsc",
    "build:watch": "cx-tsc --watch",
    "clean": "cx-clean",
    "lint": "npm run prettier:check && npm run eslint",
    "lint:fix": "npm run prettier:fix && npm run eslint:fix",
    "prettier:cli": "cx-prettier \"**/*.ts\" \"**/*.js\"",
    "prettier:check": "npm run prettier:cli -- -l",
    "prettier:fix": "npm run prettier:cli -- --write",
    "eslint": "cx-eslint --report-unused-disable-directives .",
    "eslint:fix": "npm run eslint -- --fix",
    "pretest": "npm run build",
    "test": "cx-mocha \"dist/__tests__\"",
    "posttest": "npm run lint",
    "start": "npm run build && node .",
    "prepublishOnly": "npm run test"
  },

Please remember to replace your-module-name with the name of your module.

Now you run the scripts, such as:

• npm run build - Compile TypeScript files and copy resources (non .ts files) to outDir
• npm test - Run all mocha tests
• npm run lint - Run eslint and prettier on source files

3. Override default configurations in your project

• cx-tsc

  By default, cx-tsc searches your project's root directory for tsconfig.build.json then tsconfig.json. If neither of them exists, a tsconfig.json will be created to extend from @tios/build/config/tsconfig.common.json.

  To customize the configuration:

  • Create tsconfig.build.json or tsconfig.json in your project's root directory

    {
      "$schema": "http://json.schemastore.org/tsconfig",
      "extends": "@tios/build/config/tsconfig.common.json",
      "compilerOptions": {
        "outDir": "dist",
        "rootDir": "src"
      },
      "include": ["src"]
    }

  • Set options explicity for the script

    cx-tsc -p tsconfig.json --target es2017 --outDir dist

    For more information, see https://www.typescriptlang.org/docs/handbook/compiler-options.html.

  • The following un-official compiler options are available:

    | Option | Description | | ------------------ | ------------------------------------------------------------------------------------------------- | | --copy-resources | Copy all non-typescript files from src and test to outDir, preserving their relative paths. |

4. Run builds

npm run build

Contributions

• Guidelines
• Join the team

Tests

run npm test from the root folder.

Contributors

See all contributors.

License

MIT