@simplysm/sd-cli 7.0.249 → 7.0.267

package/docs/client-sw.md

@@ -0,0 +1,101 @@
+# 클라이언트 패키지에 ServiceWorker 기능 추가
+
+## @angular/service-worker 의존성 추가
+
+package.json
+
+``` json
+{
+  ...,
+  "dependencies": {
+    "@angular/service-worker": "^13.2.0",
+    ...
+  }
+}
+```
+
+## 패키지 루트에 ngsw-config.json 파일 추가
+
+```json
+{
+  "$schema": "../../node_modules/@angular/service-worker/config/schema.json",
+  "index": "/index.html",
+  "assetGroups": [
+    {
+      "name": "app",
+      "installMode": "prefetch",
+      "resources": {
+        "files": [
+          "/favicon.ico",
+          "/index.html",
+          "/manifest.json",
+          "/*.css",
+          "/*.js"
+        ]
+      }
+    },
+    {
+      "name": "assets",
+      "installMode": "lazy",
+      "updateMode": "prefetch",
+      "resources": {
+        "files": [
+          "/assets/**",
+          "/*.(eot|svg|cur|jpg|jpeg|png|webp|gif|otf|ttf|woff|woff2|ani|xlsx|pptx|docx|zip|xls|ppt|doc)"
+        ]
+      }
+    }
+  ]
+}
+```
+
+
+## ServiceWorkerModule 추가
+
+AppModule.ts
+
+``` ts
+@NgModule({
+  imports: [
+    ServiceWorkerModule.register("ngsw-worker.js", {
+      enabled: process.env["NODE_ENV"] === "production",
+      registrationStrategy: "registerWhenStable:30000"
+    }),
+    ...
+  ]
+})
+export class AppModule implements DoBootstrap {
+  ...
+}
+```
+
+## ServiceWorker 업데이트 체크 로직 추가
+
+AppModule.ts
+
+``` ts
+@NgModule({
+  ...
+})
+export class AppModule implements DoBootstrap {
+  ...
+   
+  public constructor(private readonly _swUpdate: SwUpdate) {
+  }
+  
+  public async ngDoBootstrap(appRef: ApplicationRef): Promise<void> {
+    ...
+    appRef.bootstrap(AppPage);
+
+    // 업데이트 체크 (비동기)
+    if (this._swUpdate.isEnabled) {
+      if (await this._swUpdate.checkForUpdate()) {
+        if (window.confirm("클라이언트가 업데이트되었습니다. 새로고침하시겠습니까?\n\n  - 새로고침하지 않으면 몇몇 기능이 정상적으로 동작하지 않을 수 있습니다.")) {
+          await this._swUpdate.activateUpdate();
+          window.location.reload();
+        }
+      }
+    }
+  }
+}
+```

package/docs/conf-orm.md

@@ -0,0 +1,81 @@
+# 각 패키지에 orm 설정
+
+orm(DB)를 사용하는 모든 클라이언트 및 서버 패키지에 ORM 설정 추가
+
+## simplysm.json 각 패키지 설정
+
+아래 설정을 추천 예시 설정입니다.
+
+(클라이언트/서버 패키지에만 추가, 라이브러리에는 추가하지 않음)
+
+``` json
+{
+  "packages": {
+    "client": {
+      ...,
+      "configs": {
+        "orm": {
+          "MAIN": {
+            "dialect": "mysql",
+            "host": "localhost",
+            "port": 3306,
+            "username": "username",
+            "password": "password",
+            "defaultIsolationLevel": "READ_UNCOMMITTED"
+          }
+        }
+      }
+    },
+    ...
+  }
+}
+```
+* [simplysm.json 사용법](conf-usage.md)
+
+위의 옵션은, 심플리즘 라이브러리를 통해 "MAIN"이라는 이름으로 접속시, 하위 접속정보에 해당하는 DB로 접속하는 옵션입니다. 
+
+옵션값 각각의 의미는 다음과 같습니다.
+
+* **dialect**: *[필수]* DB 컨테이너 구분 (mysql, mssql, mssql-azure)
+* **host**: *[필수]* 접속 HOST (or IP)
+* **port**: *[옵션]* 접속 PORT번호 (기본값: mssql=3306, mssql=1433, mssql-azure=1433)
+* **username**: *[필수]* 인증 아이디
+* **password**: *[필수]* 인증 비밀번호
+* **defaultIsolationLevel**: *[옵션]* ISOLATION LEVEL, DIALECT에 따라 입력가능 정보가 다릅니다. 
+  * MSSQL: REPEATABLE_READ, READ_COMMITTED(*기본값*), READ_UNCOMMITTED, SERIALIZABLE, SNAPSHOT
+  * MYSQL: REPEATABLE_READ(*기본값*), READ_COMMITTED, READ_UNCOMMITTED, SERIALIZABLE
+  * 자세한 사항은 각 Dialect 공식문서를 참고하세요.
+
+## ORM 사용 패키지의 package.json 의존성 추가
+
+ORM 라이브러리 의존성 추가
+
+``` json
+{
+  ...,
+  "dependencies": {
+    ...,
+    "@simplysm/sd-orm-common": "~7.0.0"
+  }
+}
+```
+
+DB 라이브러리 의존성 추가 예제
+
+``` json
+{
+  ...,
+  "dependencies": {
+    ...,
+    "@simplysm-ts/db-main": "1.0.0"
+  }
+}
+```
+
+위 의존성은 아래 상황을 가정하여 입력된 예제입니다.
+* 프로젝트명: simplysm-ts
+* DB패키지명: main
+* 프로젝트버전: 1.0.0
+
+DB 라이브러리 의존성을 추가했다면, 해당 라이브러리를 tsconfig.json에도 경로를 추가해야함
+* [내부 라이브러리에 대한 tsconfig.json에 경로 추가](lib-ts-paths.md)

package/docs/conf-usage.md

@@ -0,0 +1,5 @@
+# simplysm.json 사용법
+
+* [simplysm.json의 각 패키지 공통설정을 위한 overrides 사용법](conf-overrides.md)
+* [simplysm.json에서 빌드타입(dev/prod)에 따른 설정 구분](conf-build-type.md)
+* [simplysm.json에서 옵션(@)에 따른 설정 구분](conf-option.md)

package/docs/lib-local-update.md

@@ -0,0 +1,50 @@
+# 라이브러리 패키지 로컬업데이트 설정
+
+라이브러리를 로컬 디렉토리에 있는 라이브러리 소스에서 자동으로 업데이트 합니다.
+
+## 사용법
+
+프로젝트 디렉토리의 simplysm.json 에 다음 옵션을 추가합니다.
+
+``` json
+{
+  "packages": {
+    ...
+  },
+  ...,
+  "localUpdates": {
+    "@simplysm/*": "../simplysm/packages/*"
+  }
+}
+```
+위 예제는 다음을 의미합니다.
+* scope `simplysm` 안의 모든 패키지를 `../simplysm/packages/*`안의 파일로 모두 전환합니다.
+* 즉 `node_modules/@simplysm` 폴더에 `../simplysm/packages`폴더를 복사하여 덮어씁니다.
+
+이제 다음 명령어를 실행하면 위의 동작이 수행됩니다.
+
+``` bat
+:: 주의사항: 대상이되는 라이브러리는 반드시 빌드되어 있거나, 변경감지 중이여야 합니다.
+:: sd-cli local-update --help 참고
+sd-cli local-update
+```
+
+또한, `sd-cli watch` 를 수행할 경우에는, 로컬 라이브러리 파일이 변경되면 자동으로 해당 파일을 다시 덮어씁니다.
+
+## (선택) package.json script 수정
+
+로컬업데이트 사용시에는, 다음과 같이 스크립트를 수정하여, `sd-cli`가 수행되기 전에 `local-update`를 수행하는 것을 추천합니다.
+
+``` json
+{
+  ...,
+  "scripts": {
+    "watch": "sd-cli local-update && sd-cli watch",
+    "build": "sd-cli local-update && sd-cli build",
+    "publish": "sd-cli local-update && sd-cli publish",
+    "----- utils": "",
+    "postinstall": "sd-cli local-update && sd-cli prepare"
+  },
+  ...
+}
+```

package/docs/lib-ts-paths.md

@@ -0,0 +1,25 @@
+# 내부 라이브러리에 대한 tsconfig.json에 경로 추가
+
+내부 라이브러리가 빌드되지 않더라도, IDE 에서 ts 타입을 제대로 체크하도록 tsconfig.json에 baseUrl과 paths를 추가함
+
+패키지의 tsconfig.json
+``` json
+{
+  ...,
+  "compilerOptions": {
+    ...,
+    "baseUrl": ".",
+    "paths": {
+      ...,
+      "@simplysm-ts/common": [
+        "../common/src/index.ts"
+      ]
+    }
+  }
+}
+```
+
+위 예제은 아래 상황을 가정하여 입력된 예제입니다.
+* 프로젝트명: simplysm-ts
+* 내부 라이브러리 패키지명: common
+* 내부 라이브러리 상대경로: "../common/src/index.ts"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/sd-cli",
-  "version": "7.0.249",
+  "version": "7.0.267",
   "description": "심플리즘 패키지 - CLI",
   "author": "김석래",
   "repository": {
@@ -23,11 +23,11 @@
     "@babel/parser": "^7.17.0",
     "@babel/types": "^7.17.0",
     "@ngtools/webpack": "^13.2.2",
-    "@simplysm/sd-core-common": "7.0.249",
-    "@simplysm/sd-core-node": "7.0.249",
-    "@simplysm/sd-service-common": "7.0.249",
-    "@simplysm/sd-service-server": "7.0.249",
-    "@simplysm/sd-storage": "7.0.249",
+    "@simplysm/sd-core-common": "7.0.267",
+    "@simplysm/sd-core-node": "7.0.267",
+    "@simplysm/sd-service-common": "7.0.267",
+    "@simplysm/sd-service-server": "7.0.267",
+    "@simplysm/sd-storage": "7.0.267",
     "browserslist": "^4.19.1",
     "chokidar": "^3.5.3",
     "connect": "^3.7.0",
@@ -35,7 +35,7 @@
     "cordova": "^11.0.0",
     "css-loader": "^6.6.0",
     "electron": "^18.0.1",
-    "electron-builder": "^22.14.13",
+    "electron-builder": "^23.0.3",
     "eslint": "^8.7.0",
     "eslint-webpack-plugin": "^3.1.1",
     "jsdom": "^19.0.0",
@@ -55,7 +55,9 @@
     "typescript": "~4.5.5",
     "webpack": "^5.68.0",
     "xml2js": "^0.4.23",
-    "yargs": "^17.3.1"
+    "yargs": "^17.3.1",
+    "typedoc": "^0.22.15",
+    "@compodoc/compodoc": "^1.1.7"
   },
   "devDependencies": {
     "@types/connect": "^3.4.35",

package/src/SdCliBuildResultError.ts

@@ -1,9 +1,9 @@
-import { SdError } from "@simplysm/sd-core-common";
-import { ISdCliPackageBuildResult } from "./commons";
-import { SdCliBuildResultUtil } from "./utils/SdCliBuildResultUtil";
-
-export class SdCliBuildResultError extends SdError {
-  public constructor(buildResult: ISdCliPackageBuildResult) {
-    super(SdCliBuildResultUtil.getMessage(buildResult));
-  }
-}
+import { SdError } from "@simplysm/sd-core-common";
+import { ISdCliPackageBuildResult } from "./commons";
+import { SdCliBuildResultUtil } from "./utils/SdCliBuildResultUtil";
+
+export class SdCliBuildResultError extends SdError {
+  public constructor(buildResult: ISdCliPackageBuildResult) {
+    super(SdCliBuildResultUtil.getMessage(buildResult));
+  }
+}

package/src/bin/sd-cli.ts

@@ -10,11 +10,11 @@ import { SdCliPrepare } from "../entry-points/SdCliPrepare";
 import { SdCliFileCrypto } from "../entry-points/SdCliFileCrypto";
 import { SdCliCordova } from "../build-tool/SdCliCordova";
 import { SdCliElectron } from "../build-tool/SdCliElectron";
+import { SdCliProjectGenerator } from "../entry-points/SdCliProjectGenerator";
 
 Error.stackTraceLimit = Infinity;
 
-const argv = yargs(hideBin(process.argv))
-  .version(false)
+const argv = (yargs(hideBin(process.argv)) as any)
   .help("help", "도움말")
   .alias("help", "h")
   .options({
@@ -27,17 +27,17 @@ const argv = yargs(hideBin(process.argv))
   .command(
     "prepare",
     "sd-cli 준비",
-    (cmd) => cmd.version(false)
+    (cmd) => cmd.version(false).hide("help").hide("debug")
   )
   .command(
     "update",
     "패키지 업데이트 (npm update)",
-    (cmd) => cmd.version(false)
+    (cmd) => cmd.version(false).hide("help").hide("debug")
   )
   .command(
     "local-update",
     "로컬 라이브러리 업데이트를 수행합니다.",
-    (cmd) => cmd.version(false)
+    (cmd) => cmd.version(false).hide("help").hide("debug")
       .options({
         config: {
           type: "string",
@@ -48,7 +48,7 @@ const argv = yargs(hideBin(process.argv))
   .command(
     "watch",
     "프로젝트의 각 패키지에 대한 변경감지 빌드를 수행합니다.",
-    (cmd) => cmd.version(false)
+    (cmd) => cmd.version(false).hide("help").hide("debug")
       .options({
         config: {
           type: "string",
@@ -93,7 +93,7 @@ const argv = yargs(hideBin(process.argv))
       })
   )
   .command(
-    "run-cordova <platform> <package> [url]",
+    "run-cordova <platform> <package> <url>",
     "변경감지중인 플랫폼을 코도바 디바이스에 앱 형태로 띄웁니다.",
     (cmd) => cmd
       .positional("platform", {
@@ -115,7 +115,7 @@ const argv = yargs(hideBin(process.argv))
   .command(
     "build",
     "프로젝트의 각 패키지에 대한 빌드를 수행합니다.",
-    (cmd) => cmd.version(false)
+    (cmd) => cmd.version(false).hide("help").hide("debug")
       .options({
         config: {
           type: "string",
@@ -136,7 +136,7 @@ const argv = yargs(hideBin(process.argv))
   .command(
     "publish",
     "프로젝트의 각 패키지를 배포합니다.",
-    (cmd) => cmd.version(false)
+    (cmd) => cmd.version(false).hide("help").hide("debug")
       .options({
         noBuild: {
           type: "boolean",
@@ -162,24 +162,198 @@ const argv = yargs(hideBin(process.argv))
   .command(
     "enc-file <file>",
     "파일을 암호화 합니다.",
-    (cmd) => cmd.version(false)
+    (cmd) => cmd.version(false).hide("help").hide("debug")
       .positional("file", {
         type: "string",
-        describe: "암호화할 파일명"
+        describe: "암호화할 파일명",
+        demandOption: true
       })
   )
   .command(
     "dec-file <file>",
     "파일을 복호화 합니다.",
-    (cmd) => cmd.version(false)
+    (cmd) => cmd.version(false).hide("help").hide("debug")
       .positional("file", {
         type: "string",
-        describe: "암호화된 파일명"
+        describe: "암호화된 파일명",
+        demandOption: true
+      })
+  )
+  .command(
+    "init <description> <author> <gitUrl> [name]",
+    "프로젝트를 초기화 합니다.",
+    (cmd) => cmd.version(false).hide("help").hide("debug")
+      .positional("description", {
+        type: "string",
+        describe: "프로젝트 설명(=명칭)",
+        demandOption: true
+      })
+      .positional("author", {
+        type: "string",
+        describe: "작성자",
+        demandOption: true
+      })
+      .positional("gitUrl", {
+        type: "string",
+        describe: "소스코드 관리를 위한 GIT 레파지토리 URL",
+        demandOption: true
+      })
+      .positional("name", {
+        type: "string",
+        describe: "프로젝트 영문명 (기본값: 최종폴더명)"
       })
+      .example([
+        ["$0 init sample 샘플프로젝트 홍길동 https://github.com/my/sample.git"]
+      ])
+  )
+  .command(
+    "add",
+    "프로젝트에 패키지/기능등을 추가합니다.",
+    (cmd) => cmd.version(false).hide("help").hide("debug")
+      .command(
+        "ts-lib <name> <description>",
+        "타입스트립트 라이브러리 패키지를 추가합니다.",
+        (cmd1) => cmd1.version(false).hide("help").hide("debug")
+          .positional("name", {
+            type: "string",
+            describe: "패키지명",
+            demandOption: true
+          })
+          .positional("description", {
+            type: "string",
+            describe: "패키지설명",
+            demandOption: true
+          })
+          .options({
+            useDom: {
+              type: "boolean",
+              describe: "DOM객체(window, document 등) 사용 여부",
+              default: false
+            },
+            isForAngular: {
+              type: "boolean",
+              describe: "Angular 라이브러리 여부 (useDom 옵션을 덮어씁니다)",
+              default: false
+            }
+          })
+          .example([
+            ["$0 add ts-lib common 공통모듈"],
+            ["$0 sd-cli add ts-lib client-common \"클라이언트 공통\" --useDom"]
+          ])
+      )
+      .command(
+        "db-lib <name>",
+        "DB 라이브러리 패키지를 추가합니다.",
+        (cmd1) => cmd1.version(false).hide("help").hide("debug")
+          .positional("name", {
+            type: "string",
+            describe: "패키지명",
+            demandOption: true
+          })
+          .example([
+            ["$0 add db-lib main"]
+          ])
+      )
+      .command(
+        "db-model <dbName> <category> <name> <description>",
+        "DB 패키지에 모델를 추가합니다.",
+        (cmd1) => cmd1.version(false).hide("help").hide("debug")
+          .positional("dbName", {
+            type: "string",
+            describe: "DB 패키지 영문명 = 'DbContext'명칭",
+            demandOption: true
+          })
+          .positional("category", {
+            type: "string",
+            describe: "추가할 모델의 분류명",
+            demandOption: true
+          })
+          .positional("name", {
+            type: "string",
+            describe: "추가할 모델의 명칭 (테이블명)",
+            demandOption: true
+          })
+          .positional("description", {
+            type: "string",
+            describe: "추가할 모델의 설명 (테이블 설명)",
+            demandOption: true
+          })
+          .example([
+            ["$0 add db-model main base Employee 직원"]
+          ])
+      )
+      .command(
+        "server [name] [description]",
+        "서버 패키지를 추가합니다.",
+        (cmd1) => cmd1.version(false).hide("help").hide("debug")
+          .positional("name", {
+            type: "string",
+            describe: "패키지명"
+          })
+          .positional("description", {
+            type: "string",
+            describe: "패키지 설명"
+          })
+          .example([
+            ["$0 add server"]
+          ])
+      )
+      .command(
+        "client <name> <description> <serverName>",
+        "클라이언트 패키지를 추가합니다.",
+        (cmd1) => cmd1.version(false).hide("help").hide("debug")
+          .positional("name", {
+            type: "string",
+            describe: "패키지명",
+            demandOption: true
+          })
+          .positional("description", {
+            type: "string",
+            describe: "패키지 설명",
+            demandOption: true
+          })
+          .positional("serverName", {
+            type: "string",
+            describe: "서버 패키지명",
+            demandOption: true
+          })
+          .example([
+            ["$0 add client admin 관리자 server"]
+          ])
+      )
+      .command(
+        "page <pkgName> <name> [category]",
+        "패키지에 페이지를 추가합니다.",
+        (cmd1) => cmd1.version(false).hide("help").hide("debug")
+          .positional("pkgName", {
+            type: "string",
+            describe: "패키지명",
+            demandOption: true
+          })
+          .positional("name", {
+            type: "string",
+            describe: "페이지명",
+            demandOption: true
+          })
+          .positional("category", {
+            type: "string",
+            describe: "추가할 페이지의 분류명"
+          })
+          .options({
+            isRouteParent: {
+              type: "boolean",
+              describe: "router-outlet 포함 여부",
+              default: false
+            }
+          })
+          .example([
+            ["$0 add page admin Employee home/base"]
+          ])
+      )
   )
   .parseSync();
 
-if (argv.debug) {
+if (Boolean(argv.debug)) {
   process.env["SD_CLI_LOGGER_SEVERITY"] = "DEBUG";
 
   Logger.setConfig({
@@ -255,7 +429,7 @@ const logger = Logger.get(["simplysm", "sd-cli", "bin", "sd-cli"]);
         optNames: argv.options ?? [],
         pkgs: argv.packages ?? []
       });
-    if (!argv.noBuild) {
+    if (!Boolean(argv.noBuild)) {
       process.exit(0);
     }
   }
@@ -265,6 +439,61 @@ const logger = Logger.get(["simplysm", "sd-cli", "bin", "sd-cli"]);
   else if (argv._[0] === "dec-file") {
     await new SdCliFileCrypto().decryptAsync(argv.file!);
   }
+  else if (argv._[0] === "init") {
+    await new SdCliProjectGenerator(process.cwd()).initAsync({
+      name: argv.name,
+      description: argv.description!,
+      author: argv.author,
+      gitUrl: argv.gitUrl
+    });
+  }
+  else if (argv._[0] === "add") {
+    if (argv._[1] === "ts-lib") {
+      await new SdCliProjectGenerator(process.cwd()).addTsLibAsync({
+        name: argv.name!,
+        description: argv.description!,
+        useDom: argv.useDom,
+        isForAngular: argv.isForAngular
+      });
+    }
+    else if (argv._[1] === "db-lib") {
+      await new SdCliProjectGenerator(process.cwd()).addDbLibAsync({
+        name: argv.name!
+      });
+    }
+    else if (argv._[1] === "db-model") {
+      await new SdCliProjectGenerator(process.cwd()).addDbLibModelAsync({
+        dbPkgName: argv.dbName,
+        category: argv.category,
+        name: argv.name!,
+        description: argv.description!
+      });
+    }
+    else if (argv._[1] === "page") {
+      await new SdCliProjectGenerator(process.cwd()).addPageAsync({
+        pkgName: argv.pkgName,
+        category: argv.category,
+        name: argv.name!,
+        isRouteParent: argv.isRouteParent
+      });
+    }
+    else if (argv._[1] === "server") {
+      await new SdCliProjectGenerator(process.cwd()).addServerAsync({
+        name: argv.name,
+        description: argv.description
+      });
+    }
+    else if (argv._[1] === "client") {
+      await new SdCliProjectGenerator(process.cwd()).addClientAsync({
+        name: argv.name!,
+        description: argv.description!,
+        serverName: argv.serverName
+      });
+    }
+    else {
+      throw new Error(`명령어가 잘못 되었습니다.\n\t${argv._[1]}\n`);
+    }
+  }
   else {
     throw new Error(`명령어가 잘못 되었습니다.\n\t${argv._[0]}\n`);
   }