👷🏽 TODO: This project is made with publish-ts, read the docs to learn more.

👷🏽 TODO: Read all the sections marked with "👷🏽 TODO", do them, and remove them from this README.

publish-ts-test

a test package for publish-ts

// a nice code example here
// would be pretty nice!

import { publishTsTest } from 'publish-ts-test'

console.log(publishTsTest().msg)

Contents

• Contents
• Installation
• Usage
• Contribution

Installation

Node:

npm i publish-ts-test

Browser / Deno:

import { publishTsTest } from 'https://esm.sh/publish-ts-test'

👷🏽 TODO: add the most important necessary imports from publish-ts-test here.

Usage

👷🏽 TODO: explain in details what publish-ts-test does.

// perhaps with some nice code examples.

import { publishTsTest } from 'publish-ts-test'

console.log(publishTsTest().msg)

Contribution

You need node, NPM to start and git to start.

# clone the code
git clone [email protected]:loreanvictor/publish-ts-test.git

# install stuff
npm i

Make sure all checks are successful on your PRs. This includes all tests passing, high code coverage, correct typings and abiding all the linting rules. The code is typed with TypeScript, Jest is used for testing and coverage reports, ESLint and TypeScript ESLint are used for linting. Subsequently, IDE integrations for TypeScript and ESLint would make your life much easier (for example, VSCode supports TypeScript out of the box and has this nice ESLint plugin), but you could also use the following commands:

# run tests
npm test

# check code coverage
npm run coverage

# run linter
npm run lint

# run type checker
npm run typecheck