tsnite 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +42 -12
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,18 +1,17 @@
1
1
  # tsnite
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/tsnite.svg)](https://www.npmjs.com/package/tsnite)
4
+ [![Eslint](https://img.shields.io/badge/ESLint-3A33D1?logo=eslint)](https://img.shields.io/badge/ESLint-3A33D1?logo=eslint)
5
+ [![prettier](https://img.shields.io/badge/Prettier-de9954?logo=prettier&logoColor=ffffff)](https://img.shields.io/badge/Prettier-de9954?logo=prettier&logoColor=ffffff)
6
+ [![github license](https://img.shields.io/github/license/luas10c/tsnite)](https://img.shields.io/github/license/luas10c/tsnite)
7
+
3
8
  ```
4
9
  TypeScript at full throttle—fast, safe, unstoppable. 🚀
5
10
  ```
6
11
 
7
12
  `tsnite` is a tool that accelerates TypeScript project development, offering a streamlined build and run experience. Ideal for developers seeking productivity without compromising security and performance.
8
13
 
9
- ## Recursos principais
10
-
11
- - **Execução rápida de arquivos TypeScript** sem build manual.
12
- - **Integração simples** com projetos existentes.
13
- - **Suporte a múltiplos roots** e configurações flexíveis de projeto.
14
-
15
- ## 🚀 Install
14
+ ### 🚀 Installation
16
15
 
17
16
  To add `tsnite` to your project as a development dependency, run:
18
17
 
@@ -26,23 +25,54 @@ Or, if you're using Yarn:
26
25
  yarn add --dev tsnite
27
26
  ```
28
27
 
29
- ## 🛠️ How to use
28
+ ### Features
29
+
30
+ - **Decorators** first-class support for TypeScript decorators.
31
+ - **Simple integration** with existing projects.
32
+ - **ESM Support** native support for modern JavaScript modules.
33
+ - **Automatic `tsconfig.json` loading** – respects your project configuration.
34
+
35
+ ### 🛠️ How to use
30
36
 
31
37
  With `tsnite` installed, you can use it directly in your terminal to run TypeScript files without needing to compile them first.
32
38
 
33
39
  ### Run a TypeScript file
34
40
 
35
41
  ```bash
36
- npx tsnite caminho/do/arquivo.ts
42
+ npx tsnite path/to/file.ts
37
43
  ```
38
44
 
39
45
  This will execute the specified TypeScript file, allowing you to quickly test and run scripts during development.
40
46
 
41
47
  ## 💡 Tips & Best Practices
42
48
 
43
- - Keep your TypeScript project configuration (tsconfig.json) up to date for best performance.
44
- - Use multiple source roots for large projects to organize files efficiently.
45
- - Combine tsnite with scripts in package.json for a smoother development workflow.
49
+ - **Use with `package.json` scripts** integrate `tsnite` into `npm` or `yarn` scripts for a smoother workflow.
50
+ Example:
51
+ ```json
52
+ {
53
+ "scripts": {
54
+ //...
55
+ "dev": "tsnite --watch --include-assets src/index.ts"
56
+ }
57
+ }
58
+ ```
59
+ - **Debugging with VS Code** when debugging, you may need to configure outFiles in .vscode/launch.json to match the temporary output directory used by tsnite:
60
+ Example:
61
+ ```json
62
+ {
63
+ "version": "0.2.0",
64
+ "configurations": [
65
+ {
66
+ //...
67
+ "outFiles": [
68
+ "/tmp/tsnite/**/*.js",
69
+ "C:\Users\<SeuUsuario>\AppData\Local\Temp"
70
+ ] // Use one or the other, first for Linux, second for Windows
71
+ // ...
72
+ }
73
+ ]
74
+ }
75
+ ```
46
76
 
47
77
  ## 📚 More information
48
78
 
package/package.json CHANGED
@@ -8,7 +8,7 @@
8
8
  "nodejs",
9
9
  "typescript"
10
10
  ],
11
- "version": "0.0.4",
11
+ "version": "0.0.5",
12
12
  "type": "module",
13
13
  "bin": {
14
14
  "tsnite": "dist/cli.js"