anl 1.6.0 → 1.6.2
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/README.ar.md +37 -5
- package/README.en.md +37 -5
- package/README.es.md +37 -5
- package/README.fr.md +37 -9
- package/README.jp.md +37 -5
- package/README.md +38 -6
- package/README.ru.md +37 -5
- package/lib/package.json.js +1 -1
- package/package.json +1 -1
package/README.ar.md
CHANGED
|
@@ -6,14 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
an-cli هي أداة سطر الأوامر للواجهة الأمامية، وتتضمن الأمرين التاليين:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> `anl type`: أداة سطر أوامر تقوم تلقائياً بإنشاء تعريفات أنواع TypeScript ودوال طلبات API استناداً إلى Swagger JSON.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
> `anl lint`: يقوم بإنشاء إعدادات eslint و stylelint و prettier و commitLint و VSCode لمشاريع react أو vue
|
|
12
|
+
|
|
13
|
+
> `anl git`: يُنشئ إعدادات Git المحلية؛ وتشمل الميزات الاختيارية إنشاء فروع gitflow القياسية، وتحديد موضوع رسائل الالتزام، وتكوين أوامر Git المخصصة
|
|
12
14
|
|
|
13
15
|
## المميزات
|
|
14
16
|
|
|
15
17
|
- `anl type`
|
|
16
|
-
|
|
17
18
|
- 🚀 التحليل التلقائي لوثائق Swagger JSON
|
|
18
19
|
- 📦 إنشاء ملفات تعريف أنواع TypeScript
|
|
19
20
|
- 🔄 إنشاء دوال طلبات API آمنة النوع
|
|
@@ -241,7 +242,6 @@ export const uploadFile = (params: UploadFile.Body) =>
|
|
|
241
242
|
تدعم الأداة تصفية الواجهات التي سيتم إنشاؤها من خلال التكوين:
|
|
242
243
|
|
|
243
244
|
1. تضمين واجهات محددة
|
|
244
|
-
|
|
245
245
|
- تحديد الواجهات المطلوب إنشاؤها من خلال عنصر `includeInterface`
|
|
246
246
|
- سيتم إنشاء الواجهات المحددة فقط
|
|
247
247
|
- تنسيق التكوين هو مصفوفة من الكائنات تحتوي على `path` و `method`
|
|
@@ -298,7 +298,6 @@ npm run blink
|
|
|
298
298
|
## الأسئلة الشائعة
|
|
299
299
|
|
|
300
300
|
1. فشل تنسيق ملفات الأنواع المنشأة
|
|
301
|
-
|
|
302
301
|
- تحقق من تثبيت prettier
|
|
303
302
|
- تأكد من وجود ملف تكوين prettier في جذر المشروع
|
|
304
303
|
|
|
@@ -364,3 +363,36 @@ ISC License
|
|
|
364
363
|
## دليل المساهمة
|
|
365
364
|
|
|
366
365
|
نرحب بتقديم المشكلات وطلبات السحب!
|
|
366
|
+
|
|
367
|
+
# أمر anl git
|
|
368
|
+
|
|
369
|
+
### نظرة عامة على الميزات
|
|
370
|
+
|
|
371
|
+
- يطبق ميزات Git على المستودع الحالي عبر قائمة تفاعلية:
|
|
372
|
+
- إنشاء فروع gitflow القياسية
|
|
373
|
+
- ينسخ `.gitscripts/` و`.gitconfig` و`.commit-type.js` إلى المشروع (فقط عند عدم وجودها)
|
|
374
|
+
- يجعل الملف `.gitscripts/random-branch.sh` قابلاً للتنفيذ
|
|
375
|
+
- ينفذ الأمر `git config --local include.path ../.gitconfig`
|
|
376
|
+
- تعيين موضوع رسالة الالتزام تلقائياً
|
|
377
|
+
- ينسخ `.githooks/commit-msg` ويجعله قابلاً للتنفيذ
|
|
378
|
+
- ينفذ الأمر `git config core.hooksPath .githooks`
|
|
379
|
+
- أوامر git مخصصة
|
|
380
|
+
- يضيف ملف `.gitattributes` إلى المشروع (فقط عند عدم وجوده)
|
|
381
|
+
|
|
382
|
+
### طريقة الاستخدام
|
|
383
|
+
|
|
384
|
+
```bash
|
|
385
|
+
$ anl git
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
اختر ميزة أو أكثر من القائمة. يتم إنشاء الملفات فقط إذا كانت غير موجودة؛ يتم الحفاظ على الملفات الموجودة.
|
|
389
|
+
|
|
390
|
+
### ملاحظات
|
|
391
|
+
|
|
392
|
+
- نفّذ الأمر داخل مستودع Git.
|
|
393
|
+
- إذا فشلت أوامر التكوين التلقائي، نفّذ الأوامر يدوياً:
|
|
394
|
+
|
|
395
|
+
```bash
|
|
396
|
+
git config --local include.path ../.gitconfig
|
|
397
|
+
git config core.hooksPath .githooks
|
|
398
|
+
```
|
package/README.en.md
CHANGED
|
@@ -6,14 +6,15 @@ English | [Español](./README.es.md) | [العربية](./README.ar.md) | [Fran
|
|
|
6
6
|
|
|
7
7
|
an-cli is a frontend command line tool that includes the following two commands:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> `anl type`:A command-line tool that automatically generates TypeScript type definitions and API request functions based on Swagger JSON.
|
|
10
10
|
|
|
11
|
-
`anl lint
|
|
11
|
+
> `anl lint`: Generates eslint, stylelint, prettier, commitLint, and VSCode related configurations for React or Vue projects.
|
|
12
|
+
|
|
13
|
+
> `anl git`: Generates local Git configuration; optional features include gitflow standard branch creation, commit message subjects, and custom Git command configuration
|
|
12
14
|
|
|
13
15
|
## Features
|
|
14
16
|
|
|
15
17
|
- `anl type`
|
|
16
|
-
|
|
17
18
|
- 🚀 Automatic parsing of Swagger JSON documentation
|
|
18
19
|
- 📦 Generate TypeScript type definition files
|
|
19
20
|
- 🔄 Generate type-safe API request functions
|
|
@@ -191,7 +192,6 @@ The tool has built-in comprehensive error handling mechanisms:
|
|
|
191
192
|
The tool supports filtering interfaces to be generated through configuration:
|
|
192
193
|
|
|
193
194
|
1. Include specific interfaces
|
|
194
|
-
|
|
195
195
|
- Specify interfaces to be generated through the `includeInterface` configuration item
|
|
196
196
|
- Only interfaces specified in the configuration will be generated
|
|
197
197
|
- Configuration format is an array of objects containing `path` and `method`
|
|
@@ -248,7 +248,6 @@ npm run blink
|
|
|
248
248
|
## Common Issues
|
|
249
249
|
|
|
250
250
|
1. Generated type file formatting fails
|
|
251
|
-
|
|
252
251
|
- Check if prettier is installed
|
|
253
252
|
- Confirm if prettier configuration file exists in the project root
|
|
254
253
|
|
|
@@ -264,6 +263,39 @@ Issues and Pull Requests are welcome!
|
|
|
264
263
|
|
|
265
264
|
ISC License
|
|
266
265
|
|
|
266
|
+
# anl git command
|
|
267
|
+
|
|
268
|
+
### Feature Overview
|
|
269
|
+
|
|
270
|
+
- Git features can be applied to the current repository via an interactive prompt:
|
|
271
|
+
- gitflow standard branch creation
|
|
272
|
+
- Copies `.gitscripts/`, `.gitconfig`, `.commit-type.js` to your project (only if missing)
|
|
273
|
+
- Makes `.gitscripts/random-branch.sh` executable
|
|
274
|
+
- Executes `git config --local include.path ../.gitconfig`
|
|
275
|
+
- automatically set commit subject
|
|
276
|
+
- Copies `.githooks/commit-msg` and sets it executable
|
|
277
|
+
- Executes `git config core.hooksPath .githooks`
|
|
278
|
+
- custom git command
|
|
279
|
+
- Adds `.gitattributes` to the project (only if missing)
|
|
280
|
+
|
|
281
|
+
### Usage
|
|
282
|
+
|
|
283
|
+
```bash
|
|
284
|
+
$ anl git
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
Select one or more features in the prompt. Files are only created if missing; existing files are preserved.
|
|
288
|
+
|
|
289
|
+
### Notes
|
|
290
|
+
|
|
291
|
+
- Run inside a Git repository.
|
|
292
|
+
- If automatic git config commands fail, execute manually:
|
|
293
|
+
|
|
294
|
+
```bash
|
|
295
|
+
git config --local include.path ../.gitconfig
|
|
296
|
+
git config core.hooksPath .githooks
|
|
297
|
+
```
|
|
298
|
+
|
|
267
299
|
# anl lint command
|
|
268
300
|
|
|
269
301
|
### Feature Overview
|
package/README.es.md
CHANGED
|
@@ -6,14 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
an-cli es una herramienta de línea de comandos frontend que incluye dos comandos:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> `anl type`:Una herramienta de línea de comandos que genera automáticamente definiciones de tipos TypeScript y funciones de solicitud de API basadas en Swagger JSON.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
> `anl lint`: Genera configuraciones relacionadas con eslint, stylelint, prettier, commitLint y VSCode para proyectos React o Vue.
|
|
12
|
+
|
|
13
|
+
> `anl git`: Genera la configuración local de Git; las funciones opcionales incluyen la creación de ramas estándar de gitflow, los asuntos de los mensajes de commit y la configuración de comandos Git personalizados
|
|
12
14
|
|
|
13
15
|
## Características
|
|
14
16
|
|
|
15
17
|
- `anl type`
|
|
16
|
-
|
|
17
18
|
- 🚀 Análisis automático de documentación Swagger JSON
|
|
18
19
|
- 📦 Genera archivos de definición de tipos TypeScript
|
|
19
20
|
- 🔄 Genera funciones de solicitud de API con seguridad de tipos
|
|
@@ -205,7 +206,6 @@ La herramienta incluye un mecanismo completo de manejo de errores:
|
|
|
205
206
|
La herramienta permite filtrar las interfaces que se generarán mediante dos opciones de configuración:
|
|
206
207
|
|
|
207
208
|
1. Incluir interfaces específicas
|
|
208
|
-
|
|
209
209
|
- A través del elemento de configuración `includeInterface`
|
|
210
210
|
- Solo se generarán las interfaces especificadas en la configuración
|
|
211
211
|
- El formato de configuración es un array de objetos con `path` y `method`
|
|
@@ -262,7 +262,6 @@ npm run blink
|
|
|
262
262
|
## Problemas comunes
|
|
263
263
|
|
|
264
264
|
1. Fallo en el formato de los archivos de tipos generados
|
|
265
|
-
|
|
266
265
|
- Verificar si prettier está instalado
|
|
267
266
|
- Confirmar si existe un archivo de configuración de prettier en la raíz del proyecto
|
|
268
267
|
|
|
@@ -328,3 +327,36 @@ Licencia ISC
|
|
|
328
327
|
## Guía de contribución
|
|
329
328
|
|
|
330
329
|
¡Las Issues y Pull Requests son bienvenidas!
|
|
330
|
+
|
|
331
|
+
# Comando anl git
|
|
332
|
+
|
|
333
|
+
### Descripción general
|
|
334
|
+
|
|
335
|
+
- Aplica funciones de Git al repositorio actual mediante un prompt interactivo:
|
|
336
|
+
- creación de ramas estándar gitflow
|
|
337
|
+
- Copia `.gitscripts/`, `.gitconfig`, `.commit-type.js` al proyecto (solo si no existen)
|
|
338
|
+
- Otorga permisos ejecutables a `.gitscripts/random-branch.sh`
|
|
339
|
+
- Ejecuta `git config --local include.path ../.gitconfig`
|
|
340
|
+
- establecer automáticamente el asunto del commit
|
|
341
|
+
- Copia `.githooks/commit-msg` y lo marca como ejecutable
|
|
342
|
+
- Ejecuta `git config core.hooksPath .githooks`
|
|
343
|
+
- comando git personalizado
|
|
344
|
+
- Agrega `.gitattributes` al proyecto (solo si no existe)
|
|
345
|
+
|
|
346
|
+
### Uso
|
|
347
|
+
|
|
348
|
+
```bash
|
|
349
|
+
$ anl git
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
Seleccione una o varias funciones en el prompt. Los archivos solo se crean si no existen; los existentes se preservan.
|
|
353
|
+
|
|
354
|
+
### Notas
|
|
355
|
+
|
|
356
|
+
- Ejecútese dentro de un repositorio Git.
|
|
357
|
+
- Si fallan los comandos de configuración automática, ejecútelos manualmente:
|
|
358
|
+
|
|
359
|
+
```bash
|
|
360
|
+
git config --local include.path ../.gitconfig
|
|
361
|
+
git config core.hooksPath .githooks
|
|
362
|
+
```
|
package/README.fr.md
CHANGED
|
@@ -6,14 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
an-cli est un outil en ligne de commande frontend qui comprend les deux commandes suivantes :
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> `anl type`:Un outil en ligne de commande qui génère automatiquement des définitions de types TypeScript et des fonctions de requête API basées sur Swagger JSON.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
> `anl lint`: Génère des configurations ESLint, Stylelint, Prettier, CommitLint et VSCode pour les projets React ou Vue.
|
|
12
|
+
|
|
13
|
+
> `anl git`: Génère la configuration Git locale ; les fonctionnalités optionnelles incluent la création de branches standard gitflow, les sujets des messages de commit, et la configuration de commandes Git personnalisées
|
|
12
14
|
|
|
13
15
|
## Caractéristiques
|
|
14
16
|
|
|
15
17
|
- `anl type`
|
|
16
|
-
|
|
17
18
|
- 🚀 Analyse automatique de la documentation Swagger JSON
|
|
18
19
|
- 📦 Génération de fichiers de définition de types TypeScript
|
|
19
20
|
- 🔄 Génération de fonctions de requête API typées
|
|
@@ -205,7 +206,6 @@ L'outil intègre un mécanisme complet de gestion des erreurs :
|
|
|
205
206
|
L'outil prend en charge le filtrage des interfaces à générer via la configuration :
|
|
206
207
|
|
|
207
208
|
1. Inclure des interfaces spécifiques
|
|
208
|
-
|
|
209
209
|
- Spécifier les interfaces à générer via l'option `includeInterface`
|
|
210
210
|
- Seules les interfaces spécifiées dans la configuration seront générées
|
|
211
211
|
- Format de configuration : tableau d'objets contenant `path` et `method`
|
|
@@ -262,7 +262,6 @@ npm run blink
|
|
|
262
262
|
## FAQ
|
|
263
263
|
|
|
264
264
|
1. Échec du formatage des fichiers de types générés
|
|
265
|
-
|
|
266
265
|
- Vérifiez si prettier est installé
|
|
267
266
|
- Vérifiez la présence du fichier de configuration prettier dans la racine du projet
|
|
268
267
|
|
|
@@ -329,12 +328,44 @@ Licence ISC
|
|
|
329
328
|
|
|
330
329
|
Les Issues et Pull Requests sont les bienvenus !
|
|
331
330
|
|
|
331
|
+
# Commande anl git
|
|
332
|
+
|
|
333
|
+
### Vue d'ensemble
|
|
334
|
+
|
|
335
|
+
- Applique des fonctionnalités Git au dépôt courant via une invite interactive :
|
|
336
|
+
- création de branches standard gitflow
|
|
337
|
+
- Copie `.gitscripts/`, `.gitconfig`, `.commit-type.js` dans le projet (seulement si absent)
|
|
338
|
+
- Rend exécutable `.gitscripts/random-branch.sh`
|
|
339
|
+
- Exécute `git config --local include.path ../.gitconfig`
|
|
340
|
+
- définir automatiquement l'objet du commit
|
|
341
|
+
- Copie `.githooks/commit-msg` et le rend exécutable
|
|
342
|
+
- Exécute `git config core.hooksPath .githooks`
|
|
343
|
+
- commande git personnalisée
|
|
344
|
+
- Ajoute `.gitattributes` au projet (seulement si absent)
|
|
345
|
+
|
|
346
|
+
### Utilisation
|
|
347
|
+
|
|
348
|
+
```bash
|
|
349
|
+
$ anl git
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
Sélectionnez une ou plusieurs fonctionnalités. Les fichiers ne sont créés que s'ils n'existent pas; les fichiers existants sont préservés.
|
|
353
|
+
|
|
354
|
+
### Remarques
|
|
355
|
+
|
|
356
|
+
- À exécuter dans un dépôt Git.
|
|
357
|
+
- Si les commandes de configuration automatique échouent, exécutez-les manuellement :
|
|
358
|
+
|
|
359
|
+
```bash
|
|
360
|
+
git config --local include.path ../.gitconfig
|
|
361
|
+
git config core.hooksPath .githooks
|
|
362
|
+
```
|
|
363
|
+
|
|
332
364
|
## Documentation Multilingue
|
|
333
365
|
|
|
334
366
|
Pour une meilleure maintenance de la documentation multilingue, nous suggérons :
|
|
335
367
|
|
|
336
368
|
1. Convention de Nommage des Fichiers
|
|
337
|
-
|
|
338
369
|
- Utilisation des codes de langue standard :
|
|
339
370
|
- Chinois : `README.zh-CN.md`
|
|
340
371
|
- Anglais : `README.en.md`
|
|
@@ -345,20 +376,17 @@ Pour une meilleure maintenance de la documentation multilingue, nous suggérons
|
|
|
345
376
|
- Japonais : `README.ja.md`
|
|
346
377
|
|
|
347
378
|
2. Synchronisation des Documents
|
|
348
|
-
|
|
349
379
|
- Utilisez le script `sync-docs.js` pour synchroniser automatiquement
|
|
350
380
|
- Exécutez `npm run sync-docs` après les modifications
|
|
351
381
|
- Maintenez une structure cohérente dans toutes les versions
|
|
352
382
|
|
|
353
383
|
3. Normes de Traduction
|
|
354
|
-
|
|
355
384
|
- Maintenir la cohérence des termes techniques
|
|
356
385
|
- Conserver les exemples de code en anglais
|
|
357
386
|
- Utiliser la langue correspondante pour les commentaires
|
|
358
387
|
- Maintenir un format uniforme
|
|
359
388
|
|
|
360
389
|
4. Guide de Contribution
|
|
361
|
-
|
|
362
390
|
- Les suggestions d'amélioration multilingue sont bienvenues
|
|
363
391
|
- Mettre à jour toutes les versions lors des PR
|
|
364
392
|
- Signaler les problèmes de traduction via Issues
|
package/README.jp.md
CHANGED
|
@@ -6,14 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
an-cliは、以下の2つのコマンドを含むフロントエンドコマンドラインツールです:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> `anl type`:Swagger JSONに基づいてTypeScriptの型定義とAPIリクエスト関数を自動生成するツール。
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
> `anl lint`: ReactまたはVueプロジェクトのeslint、stylelint、prettier、commitLint、VSCode関連の設定を生成するツール。
|
|
12
|
+
|
|
13
|
+
> `anl git`: ローカルGit設定を生成します。オプション機能として、gitflow標準ブランチの作成、コミットメッセージのサブジェクト設定、カスタムGitコマンドの構成を提供します
|
|
12
14
|
|
|
13
15
|
## 特徴
|
|
14
16
|
|
|
15
17
|
- `anl type`
|
|
16
|
-
|
|
17
18
|
- 🚀 Swagger JSON文書の自動解析
|
|
18
19
|
- 📦 TypeScript型定義ファイルの生成
|
|
19
20
|
- 🔄 型安全なAPIリクエスト関数の生成
|
|
@@ -205,7 +206,6 @@ export const uploadFile = (params: UploadFile.Body) =>
|
|
|
205
206
|
ツールは設定を通じて生成するインターフェースをフィルタリングすることができます:
|
|
206
207
|
|
|
207
208
|
1. 特定のインターフェースを含める
|
|
208
|
-
|
|
209
209
|
- `includeInterface` 設定項目で生成するインターフェースを指定
|
|
210
210
|
- 設定で指定されたインターフェースのみが生成されます
|
|
211
211
|
- 設定形式は `path` と `method` を含むオブジェクトの配列です
|
|
@@ -262,7 +262,6 @@ npm run blink
|
|
|
262
262
|
## よくある質問
|
|
263
263
|
|
|
264
264
|
1. 生成された型ファイルのフォーマットに失敗する
|
|
265
|
-
|
|
266
265
|
- prettierがインストールされているか確認してください
|
|
267
266
|
- プロジェクトルートディレクトリにprettier設定ファイルが存在するか確認してください
|
|
268
267
|
|
|
@@ -328,3 +327,36 @@ ISC License
|
|
|
328
327
|
## 貢献ガイド
|
|
329
328
|
|
|
330
329
|
[Issue](https://github.com/bianliuzhu/an-cli/issues)や[Pull Request](https://github.com/bianliuzhu/an-cli/pulls)を歓迎します!
|
|
330
|
+
|
|
331
|
+
# anl gitコマンド
|
|
332
|
+
|
|
333
|
+
### 機能概要
|
|
334
|
+
|
|
335
|
+
- 対話式プロンプトで現在のリポジトリにGit機能を適用:
|
|
336
|
+
- gitflow標準ブランチ作成
|
|
337
|
+
- `.gitscripts/`、`.gitconfig`、`.commit-type.js` を(存在しない場合のみ)プロジェクトへコピー
|
|
338
|
+
- `.gitscripts/random-branch.sh` を実行可能化
|
|
339
|
+
- `git config --local include.path ../.gitconfig` を実行
|
|
340
|
+
- コミットサブジェクトの自動設定
|
|
341
|
+
- `.githooks/commit-msg` をコピーし実行可能化
|
|
342
|
+
- `git config core.hooksPath .githooks` を実行
|
|
343
|
+
- カスタムgitコマンド
|
|
344
|
+
- `.gitattributes` を(存在しない場合のみ)追加
|
|
345
|
+
|
|
346
|
+
### 使い方
|
|
347
|
+
|
|
348
|
+
```bash
|
|
349
|
+
$ anl git
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
プロンプトで機能を1つ以上選択します。ファイルは存在しない場合のみ作成され、既存ファイルは保持されます。
|
|
353
|
+
|
|
354
|
+
### 注意
|
|
355
|
+
|
|
356
|
+
- Gitリポジトリ内で実行してください。
|
|
357
|
+
- 自動設定が失敗した場合は、以下を手動実行:
|
|
358
|
+
|
|
359
|
+
```bash
|
|
360
|
+
git config --local include.path ../.gitconfig
|
|
361
|
+
git config core.hooksPath .githooks
|
|
362
|
+
```
|
package/README.md
CHANGED
|
@@ -4,16 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
## 说明
|
|
6
6
|
|
|
7
|
-
an-cli 是
|
|
7
|
+
an-cli 是 前端命令行工具,包含以下命令:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> `anl type`:基于 Swagger JSON 自动生成 TypeScript 类型定义和 API 请求函数的命令行工具。
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
> `anl lint`: 生成 react 或 vue 项目 eslint、stylelint、prettier、commitLint、VSCode相关配置
|
|
12
|
+
|
|
13
|
+
> `anl git`: 生成 git 本地配置,可选的的功能有 gitflow 标准分支创建、git commit messages 主题、git 自定义命令配置
|
|
12
14
|
|
|
13
15
|
## 功能特点
|
|
14
16
|
|
|
15
17
|
- `anl type`
|
|
16
|
-
|
|
17
18
|
- 🚀 自动解析 Swagger JSON 文档
|
|
18
19
|
- 📦 生成 TypeScript 类型定义文件
|
|
19
20
|
- 🔄 生成类型安全的 API 请求函数
|
|
@@ -205,7 +206,6 @@ export const uploadFile = (params: UploadFile.Body) =>
|
|
|
205
206
|
工具支持通过配置来过滤需要生成的接口:
|
|
206
207
|
|
|
207
208
|
1. 包含特定接口
|
|
208
|
-
|
|
209
209
|
- 通过 `includeInterface` 配置项指定需要生成的接口
|
|
210
210
|
- 只会生成配置中指定的接口
|
|
211
211
|
- 配置格式为包含 `path` 和 `method` 的对象数组
|
|
@@ -262,7 +262,6 @@ npm run blink
|
|
|
262
262
|
## 常见问题
|
|
263
263
|
|
|
264
264
|
1. 生成的类型文件格式化失败
|
|
265
|
-
|
|
266
265
|
- 检查是否安装了 prettier
|
|
267
266
|
- 确认项目根目录下是否有 prettier 配置文件
|
|
268
267
|
|
|
@@ -328,3 +327,36 @@ ISC License
|
|
|
328
327
|
# 贡献指南
|
|
329
328
|
|
|
330
329
|
欢迎提交 [Issue](https://github.com/bianliuzhu/an-cli/issues) 和 [Pull Request](https://github.com/bianliuzhu/an-cli/pulls)!
|
|
330
|
+
|
|
331
|
+
# anl git 命令
|
|
332
|
+
|
|
333
|
+
### 功能概述
|
|
334
|
+
|
|
335
|
+
- 通过交互式多选,为当前仓库应用以下 Git 能力:
|
|
336
|
+
- gitflow 标准分支创建
|
|
337
|
+
- 将 `.gitscripts/`、`.gitconfig`、`.commit-type.js` 复制到项目(仅在缺失时)
|
|
338
|
+
- 为 `.gitscripts/random-branch.sh` 添加可执行权限
|
|
339
|
+
- 执行 `git config --local include.path ../.gitconfig`
|
|
340
|
+
- 自动设置 commit subject
|
|
341
|
+
- 复制 `.githooks/commit-msg` 并设置为可执行
|
|
342
|
+
- 执行 `git config core.hooksPath .githooks`
|
|
343
|
+
- 自定义 git 命令
|
|
344
|
+
- 向项目添加 `.gitattributes`(仅在缺失时)
|
|
345
|
+
|
|
346
|
+
### 使用方法
|
|
347
|
+
|
|
348
|
+
```bash
|
|
349
|
+
$ anl git
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
在提示中选择一个或多个功能。文件仅在不存在时创建;已有文件会被保留。
|
|
353
|
+
|
|
354
|
+
### 注意事项
|
|
355
|
+
|
|
356
|
+
- 请在 Git 仓库内运行。
|
|
357
|
+
- 若自动执行的 git config 失败,请手动执行:
|
|
358
|
+
|
|
359
|
+
```bash
|
|
360
|
+
git config --local include.path ../.gitconfig
|
|
361
|
+
git config core.hooksPath .githooks
|
|
362
|
+
```
|
package/README.ru.md
CHANGED
|
@@ -6,14 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
an-cli - это инструмент командной строки для фронтенд-разработки, включающий следующие две команды:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> `anl type`:Инструмент командной строки для автоматической генерации определений типов TypeScript и функций запросов API на основе Swagger JSON.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
> `anl lint`: Генерирует конфигурации eslint, stylelint, prettier, commitLint и VSCode для проектов React или Vue.
|
|
12
|
+
|
|
13
|
+
> `anl git`: Генерирует локальную конфигурацию Git; дополнительные возможности включают создание стандартных веток gitflow, настройку темы сообщений коммита и конфигурацию пользовательских команд Git
|
|
12
14
|
|
|
13
15
|
## Особенности
|
|
14
16
|
|
|
15
17
|
- `anl type`
|
|
16
|
-
|
|
17
18
|
- 🚀 Автоматический разбор документации Swagger JSON
|
|
18
19
|
- 📦 Генерация файлов определения типов TypeScript
|
|
19
20
|
- 🔄 Генерация типобезопасных функций запросов API
|
|
@@ -205,7 +206,6 @@ export const uploadFile = (params: UploadFile.Body) =>
|
|
|
205
206
|
Инструмент поддерживает фильтрацию генерируемых интерфейсов через конфигурацию:
|
|
206
207
|
|
|
207
208
|
1. Включение определенных интерфейсов
|
|
208
|
-
|
|
209
209
|
- Используйте параметр `includeInterface` для указания интерфейсов, которые нужно сгенерировать
|
|
210
210
|
- Будут сгенерированы только указанные в конфигурации интерфейсы
|
|
211
211
|
- Формат конфигурации - массив объектов с полями `path` и `method`
|
|
@@ -262,7 +262,6 @@ npm run blink
|
|
|
262
262
|
## Часто задаваемые вопросы
|
|
263
263
|
|
|
264
264
|
1. Не удается отформатировать сгенерированные файлы типов
|
|
265
|
-
|
|
266
265
|
- Проверьте, установлен ли prettier
|
|
267
266
|
- Убедитесь, что в корневой директории проекта есть файл конфигурации prettier
|
|
268
267
|
|
|
@@ -328,3 +327,36 @@ ISC License
|
|
|
328
327
|
# Руководство по содействию
|
|
329
328
|
|
|
330
329
|
Приветствуются [Issue](https://github.com/bianliuzhu/an-cli/issues) и [Pull Request](https://github.com/bianliuzhu/an-cli/pulls)!
|
|
330
|
+
|
|
331
|
+
# Команда anl git
|
|
332
|
+
|
|
333
|
+
### Обзор возможностей
|
|
334
|
+
|
|
335
|
+
- Применяет функции Git к текущему репозиторию через интерактивный выбор:
|
|
336
|
+
- создание стандартных веток gitflow
|
|
337
|
+
- Копирует `.gitscripts/`, `.gitconfig`, `.commit-type.js` (только если отсутствуют)
|
|
338
|
+
- Делает `.gitscripts/random-branch.sh` исполняемым
|
|
339
|
+
- Выполняет `git config --local include.path ../.gitconfig`
|
|
340
|
+
- автоматическая настройка темы коммита
|
|
341
|
+
- Копирует `.githooks/commit-msg` и делает исполняемым
|
|
342
|
+
- Выполняет `git config core.hooksPath .githooks`
|
|
343
|
+
- пользовательская git-команда
|
|
344
|
+
- Добавляет `.gitattributes` (только если отсутствует)
|
|
345
|
+
|
|
346
|
+
### Использование
|
|
347
|
+
|
|
348
|
+
```bash
|
|
349
|
+
$ anl git
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
Выберите одну или несколько функций. Файлы создаются только при отсутствии; существующие сохраняются.
|
|
353
|
+
|
|
354
|
+
### Примечания
|
|
355
|
+
|
|
356
|
+
- Запускайте внутри репозитория Git.
|
|
357
|
+
- Если автоматические команды конфигурации завершаются ошибкой, выполните вручную:
|
|
358
|
+
|
|
359
|
+
```bash
|
|
360
|
+
git config --local include.path ../.gitconfig
|
|
361
|
+
git config core.hooksPath .githooks
|
|
362
|
+
```
|
package/lib/package.json.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e="1.6.
|
|
1
|
+
"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e="1.6.2",i="FE command line tool",s="bin/an-cli.js",p={dev:"rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript -w",build:"rimraf lib && rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",pub:"bash publish.sh",ts:"tsc ./src/int.ts --noEmit --watch",blink:"npm run build && npm link","sync-docs":"node scripts/sync-docs.js"},l={anl:"bin/an-cli.js"},o="Gleason <bianliuzhu@gmail.com>",t={"@commitlint/cli":"^17.4.3","@commitlint/config-conventional":"^17.4.3","@rollup/plugin-commonjs":"^21.0.1","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^13.1.3","@rollup/plugin-typescript":"^8.3.0","@types/inquirer":"^9.0.7","@types/shelljs":"^0.8.11","@typescript-eslint/eslint-plugin":"^5.52.0","@typescript-eslint/parser":"^5.52.0","cross-env":"^7.0.3",eslint:"^8.7.0",husky:"^8.0.3","openapi-types":"^12.1.3",prettier:"^3.3.2",rimraf:"^5.0.7",rollup:"^2.64.0","rollup-plugin-cleandir":"^2.0.0","rollup-plugin-copy":"^3.5.0","rollup-plugin-terser":"^7.0.2",typescript:"^4.5.4"},r={"app-root-path":"^3.1.0",cac:"^6.7.12",chalk:"4.*","clear-console":"^1.1.0",commander:"14.0.1",figures:"^6.1.0",inquirer:"^10.1.8","log-symbols":"^5.1.0",ora:"5.*","progress-estimator":"^0.3.0",shelljs:"^0.8.5"},n=["typescript","cli","typescript 脚手架","ts 脚手架","ts-cli","脚手架"],c=["package.json","README.md","lib","template"],u={type:"git",url:"https://github.com/bianliuzhu/an-cli.git"},a="commonjs",m={name:"anl",version:e,description:i,main:s,scripts:p,bin:l,author:o,license:"ISC",devDependencies:t,dependencies:r,keywords:n,files:c,repository:u,type:a};exports.author=o,exports.bin=l,exports.default=m,exports.dependencies=r,exports.description=i,exports.devDependencies=t,exports.files=c,exports.keywords=n,exports.license="ISC",exports.main=s,exports.name="anl",exports.repository=u,exports.scripts=p,exports.type=a,exports.version=e;
|