evty 1.0.0 → 1.0.1
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.
- package/LICENSE +21 -0
- package/README.md +85 -1
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 v12yun
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,4 +1,88 @@
|
|
|
1
|
-
# ⚡ evty
|
|
1
|
+
# ⚡ evty
|
|
2
|
+
### 🌐 English version is available below.
|
|
3
|
+
|
|
4
|
+
`.env` ファイルから、**スマートな型推論**と**JSDocコメント**を備えたTypeScript型定義ファイルを自動生成・リアルタイム監視する、設定不要(Zero-Config)の超軽量CLIツールです。
|
|
5
|
+
|
|
6
|
+
事前のインストールは一切不要。`npx` コマンド一発で即座に動作します。
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## ✨ 主な特徴
|
|
11
|
+
|
|
12
|
+
- ⚡ **設定ゼロで即起動 (Zero Config)**: 複雑なJSON設定は一切不要。コマンドを叩いた瞬間に機能します。
|
|
13
|
+
- 🔮 **高度な型推論 (Smart Type Inference)**: `.env` 内の値を自動解析。`PORT=3000` は `string | "3000"` へ、`DEBUG=true` は `"true" | "false"` へと最適なリテラル型を自動割り当て。
|
|
14
|
+
- 📝 **JSDocの自動同期 (Auto JSDoc Comments)**: `.env` 内のコメント行(`# コメント`)を、そのままTypeScriptのJSDocへ変換。エディタ上で `process.env.VAR` にマウスホバーするだけで、詳細な説明が即座にポップアップ表示されます。
|
|
15
|
+
- 👀 **変更のリアルタイム監視 (Watch Mode)**: `.env` ファイルの保存をトリガーに、ミリ秒単位で型定義ファイルを自動更新。開発の手を止める必要はありません。
|
|
16
|
+
- 👶 **開発環境への全自動親切設計**: 万が一プロジェクト内に `.env` が存在しない場合は、サンプル付きのテンプレートを自動生成して開発者をサポートします。
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🚀 クイックスタート
|
|
21
|
+
|
|
22
|
+
お使いのプロジェクトのルートディレクトリ(`.env` がある場所)のターミナルで、以下のコマンドを1行実行するだけです。
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npx evty
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
これだけで `evty` が起動し、プロジェクト内の `.env` を解析して `env.d.ts` を自動生成し、そのままリアルタイム監視モードへと移行します。
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 💡 動作イメージ
|
|
33
|
+
|
|
34
|
+
### 1. 開発中の `.env` ファイル:
|
|
35
|
+
```env
|
|
36
|
+
# ローカルサーバーが起動するポート番号
|
|
37
|
+
PORT=3000
|
|
38
|
+
|
|
39
|
+
# 開発用デバッグモードの切り替えフラグ
|
|
40
|
+
DEBUG=true
|
|
41
|
+
|
|
42
|
+
# MongoDBの接続文字列
|
|
43
|
+
DATABASE_URL=mongodb://localhost:27017/mydb
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### 2. 自動生成される `env.d.ts`:
|
|
47
|
+
```typescript
|
|
48
|
+
declare global {
|
|
49
|
+
namespace NodeJS {
|
|
50
|
+
interface ProcessEnv {
|
|
51
|
+
/**
|
|
52
|
+
* ローカルサーバーが起動するポート番号
|
|
53
|
+
*/
|
|
54
|
+
PORT: "3000" | string;
|
|
55
|
+
/**
|
|
56
|
+
* 開発用デバッグモードの切り替えフラグ
|
|
57
|
+
*/
|
|
58
|
+
DEBUG: "true" | "false";
|
|
59
|
+
/**
|
|
60
|
+
* MongoDBの接続文字列
|
|
61
|
+
*/
|
|
62
|
+
DATABASE_URL: string;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
export {};
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 3. 圧倒的な開発者体験 (DX):
|
|
70
|
+
VS CodeなどのモダンなIDEで `process.env.PORT` と打ち込むだけで、**強力な予測補完**が効くだけでなく、あなたが `.env` に書いた**日本語のコメントがそのままエディタ上にポップアップ表示**されます。タイポによる不具合を100%撲滅します。
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## 🛠️ 動作要件
|
|
75
|
+
|
|
76
|
+
- [Node.js](https://nodejs.org) (v16以上推奨)
|
|
77
|
+
- TypeScriptプロジェクト(または `@ts-check` を有効化したJavaScriptプロジェクト)
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## 📄 ライセンス
|
|
82
|
+
|
|
83
|
+
本プロジェクトは MIT License のもとで公開されています。
|
|
84
|
+
|
|
85
|
+
# English
|
|
2
86
|
|
|
3
87
|
A smart, zero-config CLI tool that automatically generates TypeScript definitions from your `.env` file—complete with **smart type inference** and **JSDoc support** for a better Developer Experience (DX).
|
|
4
88
|
|
package/package.json
CHANGED