TS-Worker

!Libraries.io dependency status for latest release, scoped npm package

@K-FOSS/TS-Worker is a few small utilities for working with Threads and Workers in JS/TS/Node.JS

Usage

This is an ESModule and requires Node.JS 13.9 or newer

Install the module

``
npm install @k-foss/ts-worker
`

Checkout examples/TalkingWorker

Development

$3

Follow these steps to open this project in a container:

1. If this is your first time using a development container, please follow the getting started steps.

2. To use this repository, you can either open the repository in an isolated Docker volume:

- Press F1 and select the Remote-Containers: Open Repository in Container... command.
- Enter K-FOSS/TS-Worker
- The VS Code window (instance) will reload, clone the source code, and start building the dev container. A progress notification provides status updates.

Or open a locally cloned copy of the code:

- Clone this repository to your local filesystem.
- git clone https://github.com/K-FOSS/TS-Worker.git
- Open the project folder in Visual Studio Code.
- code ./TS-Worker
- Reopen in Container

- When you open the project folder in Visual Studio Code you should be prompted with a notification asking if you would like to reopen in container.

Or manually reopen

- Press F1 and select the "Remote-Containers: Open Folder in Container..." command.

#### TODO

TBD

$3

MUST HAVE NODE.JS v13.9 or newer

To try this out, clone repo

Install NPM modules

`
npm install
`

Run all tests under ./Testing/Tests/

`
npm test
`

All tests are run on all commits and PRs.

$3

This project currently uses Prettier for code styling and automatic formatting. Prettier is run on every commit and pull request.

Run Prettier

`
npm run prettier
`

$3

This project currently uses ESLint for code linting. ESLint is run on every commits and pull request.

Run ESLint

`
npm run lint
``

$3

Dependency Management for TS-Worker is handled by automated pull requests created by Dependabot. When new released of development Dependencies are released Dependabot automatically creates a pull request for upgrading to the new version. If the created pull request passes the GitHub Actions testing, prettier/styling, and linting I will merge the pull request.

$3

@K-FOSS/TS-Worker uses semantic-release to intelligently automate the creation of a changelog, automatic package publish to NPM, along with creating a GitHub release and tag.

Semantic-Release is currently configured to analyze commits with the Conventional Commits preset to determine if and how the package version should be incremented and if a release should be published, which is why it is important to mantain the Conventional Commits spec for all commits.