https://github.com/5h1ngy/bl-rollup-node-typescript
An advanced boilerplate for Node.js libraries with TypeScript and Rollup. Perfect for creating optimized, typed TypeScript packages ready for distribution.
https://github.com/5h1ngy/bl-rollup-node-typescript
bundler documentation es-modules library node npm-package offline-first rollup typescript
Last synced: 6 months ago
JSON representation
An advanced boilerplate for Node.js libraries with TypeScript and Rollup. Perfect for creating optimized, typed TypeScript packages ready for distribution.
- Host: GitHub
- URL: https://github.com/5h1ngy/bl-rollup-node-typescript
- Owner: 5h1ngy
- Created: 2025-04-01T02:43:55.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T03:11:18.000Z (6 months ago)
- Last Synced: 2025-04-01T04:21:43.903Z (6 months ago)
- Topics: bundler, documentation, es-modules, library, node, npm-package, offline-first, rollup, typescript
- Language: JavaScript
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Rollup-TSX
An advanced boilerplate for Node.js libraries with TypeScript and Rollup. Perfect for creating optimized, typed TypeScript packages ready for distribution.
**Topics:** `node` `typescript` `rollup` `library` `npm-package` `bundler` `es-modules` `offline-first` `documentation`
## 📋 Table of Contents
- [Features](#-features)
- [Project Structure](#-project-structure)
- [Project Setup](#-project-setup)
- [Development](#-development)
- [Build](#-build)
- [Package Managers](#-package-managers)
- [Resources](#-resources)
## ✨ Features
- 📦 Optimized bundling with Rollup
- 🔒 Type safety with TypeScript
- 🔍 TypeScript linting with ESLint
- 🎨 Code formatting with Prettier
- 🧪 Testing with Jest and TS-Jest
- 📤 Support for ES Modules import/export
- 💾 100% offline functionality
- 🔄 Support for hot-reload during development
- 📊 Tools for documentation generation
- 📝 TypeScript type declarations (.d.ts)
## 🗂️ Project Structure
```
bl-rollup-node-typescript/
├── dist/ # Output directory for the bundle
├── src/ # TypeScript source code
│ ├── index.ts # Main entry point
│ └── lib/ # Library modules and functionality
├── test/ # Test files
├── .eslintrc # ESLint configuration
├── rollup.config.js # Rollup configuration
├── jest.config.js # Jest configuration
├── tsconfig.json # TypeScript configuration
└── package.json # Project dependencies and scripts
```
## 🚀 Project Setup
### 📥 Install
```bash
$ pnpm install
```
## 🔧 Development
```bash
$ pnpm dev
```
## 📦 Build
```bash
$ pnpm build
```
## 📦 Package Managers
This project supports multiple package managers. Here's how to use each one:
### NPM
NPM is the default package manager for Node.js.
**Install NPM:**
```bash
# Included with Node.js installation
```
**Setup project with NPM:**
```bash
# Install dependencies
$ npm install
# Development mode
$ npm run dev
# Build the library
$ npm run build
```
**Key features:**
- 📚 Vast package ecosystem
- 🔒 Hierarchical node_modules structure
- 📋 Package.json for dependency management
### Yarn
Yarn is a fast, reliable, and secure alternative to NPM.
**Install Yarn:**
```bash
# Install using NPM
$ npm install -g yarn
```
**Setup project with Yarn:**
```bash
# Install dependencies
$ yarn
# Development mode
$ yarn dev
# Build the library
$ yarn build
```
**Key features:**
- ⚡ Faster installation speeds
- 📦 Offline caching
- 🔒 Better security with checksums
- 📋 yarn.lock for deterministic installations
### PNPM
PNPM is a disk-space efficient package manager.
**Install PNPM:**
```bash
# Install using NPM
$ npm install -g pnpm
```
**Setup project with PNPM:**
```bash
# Install dependencies
$ pnpm install
# Development mode
$ pnpm dev
# Build the library
$ pnpm build
```
**Key features:**
- 💾 Disk space savings through symlinks
- 🚀 Fast installation speeds
- 🔄 Content-addressable storage
- 📋 pnpm-lock.yaml for dependency lock
### Comparison
| Feature | NPM | Yarn | PNPM |
|-----------------------|---------|---------|---------|
| Disk usage | High | High | Low |
| Installation speed | Slow | Fast | Fastest |
| Parallel installations| Limited | Yes | Yes |
| Workspace support | Limited | Good | Best |
| Offline mode | Limited | Good | Good |
| Security | Good | Better | Better |
## 📚 Resources
- [Node.js Documentation](https://nodejs.org/en/docs/)
- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
- [Rollup Documentation](https://rollupjs.org/guide/en/)
- [NPM Documentation](https://docs.npmjs.com/)
- [Yarn Documentation](https://yarnpkg.com/getting-started)
- [PNPM Documentation](https://pnpm.io/motivation)