https://github.com/streetsidesoftware/template-typescript-cli-app
A Repository Template for TypeScript Command Line Applications / Tools
https://github.com/streetsidesoftware/template-typescript-cli-app
Last synced: 30 days ago
JSON representation
A Repository Template for TypeScript Command Line Applications / Tools
- Host: GitHub
- URL: https://github.com/streetsidesoftware/template-typescript-cli-app
- Owner: streetsidesoftware
- License: mit
- Created: 2023-01-03T12:17:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T12:02:15.000Z (over 1 year ago)
- Last Synced: 2024-10-29T14:33:39.782Z (over 1 year ago)
- Language: TypeScript
- Size: 403 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# template-typescript-cli-app
A Repository Template for TypeScript Command Line Applications / Tools
This is a simple command line tool that lists files matching the provided globs.
## Getting Started
1. Install [`pnpm`](https://pnppm.io)
1. `pnpm i`
1. `pnpm test`
1. `pnpm run app --help`
```
Usage: list-files [options]
List Files
Arguments:
files Files to scan for injected content.
Options:
--no-must-find-files No error if files are not found.
--cwd Current Directory
--color Force color.
--no-color Do not use color.
-V, --version output the version number
-h, --help display help for command
```
1. `pnpm run app "*"`
**Example:**
```
Find Files:
- LICENSE
- README.md
- bin.mjs
- coverage
- cspell.config.yaml
- dist
- package.json
- pnpm-lock.yaml
- release-please-config.json
- scripts
- src
- static
- tsconfig.json
- vitest.config.ts
done.
```
## `pnpm` - this template uses pnpm.
See: https://pnpm.io/
## `vitest` - this template uses ViTest for testing.
See: https://vitest.dev/
## ES Modules
This tools is setup to use ES Modules.
## GitHub Workflows
This template includes GitHub Workflows for:
- testing
- code coverage
- lint
- release please (for generating releases)
- CodeQL