가이드 업데이트 및 xe-cli widget 생성 버그 수정 (#1)

* core develop 에서 widget에서 info.php / settings.blade.php 를 쓸 수 있도록 코드 변경해 widget 코드 경량화 * xe_cli으로 변경 * 로고 변경 * 로고 변경 * 로고 변경 * 명칭 변경 * Update composer.json * Update README.md * Update README.md * commands 코드 리펙토링/ 새로운 Command 추가 * Update README.md * Update README.md * Update README.md * Update README.md * xe_cli:move:menuItem 커멘드 옵션 변경 * 기존에 사용한던 command 관련 파일을 삭제합니다. * Controller/Handler 을 생성할 수 있는 Command 추가 * Make Migration Table 추가 / Make Migration Resource 추가 * Make BackOffice 생성 시 필요한 Handler, TableMigration 를 같이 생성해줍니다. * 관리자 페이지 Controller, 관련된 파일을 같이 생성해주는 기능 추가. / 외 에러 수정, 옵션 추가. * table에 --model 옵션 추가/모델에 --migration 옵션 추가 * empty -> structure 로 변경 * backOffice 와 관련된 view 파일을 생성하는 Command 추가 * backOffice에 대한 View 파일을 생성하는 명령어에 대한 가이드 작성 * 명령어 클래스 변경 / make widget command 내부 변경 * xe_cli:make:model에 --soft-deletes 옵션 추가 * model command 에 대한 가이드를 명시합니다. * php artisan xe_cli:make:migrationTable 명령어에 --soft-delets 옵션 추가 * php artisan xe_cli:make:migrationTable --soft-deletes 에 대한 가이드 추가 * 선언에 대한 trait 생성 * xe_cli:make:model/xe_cli:make:migrationTable --pk, --imcrementing option 추가 * make Back Office Controller 코멘드 - make Controller 코멘드에서 분리 * xe_cli:make:controller/clientController 에 --resource 옵션 추가 * backOffice Controller stub에 controller 별 id 파라미터 추가 * 추가된 옵션에 대한 설명을 README.md 에 추가 * handler, messageHandler, validationHandler --structure 옵션 사용 시 /structure/handler.stub 공통적으로 사용하도록 수정 * 커멘드를 Console/Commands 형식으로 변경 / 수정된 사항을 바탕으로 README 변경 * migration talbe - 마이그레이션 테이블에 대한 기본 형태를 변경해줍니다. * name option 입력으로 입력 받은 값 camel case로 변경해줍니다. * 다른 명령어에서 모델 형식에 맞춰 마이그레이션 을 생성하기 위해 --model 옵션 추가. * Squashed commit of the following: commit b1c15f5 Author: xharpenParksuhyeon <[email protected]> Date: Thu Dec 16 03:13:32 2021 +0000 다른 명령어에서 모델 형식에 맞춰 마이그레이션 을 생성하기 위해 --model 옵션 추가. commit 43116df Author: xharpenParksuhyeon <[email protected]> Date: Thu Dec 16 03:09:17 2021 +0000 name option 입력으로 입력 받은 값 camel case로 변경해줍니다. commit 4834a97 Author: xharpenParksuhyeon <[email protected]> Date: Thu Dec 16 02:58:06 2021 +0000 migration talbe - 마이그레이션 테이블에 대한 기본 형태를 변경해줍니다. * 마이그레이션 코멘드에서 마이그레이션 인터페이스를 생성하는 코드 변경 * #7 모델 생성 시 dates, casts 프로퍼티 추가. * #7 PHP 7.0.0 Version에 맞춰 모델을 생성해줍니다./프로퍼티에 대한 주석 다시 작성 * Squashed commit of the following: commit 3ee61d2 Author: xharpenParksuhyeon <[email protected]> Date: Sun Dec 19 11:46:43 2021 +0000 #7 PHP 7.0.0 Version에 맞춰 모델을 생성해줍니다./프로퍼티에 대한 주석 다시 작성 commit 65a703b Author: xharpenParksuhyeon <[email protected]> Date: Sun Dec 19 11:25:21 2021 +0000 #7 모델 생성 시 dates, casts 프로퍼티 추가. commit 706e6b9 Author: xharpenParksuhyeon <[email protected]> Date: Thu Dec 16 03:23:33 2021 +0000 마이그레이션 코멘드에서 마이그레이션 인터페이스를 생성하는 코드 변경 * #3 Model Command --timestamp 옵션 추가 * #3 Migration Table 명령어에 --timestamp 옵션을 추가합니다. * Squashed commit of the following: commit 1823581 Author: xharpenParksuhyeon <[email protected]> Date: Sun Dec 19 12:52:43 2021 +0000 #3 Migration Table 명령어에 --timestamp 옵션을 추가합니다. commit 0c7ef4f Author: xharpenParksuhyeon <[email protected]> Date: Sun Dec 19 12:50:31 2021 +0000 #3 Model Command --timestamp 옵션 추가 * #3 Migration Table, Model Command 에 대한 --timestamp 옵션 설명을 readme 에 추가. * #5 위젯 코드 Command 가이드 추가/위젯 코드 command 변경/가이드 문서 작성 * - #9 보드 게시판 및 댓글의 Editor Config를 설정하는 Command 추가 * - #9 보드 게시판 및 댓글의 Editor Config를 설정하는 Command 필요없는 항목 제거 및 주석 수정 * Update README.md Co-authored-by: xharpenParksuhyeon <[email protected]> Co-authored-by: 박수현 <[email protected]> Co-authored-by: Gyeol <[email protected]>
xpressengine · Jan 12, 2022 · 8b7f986 · 8b7f986
1 parent a53adf8
commit 8b7f986
Show file tree

Hide file tree

Showing 124 changed files with 8,267 additions and 1,160 deletions.
diff --git a/README.md b/README.md
diff --git a/assets/style.css b/assets/style.css
diff --git a/composer.json b/composer.json
@@ -1,28 +1,34 @@
 {
-    "name": "xpressengine-plugin/spark_command",
+    "name": "xpressengine-plugin/xe_cli",
     "description": "XpressEngine3의 위젯, 스킨을 빠르게 제작할 수 있도록 추가적인 커맨드를 제공합니다.",
     "keywords": [
         "xpressengine",
         "plugin"
     ],
     "license": "LGPL-3.0-or-later",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "type": "xpressengine-plugin",
     "support": {
-        "email": "bi.kim@xharpen.com"
+        "email": "contact@xpressengine.com"
     },
     "authors": [
         {
-            "name": "Sparkweb",
-            "email": "parksu@xharpen.com",
-            "homepage": "https://sparkweb.co.kr",
+            "name": "XEHub",
+            "email": "parksu@xpressengine.com",
+            "homepage": "https://xpressengine.com",
             "role": "Developer"
+        },
+        {
+          "name": "XEHub",
+          "email": "[email protected]",
+          "homepage": "https://xpressengine.com",
+          "role": "Developer"
         }
     ],
     "extra": {
         "xpressengine": {
             "icon": "icon.png",
-            "title": "스파크 커맨드",
+            "title": "XE CLI",
             "component": {}
         }
     },
@@ -31,7 +37,7 @@
     },
     "autoload": {
         "psr-4": {
-            "SparkWeb\\XePlugin\\SparkCommand\\": "src/"
+            "XeHub\\XePlugin\\XeCli\\": "src/"
         }
     }
-}
+}
diff --git a/doc/controllers.md b/doc/controllers.md
@@ -0,0 +1,86 @@
+### * Make Controller
+
+특정 도메인 (name)에 대한 Controller 파일을 생성해줍니다.
+
+```
+php artisan xe_cli:make:controller 
+    {plugin}
+    {name} 
+    {--resource : Laravel Resource 형태에 맞춰 생성}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+
+#### Command 예시
+
+```
+php artisan xe_cli:make:controller xe_cli exam   
+php artisan xe_cli:make:controller xe_cli exam --resource  
+php artisan xe_cli:make:controller xe_cli exam --force    
+php artisan xe_cli:make:controller xe_cli exam --force --resource    
+```
+<br>
+
+### * Make BackOffice Controller
+
+특정 도메인 (name)에 대한 BackOffice Controller 파일을 생성해줍니다.
+
+```
+php artisan xe_cli:make:backOfficeController 
+    {plugin}
+    {name}
+    {--complete : 완성된 형태로 생성 (라우트/모델/핸들러 등 관련 파일을 같이 생성됩니다.)}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+
+#### Command 예시
+
+```
+php artisan xe_cli:make:backOfficeController xe_cli exam
+php artisan xe_cli:make:backOfficeController xe_cli exam --complete
+php artisan xe_cli:make:backOfficeController xe_cli exam --force
+php artisan xe_cli:make:backOfficeController xe_cli exam --force --complete
+```
+
+<br>
+
+### * Make Client Controller
+
+특정 도메인 (name)에 대한 Client Controller 파일을 생성해줍니다.
+
+```
+php artisan xe_cli:make:clientController {plugin} {name}
+    {--resource : Laravel Resource 형태에 맞춰 생성}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+
+#### 예시
+
+```
+php artisan xe_cli:make:clientController xe_cli exam
+php artisan xe_cli:make:clientController xe_cli exam --resource
+php artisan xe_cli:make:clientController xe_cli exam --force
+php artisan xe_cli:make:clientController xe_cli exam --resource --force
+```
+
+<br>
+
+### * Make API Controller
+
+특정 도메인 (name)에 대한 API Controller 파일을 생성해줍니다.
+
+```
+php artisan xe_cli:make:apiController 
+    {plugin} 
+    {name}
+    {--complete : 완성된 형태로 생성}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+
+#### 예시
+
+```
+php artisan xe_cli:make:apiController xe_cli exam
+php artisan xe_cli:make:apiController xe_cli exam --complete
+php artisan xe_cli:make:apiController xe_cli exam --force
+php artisan xe_cli:make:apiController xe_cli exam --complete --force
+```
diff --git a/doc/handlers.md b/doc/handlers.md
@@ -0,0 +1,65 @@
+### * Make Handler
+
+특정 도메인 (name)에 대한 Handler 파일을 생성해줍니다.
+
+```
+php artisan xe_cli:make:handler 
+    {plugin}
+    {name}
+    {--complete : 완성된 형태로 생성 (모델/마이그레이션 등 관련 파일을 같이 생성됩니다.)}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+#### 예시
+
+```
+php artisan xe_cli:make:handler xe_cli exam
+php artisan xe_cli:make:handler xe_cli exam --complete
+php artisan xe_cli:make:handler xe_cli exam --force
+php artisan xe_cli:make:handler xe_cli exam --complete --force
+```
+
+<br>
+
+### * Make Message Handler
+
+특정 도메인 (name)에 대한 Message Handler 파일을 생성해줍니다.
+
+```
+php artisan xe_cli:make:messageHandler 
+    {plugin}
+    {name}
+    {--complete : 완성된 형태로 생성}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+
+#### 예시
+
+```
+php artisan xe_cli:make:messageHandler xe_cli exam
+php artisan xe_cli:make:messageHandler xe_cli exam --complete
+php artisan xe_cli:make:messageHandler xe_cli exam --force
+php artisan xe_cli:make:messageHandler xe_cli exam --complete --force
+```
+
+<br>
+
+### * Make Validation Handler
+
+특정 도메인 (name)에 대한 Validation Handler 파일을 생성해줍니다.
+
+```
+php artisan xe_cli:make:validationHandler 
+    {plugin}
+    {name}
+    {--complete : 완성된 형태로 생성}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+
+#### 예시
+
+```
+php artisan xe_cli:make:validationHandler xe_cli exam
+php artisan xe_cli:make:validationHandler xe_cli exam --complete
+php artisan xe_cli:make:validationHandler xe_cli exam --force
+php artisan xe_cli:make:validationHandler xe_cli exam --complete --force
+```
diff --git a/doc/migrations.md b/doc/migrations.md
@@ -0,0 +1,55 @@
+### * Session - Database Table 마이그레이션
+
+세션을 데이터베이스에서 관리하기 위해 관련된 Table, Config 를 추가해줍니다.
+
+```
+php artisan xe_cli:migrate:sessionDatabase
+```
+
+<br>
+
+### * Queue - Database Table 마이그레이션
+
+큐를 데이터베이스에서 관리하기 위해 관련된 Table, Config 를 추가해줍니다.
+
+```
+php artisan xe_cli:migrate:queueDatabase
+```
+
+<br>
+
+### * Make Migration Table
+
+테이블에 대한 마이그레이션 파일을 생성해줍니다.
+
+```
+xe_cli:make:migrationTable {plugin} {name} 
+    {--pk=id : 테이블에서 사용할 프라이머리 키 설정}
+    {--model : 마이그레이션에 대한 모델 파일을 생성}
+    {--soft-deletes : soft-deletes 기능을 사용할 수 있도록 설정}
+    {--incrementing : incrementing 기능을 사용할 수 있도록 설정}
+    {--timestamps : timestamps 기능을 사용할 수 있도록 설정}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+
+#### 예시
+
+```
+php artisan xe_cli:make:migrationTable xe_cli exam --model
+php artisan xe_cli:make:migrationTable xe_cli exam
+php artisan xe_cli:make:migrationTable xe_cli exam --soft-delets
+php artisan xe_cli:make:migrationTable xe_cli exam --model --soft-deletes
+php artisan xe_cli:make:migrationTable xe_cli exam --force --timestamps
+php artisan xe_cli:make:migrationTable xe_cli exam --force
+php artisan xe_cli:make:migrationTable xe_cli exam --timestamps
+```
+
+<br>
+
+### * Make Migration Resource
+
+플러그인에서 제공하는 마이그레이션을 관리하는 마이그레이션 리소스 파일을 생성해줍니다.
+
+```
+xe_cli:make:migrationResource {plugin}
+```
diff --git a/doc/models.md b/doc/models.md
@@ -0,0 +1,29 @@
+### * Make Model
+
+특정 도메인 (name)에 대한 Model 파일을 생성해줍니다.
+
+```
+php artisan xe_cli:make:model 
+    {plugin}
+    {name} 
+    {--migration : 테이블 마이그레이션 파일 생성}
+    {--table= : 모델의 테이블 이름 설정}
+    {--pk=id : 모델에서 사용할 프라이머리 키 설정}
+    {--soft-deletes : soft-deletes 기능을 사용할 수 있도록 설정}
+    {--incrementing : incrementing 기능을 사용할 수 있도록 설정}
+    {--timestamps : timestamps 기능을 사용할 수 있도록 설정}
+    {--force : 기존 파일 삭제 후 새롭게 생성}
+```
+
+#### 예시
+
+```
+php artisan xe_cli:make:model xe_cli exam
+php artisan xe_cli:make:model xe_cli exam --migration
+php artisan xe_cli:make:model xe_cli exam --table=xe_hub_table
+php artisan xe_cli:make:model xe_cli exam --table=xe_hub_table --soft-deletes
+php artisan xe_cli:make:model xe_cli exam --soft-deletes
+php artisan xe_cli:make:model xe_cli exam --soft-deletes --force
+php artisan xe_cli:make:model xe_cli exam --soft-deletes --timestamps --force
+php artisan xe_cli:make:model xe_cli exam --timestamps --force
+```