simple-starter v0.0.1

Simple Starter

This is a starter project for publishing a simple Typescript module.

Features

• Test runner, examples, and useful github actions
• Publishing commands
• Easy to use instructions (I hope others agree)
• It was initially based on this article: https://onderonur.netlify.app/blog/creating-a-typescript-library-with-vite/

Usage

1. Setup

   git clone
   # Search replace all instances of "simple-starter" with your module project name.

2. To Build

   yarn build

3. To Watch/Auto-rebuild

   yarn dev

4. To Test

   yarn test

5. To publish (dry-run)

   npm pack --dry-run

6. To publish
   • TODO: Add instructions

Warning

If you found this via npmjs.org, go to the github repo. This repo publishes itself for demonstration purposes to npm, it is not itself useful. You can test that it works though by including it. It should properly include types, export two functions, work with Typescript and Javascript codebases, and be able to use in a project via import or require().

yarn add simple-starter

To test, include it and call the functions in a test file. Eg.

// In test.ts
import { sum, subtract } from "simple-starter";

console.log(sum(1, 2));
console.log(subtract(8, 3));

This should output:

3
5

TODO:

• This project should be turned into a yarn create style approach, instead of a clone/fork approach.