https://github.com/beenotung/setup-tsc
CLI tool to setup TypeScript projects for npm and browser distribution
https://github.com/beenotung/setup-tsc
cli configuration http-server http2 nginx nodejs npx port-forwarding server websocket
Last synced: about 2 months ago
JSON representation
CLI tool to setup TypeScript projects for npm and browser distribution
- Host: GitHub
- URL: https://github.com/beenotung/setup-tsc
- Owner: beenotung
- License: bsd-2-clause
- Created: 2023-09-17T16:52:18.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-16T23:10:04.000Z (almost 2 years ago)
- Last Synced: 2025-03-23T03:33:50.739Z (over 1 year ago)
- Topics: cli, configuration, http-server, http2, nginx, nodejs, npx, port-forwarding, server, websocket
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/setup-tsc
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# setup-tsc
CLI tool to setup TypeScript projects for npm and browser distribution.
[](https://www.npmjs.com/package/setup-tsc)
## Cli Usage
```
Usage: setup-tsc [options]
Optional Options:
--entryFile= Specify the entry .ts file.
If not specified, it's automatically inferred (see details below).
--name|--global|--globalName=
Specify the global name for the browser .js file.
If not specified, it's derived from the package name or directory name.
--outDir= Specify the output directory for build output.
Default is 'dist'.
-h, --help Display usage information.
Options Details:
--entryFile:
If this option is not specified, the entry file is inferred from a list of potential names.
Here, '' is either the package name or the current working directory's name.
Possible names include 'index.ts', '.ts', ,
'src/index.ts', 'src/.ts', and 'src/'.
Note: If the package name ends with '.ts', '' is also a valid entry file name.
--globalName:
If the global name begins with '@', the name is derived from the part after the '/' in the package name,
and it is converted into camelCase.
For instance, '--globalName=@my-scope/my-package' results in a global name of 'myPackage'.
Examples:
$ setup-tsc --entryFile=./src/core.ts --globalName=oklab
$ setup-tsc --outDir=./build
$ npx setup-tsc
```
## License
This project is licensed with [BSD-2-Clause](./LICENSE)
This is free, libre, and open-source software. It comes down to four essential freedoms [[ref]](https://seirdy.one/2021/01/27/whatsapp-and-the-domestication-of-users.html#fnref:2):
- The freedom to run the program as you wish, for any purpose
- The freedom to study how the program works, and change it so it does your computing as you wish
- The freedom to redistribute copies so you can help others
- The freedom to distribute copies of your modified versions to others