qwell / happy-ts

Sample repo for a happy Typescript and Yarn PnP environment.

Sample Repo for Yarn v2+, TypeScript, ESLint, Prettier, and VS Code

This repository demonstrates a simple setup using:

• VS Code
• TypeScript
• ESLint
• Prettier
• Yarn
  • Plug'n'Play (PnP)
  • editor SDKs
• Vitest

Table of Contents

• Prerequisites
• Setup
• Available Scripts
• Contributing
• License
• TODO

Prerequisites

• Visual Studio Code
• Node 20
• Yarn

Setup

Clone the repository and navigate to the directory.

git clone https://github.com/qwell/happy-ts.git

Navigate to the repo directory.

cd happy-ts

Install dependencies using Yarn.

yarn install

Available Scripts

• lint: Run ESLint to check for code quality issues.

yarn lint

• format: Run Prettier to format the code.

yarn format

• clean: Clean up generated artifacts (like the dist/ directory).

yarn clean

• build: Compile TypeScript files and output in the dist/ directory.

yarn build

• start: Execute the compiled dist/index.js.

yarn start

• test: Execute tests with Vitest.

yarn test

Contributing

If you'd like to contribute, pull requests and issues are always appreciated.

License

GPLv3

TODO

• Add Yarn workspaces/monorepo support (written, not yet committed).