https://github.com/hugodf/microbundle-ts-pkg

A TypeScript npm package skeleton/starter project with microbundle, node:test and prettier
https://github.com/hugodf/microbundle-ts-pkg

microbundle node-module nodejs prettier typescript typescript-library

Last synced: 3 months ago
JSON representation

A TypeScript npm package skeleton/starter project with microbundle, node:test and prettier

• Host: GitHub
• URL: https://github.com/hugodf/microbundle-ts-pkg
• Owner: HugoDF
• License: mit
• Created: 2020-05-03T08:56:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-30T02:07:21.000Z (over 1 year ago)
• Last Synced: 2024-10-11T12:11:37.813Z (3 months ago)
• Topics: microbundle, node-module, nodejs, prettier, typescript, typescript-library
• Language: JavaScript
• Homepage: https://codewithhugo.com/microbundle-typescript-npm-module/
• Size: 782 KB
• Stars: 20
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build](https://github.com/HugoDF/buttondown/workflows/Build%20&%20test/badge.svg)

microbundle-ts-pkg: A TypeScript npm package skeleton/starter project with microbundle, node:test and prettier

Comes with:

- [SAMPLE_README.md](./SAMPLE_README.md) and [USE_CASES.md](./USE_CASES.md) for documentation.

- [built-in `node:test` runner](https://nodejs.org/dist/latest-v18.x/docs/api/test.html) for testing (see [./tests](./tests))

- prettier for formatting

- microbundle for compiling TypeScript to UMD, ESM, CJS

## Requirements

- Node 18 (to run this repository, due to `node:test` usage)

- npm v7+

## Setup

1. Clone the repository

2. Run `npm install` installs all required dependencies.

3. Run `npm run build` to build from TypeScript to common JavaScript distribution formats.

4. Run `npm test` to run all tests.

## npm scripts

- `npm run test` run tests against **built output** with Node.js' native `node:test` module. **Important**: runs against build output so run `npm run build` beforehand.

- `npm run build` run build from TypeScript to UMD, CJS, ESM with [microbundle](https://github.com/developit/microbundle)

- `npm run watch` runs build in watch mode with [microbundle](https://github.com/developit/microbundle)

- `npm run lint` will ensure all of the files are prettier-formatted

- `npm run format` will run prettier formatting option on all the examples files (and tests).

- `npm run release`, run clean, production build and release with `np`.

# About

This package is maintained by Hugo from [Code with Hugo](https://codewithhugo.com) and [Alpine.js Weekly](https://alpinejs.codewithhugo.com/newsletter).

## Acknowledgments

Special thanks to:

- The developers behind

  - [microbundle](https://github.com/developit/microbundle#readme)

  - [np](https://github.com/sindresorhus/np#readme)

# LICENSE

Code is licensed under the [MIT License](./LICENSE).