DEV Community

Acid Coder
Acid Coder

Posted on

1

TS-Hajime: Effortlessly Bootstrap TypeScript NPM Libraries

I made a library that can easily bootstrap your TypeScript library with better DX tools. It focuses on minimal setup and visual clarity.

GitHub

Features:

  • Sensible defaults.
  • Built with DX tools like pkgroll, tsx, tsup, vitest, and clieye.
  • 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.
  • Write npx commands directly in TypeScript.
  • Outputs both ESM and CJS modules.
  • (VSCode)Pre-configured with file nesting, auto-prettify on save, and a specified TypeScript TSDK path.
  • Exposed configurations allow for complete customization to fit your needs.

To get started:

  1. Run the command below to bootstrap your project:
   npx ts-hajime your-app-name-here
Enter fullscreen mode Exit fullscreen mode

Here’s what your project structure will look like:

project structure

  1. 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.)

Remember to star it if you like it!

Image of Datadog

Create and maintain end-to-end frontend tests

Learn best practices on creating frontend tests, testing on-premise apps, integrating tests into your CI/CD pipeline, and using Datadog’s testing tunnel.

Download The Guide

Top comments (0)

Postmark Image

Speedy emails, satisfied customers

Are delayed transactional emails costing you user satisfaction? Postmark delivers your emails almost instantly, keeping your customers happy and connected.

Sign up