Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uncenter/templates
🏗️ Templates/starter files.
https://github.com/uncenter/templates
Last synced: 30 days ago
JSON representation
🏗️ Templates/starter files.
- Host: GitHub
- URL: https://github.com/uncenter/templates
- Owner: uncenter
- License: cc0-1.0
- Created: 2023-05-14T04:14:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-20T17:00:47.000Z (7 months ago)
- Last Synced: 2024-10-04T08:40:54.416Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 696 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Templates
- [rust-cli](#rust-cli)
- [typescript-cli](#typescript-cli)
- [typescript-package](#typescript-package)
- [commonjs-package](#commonjs-package)
## `rust-cli`
[[source](templates/rust-cli/)]
A simple template for getting a Rust CLI up-and-running as fast as possible.
### Setup
```sh
# Download the rust-cli template into the directory
# with one of the commands below:
npx giget@latest gh:uncenter/templates/templates/rust-cli
pnpm dlx giget@latest gh:uncenter/templates/templates/rust-cli
bunx giget@latest gh:uncenter/templates/templates/rust-cli
# Enter the template directory and install dependencies:
cd
cargo build
```
### Features
Includes [clap](https://github.com/clap-rs/clap) for argument parsing.
### Linting
Uses [Clippy](https://rust-lang.github.io/rust-clippy/) with `pedantic = "warn"`.
### Formatting
Uses [rustfmt](https://rust-lang.github.io/rustfmt/) and a `.editorconfig` file.
### Other
Workflows for building, linting, and releasing are in `.github/workflows/`.
## `typescript-cli`
[[source](templates/typescript-cli/)]
A very opinionated TypeScript template for building CLI packages.
### Setup
```sh
# Download the typescript-cli template into the directory
# with one of the commands below:
npx giget@latest gh:uncenter/templates/templates/typescript-cli
pnpm dlx giget@latest gh:uncenter/templates/templates/typescript-cli
bunx giget@latest gh:uncenter/templates/templates/typescript-cli
# Enter the template directory and install dependencies:
cd
pnpm install
```
### Building
Uses [unbuild](https://github.com/unjs/unbuild), which utilizes [rollup](https://rollupjs.org/) and [esbuild](https://github.com/evanw/esbuild) under the hood. Not the fastest option, but the only one so far that works out-of-the-box and is easy to configure.
### Linting
Uses [ESLint](https://eslint.org/) with [typescript-eslint](https://typescript-eslint.io/), [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) to disable conflicting eslint style rules, [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import) for opinionated import sorting, and [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn) to enforce good practices.
### Formatting
Uses [Prettier](https://prettier.io/) and a `.editorconfig` file.
### Other
All of this is managed with [pnpm](https://pnpm.io/). Workflows for building, linting, testing, and releasing are in `.github/workflows/`.
## `typescript-package`
[[source](templates/typescript-package/)]
A ready-to-go TypeScript package template with building, testing, linting, and formatting already setup.
### Setup
```sh
# Download the typescript-package template into the directory
# with one of the commands below:
npx giget@latest gh:uncenter/templates/templates/typescript-package
pnpm dlx giget@latest gh:uncenter/templates/templates/typescript-package
bunx giget@latest gh:uncenter/templates/templates/typescript-package
# Enter the template directory and install dependencies:
cd
pnpm install
```
### Building
Uses [unbuild](https://github.com/unjs/unbuild), which utilizes [rollup](https://rollupjs.org/) and [esbuild](https://github.com/evanw/esbuild) under the hood. Not the fastest option, but the only one so far that works out-of-the-box and is easy to configure.
### Testing
Uses [Vitest](https://vitest.dev/).
### Linting
Uses [ESLint](https://eslint.org/) with [typescript-eslint](https://typescript-eslint.io/), [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) to disable conflicting eslint style rules, [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import) for opinionated import sorting, [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn) to enforce good practices, and [`eslint-plugin-vitest`](https://github.com/veritem/eslint-plugin-vitest) to keep tests consistent.
### Formatting
Uses [Prettier](https://prettier.io/) and a `.editorconfig` file.
### Other
All of this is managed with [pnpm](https://pnpm.io/). Workflows for building, linting, testing, and releasing are in `.github/workflows/`.
## `commonjs-package`
[[source](templates/commonjs-package/)]
A ready-to-go CJS package template.
### Setup
```sh
# Download the commonjs-package template into the directory
# with one of the commands below:
npx giget@latest gh:uncenter/templates/templates/commonjs-package
pnpm dlx giget@latest gh:uncenter/templates/templates/commonjs-package
bunx giget@latest gh:uncenter/templates/templates/commonjs-package
# Enter the template directory and install dependencies:
cd
pnpm install
```
### Testing
Uses [Vitest](https://vitest.dev/) (in MJS files).
### Linting
Uses [ESLint](https://eslint.org/) with [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) to disable conflicting eslint style rules, [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import) for opinionated import sorting, [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn) to enforce good practices, and [`eslint-plugin-vitest`](https://github.com/veritem/eslint-plugin-vitest) to keep tests consistent.
### Formatting
Uses [Prettier](https://prettier.io/) and a `.editorconfig` file.
### Other
All of this is managed with [pnpm](https://pnpm.io/). Workflows for linting, testing, and releasing are in `.github/workflows/`.