@kcws/web-rig

Web-rig

Typescript

Using Typescript module in heft to build and compile typescript via TypescriptTask (source).

• tsconfig.json - tsconfig used for compile project
• typescript.json - custom typescript config used by heft for addition feature

Output

This will generate output on multiple directories,

• lib - a main directory contains compiled code.

• commonjs (.js) - compiled code using commonjs type.
• esmodule (.mjs) - compiled code using esmodule/es5 type.
• mapping (.js.map or .mjs.map) - file mapping for commonjs or esmodule.
• typings (.d.ts) - typescript definition created by tsc cli.

• dist - a main typescript definition single file. it's separated to 4 files.

• index.d.ts is a aggregated type of a project.
• index-alpha.d.ts is a alpha-only type of a project.
• index-beta.d.ts is a beta-only type of a project.
• index-public.d.ts is a public-only type of a project.

• lib-umd - a compiled umd code.

notes: library using this rig will requires client to install 'tslib' package. This is to reduce package size on production build

Jest

Using heft-jest-plugin module to configure jest. There are several config we overwritten to meet our need.

• Enabled code coverage by default
• Produce lcov report for analysis code coverage at sonarcloud
• Produce html report for test result using jest-html-reporters
• Produce junit report for test result using jest-junit

Scss

We didn't test this yet, it may or may not works as we expected

Using heft-sass-plugin module to generate css and build type definition.