UNPKG

comfytype

Version:

Comfiest TypeScript Style Boilerplate

github.com/instafluff/ComfyType

instafluff/ComfyType

28 lines (19 loc) • 1.55 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
![npm](https://img.shields.io/npm/v/comfytype?style=flat-square) ![GitHub](https://img.shields.io/github/license/instafluff/comfytype?style=flat-square) [![](https://data.jsdelivr.com/v1/package/npm/comfytype/badge)](https://www.jsdelivr.com/package/npm/comfytype) # ComfyType Comfiest way to start a TypeScript project! `npx comfytype` ComfyType is a one-line `npx` command to configure or create a very simple starter Node.js project TypeScript to get you coding right away as quickly as possible with [ComfyCase](https://www.github.com/instafluff/ComfyCase) syntax style lint rules. ## Instafluff ## > *Like these projects? The best way to support my open-source projects is by becoming a Comfy Sponsor on GitHub!* > https://github.com/sponsors/instafluff > *Come and hang out with us at the Comfiest Corner on Twitch!* > https://twitch.tv/instafluff # Instructions Run `npx comfytype` in a new project directory or an existing Node.js project directory. # What it does This command will... 1. (If there is no `package.json` file) Create a new `package.json` file 2. Add TypeScript dependencies and relevant script commands to your `package.json` file 3. Create the `tsconfig.json` file with configurations for both Node and Browser *(NOTE: You should update this file as needed for your project)* 4. Configure the project with ComfyCase ESLint settings and create a `.editorconfig` file to accompany it 5. (If there is no `/src` directory) Create a project folder structure with a "Hello World" one-line example