Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alioguzhan/typescript-library-template
Ready to use template to start a Typescript library
https://github.com/alioguzhan/typescript-library-template
Last synced: 3 months ago
JSON representation
Ready to use template to start a Typescript library
- Host: GitHub
- URL: https://github.com/alioguzhan/typescript-library-template
- Owner: alioguzhan
- Created: 2019-12-26T08:49:31.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-21T13:59:33.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T19:32:43.078Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 816 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# typescript-library-template
## Install
### Github Users
Since this is a `template repository`, you can use that green `Use this template` button to start a new repository from this template.
> Do not forget to remove `CHANGELOG.md` file and update the `change__here` values in several files. You can also remove this README file.
### Non-Github Users
Clone the repository:
```bash
git clone --depth 1 [email protected]:alioguzhan/typescript-library-template.git
```
Install the deps:
```bash
yarn install
```
If you want to change or remove some parts of this template, do it before start development.
Once you feel ready, remove the `.git` folder and start a new one:
```bash
rm -rf .git && git init
```
> You can check if there are any outdated package with [npm-check-updates](https://www.npmjs.com/package/npm-check-updates) tool.
> Do not forget to remove `CHANGELOG.md` file and update the `change__here` values in several files. You can also remove this README file.
## Development
> NOTE: There are a couple of places that you need to change before start. Open `package.json` file replace any `change__here` with your values.
Write your library code to `index.ts` file and run:
```bash
yarn start
```
This will watch your changes and reloads the server.
### Commit Messages
This setup expects you to follow conventional-commits format. There is a husky command runs before every commit for validation.
To learn more about conventional commits see [its website](https://www.conventionalcommits.org/en/v1.0.0/).
You can remove that section from `package.json` also remove the related packages:
```bash
yarn remove -D husky @commitlint/cli
```
## Build
Run:
```bash
yarn build
```
This will create your compiled files under `./dist` folder.
## Test
Jest is configured and ready to use. Just run:
```bash
yarn test
```
## Docs
This template uses [TypeDoc](https://typedoc.org/) by default.
Run `yarn make:docs` and a folder named `docs` will be created in your root directory. Just open `index.html` in your browser to see if your like it or not.