https://github.com/shirtiny/ts-lib-template
A starter template for typescript npm library, base on esbuild/Parcel. 一个typescript 三方库模版，一键发布在npm，基于esbuild或Parcel，两者在不同的分支。
https://github.com/shirtiny/ts-lib-template
esbuild makefile parcel prettier starter starter-template template typescript typescript-library webpack
Last synced: 5 months ago
JSON representation
A starter template for typescript npm library, base on esbuild/Parcel. 一个typescript 三方库模版，一键发布在npm，基于esbuild或Parcel，两者在不同的分支。
- Host: GitHub
- URL: https://github.com/shirtiny/ts-lib-template
- Owner: Shirtiny
- License: mit
- Created: 2021-06-19T09:30:04.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T15:53:31.000Z (over 3 years ago)
- Last Synced: 2025-02-28T23:50:43.388Z (over 1 year ago)
- Topics: esbuild, makefile, parcel, prettier, starter, starter-template, template, typescript, typescript-library, webpack
- Language: TypeScript
- Homepage:
- Size: 333 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-lib-template
> [Ts-lib-template](https://github.com/Shirtiny/ts-lib-template) A starter template for typescript library.
```shell
# init project
yarn
# build
yarn build
# tag and version
make version
# publish to npm
make publish
# dev
yarn start
```
## Introduction
This is a template for typescript library base on esbuild/parcel. This template includes followings:
- TypeScript
- Esbuild / Parcel
- Makefile
- Dev server
- Env
- Prettier
- Eslint
- Jest
- Sass/scss & Autoprefixer
- Github action
## Usage
1. Create your repository by clicking 'Use this template' top of the page. Then, check the `Include all branches` option.
2. Select a branch and rename it as `main`, then mark that branch as `default` at github repository settings:
- `esbuild` This branch is based on Esbuild with a lot of customization.
- `parcel` This branch is based on Parcel, it's more simple and easy to understand.
- `main` Same as `esbuild`, but it will move to parcel when parcel is complete.
## Config
> This just an example, please refer to the content on the specific branch.
```js
// .sh.js
const { MY_ENV, PORT, NODE_ENV, npm_package_name } = process.env;
// the customized ENV， just pick what you need
const env = {
MY_ENV,
PORT,
NODE_ENV,
npm_package_name,
};
module.exports = {
// your lib global name
globalName: "tsLibTemplate",
// the output prefix name， default is 'main', please check your package.json after this option changed.
outputFileName: "main",
// devServer option
devServer: {
host: HOST || "localhost",
port: PORT || 2021,
proxy: {
"^/api": {
target: "http://192.168.0.123:1234",
pathRewrite: { "^/api": "" },
},
},
},
// jsx options direct set to esbuild
jsxFactory: "React.createElement",
jsxFragment: "React.Fragment",
// if env is false, default is all process env
env,
};
```
## Acknowledgment
[raulanatol / template-ts-package](https://github.com/raulanatol/template-ts-package)
## License
The MIT License (MIT)