https://github.com/ragrag/moshimosh

A hybrid TypeScript Node package creator
https://github.com/ragrag/moshimosh

Last synced: about 5 hours ago
JSON representation

A hybrid TypeScript Node package creator

• Host: GitHub
• URL: https://github.com/ragrag/moshimosh
• Owner: ragrag
• License: mit
• Created: 2024-07-28T22:25:00.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-08-02T21:34:21.000Z (4 months ago)
• Last Synced: 2024-11-16T12:35:45.607Z (26 days ago)
• Language: TypeScript
• Homepage:
• Size: 250 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• stars - moshimosh
• stars - moshimosh

README

        






## About

**moshimosh ≽^•༚•🎀≼** _(moshi-mosh)_ is a hybrid (esm/cjs) TypeScript Node package creator, with modern tooling, typedef docs generation and sensible defaults that just works

## Usage

```bash

npx moshimosh

```

### Whats included

- Hybrid ESM/CJS by [tshy](https://github.com/isaacs/tshy) that just works

- Test and Coverage with [vitest](https://vitest.dev/)

- Linting/Formatting with [Biome](https://biomejs.dev/)

- Linting/Formatting Git Pre-commit hooks with [lefthook](https://github.com/evilmartians/lefthook)

- Documentation generation from typedefs with [typedoc](https://typedoc.org/)

- Github action for building and testing

- Github action for updating docs in a GitHub Pages github.io repo

### Included npm scripts

- `prepare` - builds the package to dist emitting both ESM and CJS entrypoints

- `test` - runs tests and generates coverage reports

- `docs:gen` - generates documentation from built typescript .d.ts files

- `lint` - lints and formats files with Biome

- `lint:ci` - runs lint and formatting checks without auto-fixing (for ci)

- `githooks:install` - sets up linting and formatting pre-commit githooks with lefthook (run only once)