Skip to content

Commit

Permalink
docs(README): rephrase user cases & tooling
Browse files Browse the repository at this point in the history
  • Loading branch information
dorayx committed Sep 2, 2023
1 parent 27ad6cb commit b0253fc
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
This template is opinionated, and it is not meant to be a one-size-fits-all solution.
It is meant to be a starting point for my personal projects to bootstrap development, as I like to create minimal viable products from time to time.

## User Cases

- ✅ TypeScript Application
- ❌ TypeScript Library
- ❌ UI Component Library

## Features

- ✅ TypeScript v5
Expand All @@ -13,12 +19,6 @@ It is meant to be a starting point for my personal projects to bootstrap develop
- ✅ GitHub Actions
- ❌ Monorepo

**Use Cases**

- ✅ TypeScript Application
- ❌ TypeScript Library
- ❌ UI Component Library

## Tooling

This template is configured with the following tools:
Expand All @@ -33,12 +33,12 @@ This template is configured with the following tools:
**Package Manager**

- [Yarn](https://yarnpkg.com/) _(v3)_
- Doc: [Zero-installs](https://www.npmjs.com/package/vite-tsconfig-paths)
- Doc: [Zero-installs](https://yarnpkg.com/features/caching#zero-installs)

**Testing**

- [Vitest](https://vitest.dev/)
- Convention: Unit tests for user cases are stored in the `tests/units` directory.
- Convention: Unit tests for user cases are stored in the `tests/units` directory
- Convention: Unit tests for individual functions are placed alongside their respective implementations ([In-source testing](https://vitest.dev/guide/in-source.html))
- Convention: The file `tests/setup.ts` is executed before each test file
- Convention: The `tests/tsconfig.json` file configures TypeScript for testing
Expand All @@ -54,11 +54,11 @@ This template is configured with the following tools:

**Code Generator**

- [Plop](https://plopjs.com/)
- [Plop](https://plopjs.com/): A micro-generator framework that makes it easy for an entire team to create files with a level of uniformity

**Publish**

- [semantic-release](https://semantic-release.gitbook.io/)
- [semantic-release](https://semantic-release.gitbook.io/): Fully automated version management and package publishing
- GitHub Action: `.github/workflows/release-package.yml`
- Env Variables: `NPM_TOKEN` is required to publish a package to the npm registry
- Additional Plugin: [semantic-release-yarn](https://github.com/hongaar/semantic-release-yarn)
Expand Down

0 comments on commit b0253fc

Please sign in to comment.