TS Hybrid Boilerplate

Another boilerplate for ts projects, especifically to ts npm packages

Description

A boiler plate that allow to generate TS hybrid packages with mjs and cjs

Build package

Simply run npm run build and hybrid package will be generate NOTE: Files under ./mjs will be reemplace lines with ".class" to ".class.js" to be compatible with browsers

Notes for MJS

For mjs with mjs-formatter.sh all is OK because exists top level await. Check index.ts to find out that import is with .js instead of file without extension

Notes for CJS

For cjs the process is to remove with cjs-formatter all top level awaits from index.js and use an eval to perform a require

As mjs find out that require is with .js

Example of import

Installation

npm i ts-hybrid-boilerplate

Import in ES6 (Node/Web)

import { HelloWorld } from 'ts-hybrid-boilerplate';

Import in CommonJS

const { HelloWorld } = require('ts-hybrid-boilerplate');

Release

At this moment package support github and gitlab CI/CD Configure env vars to handle it.

• NPM_TOKEN: Allow to deploy to npmjs.com configure .npmrc to push package to another package repository
• GH_TOKEN: Allow to modify repository to add tags with releases (GITHUB)
• GITLAB_TOKEN: Allo to modify repository to add tags with releases (GITLAB)

Below it uses semantic-release so the semantic-release guide is: https://github.com/semantic-release/semantic-release

NPM package to download and check compatibility

https://www.npmjs.com/package/ts-hybrid-boilerplate