ulysses-ck/ts-node-playground

ts-node-playground

A boilerplate to get started using TypeScript with linting, formatting and building features

🔨 Build with:

• TypeScript
• Node

• SWC
  

• Prettier
  

• Eslint
• SonarJS
• chokidar
• husky

Installation

1. Clone repo and rename directory

git clone https://github.com/ulysses-ck/ts-node-playground-boilerplate name-of-your-choice

2. Get into directory

cd name-of-your-choice

3. Install dependencies

pnpm install

Scripts

# generate dist directory with transpiled js
pnpm build

# remove files into dist and preserving directory for windows
pnpm clean-win

# remove files into dist and preserving directory in linux
pnpm clean

# init playground
pnpm start

# linting code with eslint
pnpm lint

# format code
pnpm prettier

Eslint and prettier

If some of the rules are conflicting with prettier in formatting, run this command

npx eslint-config-prettier /path/to/script.ts

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

⚠ License

Distributed under the GNU GPLv3 License. See LICENSE for more information.