pacote_web

A very opiniated TypeScript Node package template that fits my own taste and workflow

Features

These are the things you get if you use this template:

1. Clean base Node.js project built entirely with TypeScript ES6
2. Support for hot-reloading and swc compilation
3. Support for tree-shaking using esbuild
4. Support for CommonJS, type declaration files (.d.ts) and source-maps
5. Linting and formatting with ESLint + Prettier
6. Git Client hooks to enforce codestyle before pushing changes
7. Unit testing with Jest
8. Support for package versioning with changesets + automatic publish with GitHub actions

Usage

mason make pacote_web --name <package_name> --description <package_description> --author <package_author> --type <standalone|library> --hotreload <true|false> --license <MIT|GNUGPLV3|none>

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add pacote_web

# Install globally
mason add -g pacote_web

Usage 🚀

mason make pacote_web

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.26 <0.1.0"

0.1.6

• fix: set package type as module
• chore: replace swc with esbuild

0.1.5

• chore: manual bump

0.1.4

• fix: module entrypoint not pointing to ecmascript module

0.1.3

• Add support for keywords definition
• Fix example project not resolving dependencies for libraries on Windows
• Remove .changeset folder from standalone program bundle
• Fix publish-docs workflow not being triggered after package publish
• Git Client Hooks are now installed after brick generation
• Add bin program support for packages
• Automatically remove unused imports on lint
• Improve developers onboarding experience

0.1.2

• Cleanup jest.config.ts
• Fix Jest running tests outside of src directory (e.g., bin)
• Run npm install on example folder after package generation

0.1.1

• Fix swc only compiling index.ts
• Add support for typedocs
• Fix mason trying to render GitHub Actions Workflows variables
• Added support for publishing as an organization

0.1.0+1

• Release first version of pacote-web-
• Add support for:
  • Clean base Node.js project built entirely with TypeScript ES6
  • Support for hot-reloading and swc compilation
  • Support for tree-shaking using esbuild
  • Support for CommonJS, type declaration files (.d.ts) and source-maps
  • Linting and formatting with ESLint + Prettier
  • Git Client hooks to enforce codestyle before pushing changes
  • Unit testing with Jest
  • Support for package versioning with changesets + automatic publish with GitHub actions

MIT License

Copyright (c) 2023 dart-pacotes

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.