Skip to content

Commit

Permalink
chore: sync with fork source
Browse files Browse the repository at this point in the history
  • Loading branch information
thomaschampagne committed Jan 21, 2024
1 parent 5f7ead7 commit b333406
Show file tree
Hide file tree
Showing 6 changed files with 1,363 additions and 1,156 deletions.
41 changes: 0 additions & 41 deletions .vscode/settings.json

This file was deleted.

36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# starter-ts

> **Note**:
> Replace `starter-ts`, `_description_` and `thomaschampagne` globally to use this template.
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
Expand All @@ -12,6 +9,7 @@
<!-- toc -->

- [Introduction](#introduction)
- [Package description](#package-description)
- [Install](#install)
- [Usage](#usage)
- [Development](#development)
Expand All @@ -24,6 +22,7 @@
- [Integrate library](#integrate-library)
- [Appendix](#appendix)
- [Update the table of content of this readme](#update-the-table-of-content-of-this-readme)
- [License](#license)

<!-- tocstop -->

Expand All @@ -37,7 +36,7 @@ Looking to create a TypeScript library? You can use this repository as a starter
- Auto update of library dependencies.
- `Husky` in place of `simple-git-hooks` as pre-commit linting validator

For demonstration purposes, I included a password generator called `Sesame` in this starter library.
For demonstration purposes, I included a password generator called `Sesame` in this starter library.

To get started, simply replace the content in these 2 files with your own code:

Expand All @@ -46,13 +45,17 @@ To get started, simply replace the content in these 2 files with your own code:

Happy coding 🙂 !

## Package description

`_description_`

## Install

```bash
npm install your-package-name
```

Replace `your-package-name` with yours.
> Replace `your-package-name`, `starter-ts`, `_description_` and `thomaschampagne` globally to use this template.
## Usage

Expand All @@ -69,7 +72,7 @@ Replace this usage with yours.

### Setup

- Install the latest version of [pnpm](https://pnpm.io/) globally
- Install the latest version of [pnpm](https://pnpm.io/) globally

```bash
npm uninstall -g pnpm
Expand Down Expand Up @@ -134,7 +137,6 @@ Run common tasks all-in-once:
- Update `README.md` table of content
- Generate documentation


```bash
pnpm run integrate
```
Expand All @@ -149,17 +151,17 @@ pnpm run readme:toc

## License

[MIT](./LICENSE) License © 2023-PRESENT [Anthony Fu](https://github.com/antfu)
[MIT](./LICENSE) License © 2023-PRESENT [Anthony Fu](https://github.com/thomaschampagne)

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/pkg-placeholder?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/pkg-placeholder
[npm-downloads-src]: https://img.shields.io/npm/dm/pkg-placeholder?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/pkg-placeholder
[bundle-src]: https://img.shields.io/bundlephobia/minzip/pkg-placeholder?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=pkg-placeholder
[license-src]: https://img.shields.io/github/license/antfu/pkg-placeholder.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/antfu/pkg-placeholder/blob/main/LICENSE
[npm-version-src]: https://img.shields.io/npm/v/starter-ts?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/starter-ts
[npm-downloads-src]: https://img.shields.io/npm/dm/starter-ts?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/starter-ts
[bundle-src]: https://img.shields.io/bundlephobia/minzip/starter-ts?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=starter-ts
[license-src]: https://img.shields.io/github/license/thomaschampagne/starter-ts.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/thomaschampagne/starter-ts/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/pkg-placeholder
[jsdocs-href]: https://www.jsdocs.io/package/starter-ts
15 changes: 0 additions & 15 deletions eslint.config.js

This file was deleted.

30 changes: 15 additions & 15 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "starter-ts",
"type": "module",
"version": "0.1.0",
"packageManager": "pnpm@8.7.4",
"packageManager": "pnpm@8.14.1",
"description": "",
"author": "Thomas Champagne <[email protected]>",
"license": "MIT",
Expand Down Expand Up @@ -53,22 +53,22 @@
"prepare": "husky install"
},
"devDependencies": {
"@types/node": "^20.6.0",
"@typescript-eslint/eslint-plugin": "^6.6.0",
"@typescript-eslint/parser": "^6.6.0",
"bumpp": "^9.2.0",
"eslint": "^8.49.0",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-prettier": "^5.0.0",
"@types/node": "^20.11.5",
"@typescript-eslint/eslint-plugin": "^6.19.0",
"@typescript-eslint/parser": "^6.19.0",
"bumpp": "^9.3.0",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.1.3",
"husky": "^8.0.3",
"markdown-toc-gen": "^1.0.1",
"pnpm": "^8.7.4",
"prettier": "^3.0.3",
"tsx": "^3.12.8",
"typedoc": "^0.25.1",
"typescript": "^5.2.2",
"pnpm": "^8.14.1",
"prettier": "^3.2.4",
"tsx": "^4.7.0",
"typedoc": "^0.25.7",
"typescript": "^5.3.3",
"unbuild": "^2.0.0",
"vite": "^4.4.9",
"vitest": "^0.34.4"
"vite": "^5.0.12",
"vitest": "^1.2.1"
}
}
Loading

0 comments on commit b333406

Please sign in to comment.