https://github.com/tylim88/ts-hajime

Delightfully bootstraps TypeScript npm libraries.
https://github.com/tylim88/ts-hajime

bootstrap npm-package typescript

Last synced: about 1 month ago
JSON representation

Delightfully bootstraps TypeScript npm libraries.

• Host: GitHub
• URL: https://github.com/tylim88/ts-hajime
• Owner: tylim88
• License: mit
• Created: 2024-10-10T06:23:06.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2025-02-05T09:07:06.000Z (4 months ago)
• Last Synced: 2025-04-14T21:14:09.958Z (about 1 month ago)
• Topics: bootstrap, npm-package, typescript
• Language: JavaScript
• Homepage:
• Size: 318 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TS-Hajime 🌸

Effortlessly bootstrap strongly-typed TypeScript npm libraries with minimal configuration and a focus on developer experience.

## 🌟 Features

- **Minimal Setup & Visual Clarity**: Enjoy sensible defaults that keep your project setup clean.

- **Developer-Centric**: Built with tools like `pkgroll`, `tsx`, `tsup`, `vitest`, and `cac`.

- **Comprehensive Configurations**:

  - Preconfigured `tsconfig`, `eslint`, `vitest`, `prettier`, `package.json`, and `.gitignore` files.

  - Ready-to-use GitHub Actions, pre-commit hooks, and npm scripts.

  - Examples and tests included for both library code and `npx` commands.

- **TypeScript npx Commands**: Write `npx` commands directly in TypeScript.

- **ESM & CJS Support**: Outputs both ESM and CJS modules.

- **Optimized for VSCode**: Pre-configured with file nesting, auto-prettify on save, and a specified TypeScript TSDK path.

- **Fully Customizable**: Exposed configurations allow for complete customization to fit your needs.

## 🚀 Getting Started

1. Run the command below to bootstrap your project:

   ```bash

   npx ts-hajime your-app-name-here

   ```

Here’s what your project structure will look like:

![Folder Structure](./img.png)

2. Replace all occurrences of `my-app` with your app’s name, and `my-description` with a description.

## ⚙️ Key Commands

- **Build**: `npm run build`

- **Test**: `npm test`

- **Lint & Fix**: `npm run lint`

- **Type Check**: `npm run tsc`  

  _(Note: Type checking is automatically done in GitHub Actions as part of the build step with `pkgroll`.)_

- **Try `npx` Command Locally**: `npm run npx something`  

  _(Modify the `npx` script in `package.json` to suit your project requirements.)_

Enjoy coding! 🌸