/your-node-v20-monoreopo-project

minecat template : Node.js

Primary LanguageJavaScriptMIT LicenseMIT

Your Node.js v20 Menoreopo Project

A PNPM monorepo template for Node.js v20 projects.

What is in this repository?

  • Tsup as a TypeScript universal package.
  • Tsx as a Node.js enhanced with esbuild to run TypeScript & ESM
  • Tsdoc as document
  • PNPM as workspace manager and package manager.
  • Vitest as a test runner，as type test instead of tsd
  • Size Limit as a size limit plugin.
  • Prettier as a code formatter.
  • ESLint as a code linter.
  • NX as cacheable operations.
  • Changesets as a way to manage changes and releases.
  • @vitest/coverage-v8 as coverage
  • supertest as server test
  • cypress as e2e test

Using this repository

  • clone the repository or click in "Use this template" button.
  • copy packages/lib to packages/yourlib and edit the name, description and author fields.

Folder structure

  • docs - An empty folder to store documentation.
  • example - A folder with an example project. Think as playground.
  • packages/* - A folder with a library.

Using Turbo to run commands

NX is a cacheable build tool (and Monorepo manager). This project uses it to run the build, test and coverage commands.

# Instead of running `pnpm build`, run:
nx run-many -t build

License

MIT @ npmstudy