@lakutata/cli 1.0.37 → 2.1.0-alpha.4

package/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [2.1.0-alpha.4](https://github.com/lakutata/lakutata-packages/compare/@lakutata/cli@2.1.0-alpha.3...@lakutata/cli@2.1.0-alpha.4) (2024-04-15)
+
+**Note:** Version bump only for package @lakutata/cli
+
+
+
+
+
+# [2.1.0-alpha.3](https://github.com/lakutata/lakutata-packages/compare/@lakutata/cli@2.1.0-alpha.2...@lakutata/cli@2.1.0-alpha.3) (2024-04-15)
+
+
+### Features
+
+* Update Spinner.ts to use arrow function in setInterval ([ec3df2e](https://github.com/lakutata/lakutata-packages/commit/ec3df2e26ced10af012ed9cf6e50e108ac8205cc))
+
+
+
+
+
+# [2.1.0-alpha.2](https://github.com/lakutata/lakutata-packages/compare/@lakutata/cli@2.1.0-alpha.1...@lakutata/cli@2.1.0-alpha.2) (2024-04-15)
+
+
+### Features
+
+* Update Spinner component ([fad870c](https://github.com/lakutata/lakutata-packages/commit/fad870cbcd912340c8eb9ae50286c805ca4079dd))
+
+
+
+
+
+# [2.1.0-alpha.1](https://github.com/lakutata/lakutata-packages/compare/@lakutata/cli@2.1.0-alpha.0...@lakutata/cli@2.1.0-alpha.1) (2024-04-15)
+
+
+### Features
+
+* Implement log-update in Spinner component ([ceaf657](https://github.com/lakutata/lakutata-packages/commit/ceaf6570770fce60c0fda4a46957994350f3965b))
+
+
+
+
+
+# [2.1.0-alpha.0](https://github.com/lakutata/lakutata-packages/compare/@lakutata/cli@2.0.1-alpha.0...@lakutata/cli@2.1.0-alpha.0) (2024-04-15)
+
+
+### Features
+
+* **cli:** add create and info command ([670a1fc](https://github.com/lakutata/lakutata-packages/commit/670a1fcfbd38f39e6395647ffacb3867011882d7))

package/README.md

@@ -1,31 +1,11 @@
-<div style="text-align:center">
-	<img src="https://gitee.com/nnxr/lakutata-cli/raw/master/assets/lakutata-banner.png" />
-</div>
+# `@lakutata/cli`
 
-[![NPM Version](https://img.shields.io/npm/v/@lakutata/cli?color=informational&style=flat-square)](https://npmjs.org/package/@lakutata/cli)
-[![NODE Version](https://img.shields.io/node/v/@lakutata/cli?color=informational&style=flat-square)](https://npmjs.org/package/@lakutata/cli)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@lakutata/cli/badge.svg?style=flat-square)](https://snyk.io/test/npm/@lakutata/cli)
-[![NPM Download](https://img.shields.io/npm/dm/@lakutata/cli?style=flat-square)](https://npmjs.org/package/@lakutata/cli)
+> TODO: description
 
-## Install
+## Usage
 
-    npm install -g @lakutata/cli
-
-## Quickstart
-
-Follow the commands listed below.
-
-```bash
-$ cd target-directory
-$ lakutata
 ```
+const cli = require('@lakutata/cli');
 
-> Node.js >= 12.22.1 required.
-
-## How to Contribute
-
-Please let us know how can we help. Do check out [issues](https://gitee.com/nnxr/lakutata-cli/issues) for bug reports or suggestions first.
-
-## License
-
-[MIT](LICENSE)
+// TODO: DEMONSTRATE API
+```

package/package.json

@@ -1,70 +1,42 @@
 {
   "name": "@lakutata/cli",
-  "version": "1.0.37",
-  "description": "Lakutata CLI Tool",
-  "main": "./build/CLI.js",
-  "types": "./build/CLI.d.ts",
-  "type": "commonjs",
+  "version": "2.1.0-alpha.4",
+  "description": "Lakutata CLI tool",
+  "keywords": [
+    "lakutata",
+    "cli",
+    "tool"
+  ],
+  "author": "myq1991 <myq1991@gmail.com>",
+  "homepage": "https://github.com/lakutata/lakutata-packages",
+  "license": "MIT",
   "bin": {
-    "lakutata": "./build/CLI.js",
-    "lakutata-deploy": "./build/Deploy.js"
-  },
-  "scripts": {
-    "clean": "shx rm -rf ./build",
-    "build": "tsc",
-    "rebuild": "npm run clean && npm run build",
-    "prepare": "npm run compile",
-    "compile": "npm run rebuild && shx rm -rf ./build/tests/*",
-    "link": "sudo npm link",
-    "unlink": "sudo npm r @lakutata/cli -g",
-    "test": "node -r ./node_modules/ts-node/register src/tests/**/*.spec.ts"
+    "lakutata": "./dist/CLIApp.js"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
+    "access": "public"
   },
   "repository": {
     "type": "git",
-    "url": "https://gitee.com/nnxr/lakutata-cli.git"
+    "url": "git+https://github.com/lakutata/lakutata-packages.git"
+  },
+  "scripts": {
+    "test": "node ./__tests__/@lakutata/cli.test.js"
+  },
+  "bugs": {
+    "url": "https://github.com/lakutata/lakutata-packages/issues"
   },
-  "homepage": "https://lakutata.com",
-  "keywords": [
-    "lakutata",
-    "cli"
-  ],
-  "author": "alex.ma",
-  "license": "MIT",
   "dependencies": {
-    "@types/args": "^5.0.0",
-    "args": "^5.0.3",
-    "inquirer": "^8.2.4",
-    "moment-timezone": "^0.5.34",
-    "package-json": "^7.0.0",
-    "semver": "^7.3.7",
-    "shelljs": "^0.8.5",
-    "simple-git": "^3.9.0",
-    "ts-morph": "^13.0.2"
+    "ansis": "^3.1.0",
+    "cli-spinners": "^2.9.2",
+    "cli-table3": "^0.6.4",
+    "commander": "^12.0.0",
+    "degit": "^2.8.4",
+    "log-update": "^6.0.0",
+    "pkg-dir": "^8.0.0"
   },
   "devDependencies": {
-    "@lakutata/core": "^1.0.49",
-    "@types/inquirer": "^8.1.3",
-    "@types/node": "^16.11.7",
-    "@types/semver": "^7.3.9",
-    "@types/shelljs": "^0.8.10",
-    "@types/update-notifier": "^5.1.0",
-    "@typescript-eslint/eslint-plugin": "^4.27.0",
-    "@typescript-eslint/parser": "^4.27.0",
-    "eslint": "^7.32.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.2.0",
-    "eslint-plugin-typescript": "^0.14.0",
-    "shx": "^0.3.4",
-    "ts-node": "^10.9.1",
-    "typescript": "~4.7.4"
+    "@types/degit": "^2.8.6"
   },
-  "engines": {
-    "node": ">=12.22.1"
-  }
+  "gitHead": "cbbd971a6d3e9d52e470da5971de114b8d9cc09f"
 }

package/src/CLIApp.ts

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+
+import {Command} from 'commander'
+import {CommandLineController} from './controllers/CommandLineController'
+import {Information} from './lib/providers/Information'
+import {
+    name as packageName,
+    version as packageVersion,
+    description as packageDescription,
+    license as packageLicense
+} from 'lakutata/package.json'
+import {Creator} from './lib/providers/Creator'
+import {DeGitPuller} from './lib/components/DeGitPuller'
+import {Spinner} from './lib/components/Spinner'
+import {dots} from 'cli-spinners'
+import {Application, ApplicationOptions, JSONSchema, Module} from 'lakutata'
+import {
+    BuildCLIEntrypoint,
+    BuildEntrypoints,
+    CLIContext,
+    CLIEntrypointHandler,
+    CLIMap,
+    EntrypointDestroyerRegistrar
+} from 'lakutata/com/entrypoint'
+
+Application.run(async (): Promise<ApplicationOptions> => ({
+    id: 'cli.lakutata.app',
+    name: 'Lakutata-CLI',
+    components: {
+        puller: {
+            class: DeGitPuller,
+            cache: false,
+            verbose: true,
+            force: true,
+            repo: 'lakutata/lakutata-template'
+        },
+        spinner: {
+            class: Spinner,
+            style: dots
+        },
+        entrypoint: BuildEntrypoints({
+            cli: BuildCLIEntrypoint((module: Module, cliMap: CLIMap, handler: CLIEntrypointHandler, registerDestroy: EntrypointDestroyerRegistrar) => {
+                const CLIProgram: Command = new Command()
+                cliMap.forEach((dtoJsonSchema: JSONSchema, command: string): void => {
+                    const cmd: Command = new Command(command).description(dtoJsonSchema.description!)
+                    for (const property in dtoJsonSchema.properties) {
+                        const attr: JSONSchema = dtoJsonSchema.properties[property]
+                        const optionsArgs: [string, string | undefined] = [`--${property} <${attr.type}>`, attr.description]
+                        if (Array.isArray(dtoJsonSchema.required) && dtoJsonSchema.required.includes(property)) {
+                            optionsArgs[1] = `(required) ${optionsArgs[1]}`
+                            cmd.requiredOption(...optionsArgs)
+                        } else {
+                            cmd.option(...optionsArgs)
+                        }
+                    }
+                    cmd.action(async (args): Promise<any> => await handler(new CLIContext({
+                        command: command,
+                        data: args
+                    })))
+                    CLIProgram.addCommand(cmd)
+                })
+                CLIProgram.parse()
+            })
+        })
+    },
+    providers: {
+        creator: {
+            class: Creator
+        },
+        info: {
+            class: Information,
+            name: packageName,
+            version: packageVersion,
+            description: packageDescription,
+            license: packageLicense,
+            currentDirectory: __dirname,
+            workingDirectory: process.cwd()
+        }
+    },
+    controllers: [CommandLineController],
+    bootstrap: ['entrypoint']
+}))
+    .onUncaughtException((error: Error) => {
+        console.error(`error: ${error.message}`)
+        return process.exit(1)
+    })

package/src/controllers/CommandLineController.ts

@@ -0,0 +1,34 @@
+import {CreateProjectOptions} from '../options/CreateProjectOptions'
+import {LakutataInfoOptions} from '../options/LakutataInfoOptions'
+import {Information} from '../lib/providers/Information'
+import {Creator} from '../lib/providers/Creator'
+import {type ActionPattern, Controller} from 'lakutata'
+import {Inject} from 'lakutata/decorator/di'
+import {CLIAction} from 'lakutata/decorator/ctrl'
+
+export class CommandLineController extends Controller {
+
+    @Inject('creator')
+    protected readonly projectCreator: Creator
+
+    @Inject('info')
+    protected readonly frameworkInfo: Information
+
+    /**
+     * Create project
+     * @param inp
+     */
+    @CLIAction('create', CreateProjectOptions.description('create a Lakutata project'))
+    public async create(inp: ActionPattern<CreateProjectOptions>): Promise<void> {
+        await this.projectCreator.create(inp)
+    }
+
+    /**
+     * Show framework info
+     * @param inp
+     */
+    @CLIAction('info', LakutataInfoOptions.description('show Lakutata framework info'))
+    public async info(inp: ActionPattern<LakutataInfoOptions>): Promise<void> {
+        await this.frameworkInfo.print()
+    }
+}

package/src/lib/ProjectTypeConfig.ts

@@ -0,0 +1,20 @@
+interface ProjectTypeBranch {
+    [type: string]: {
+        branch: string
+    }
+}
+
+export const ProjectTypeConfig: ProjectTypeBranch = {
+    plain: {
+        branch: 'main'
+    },
+    cli: {
+        branch: 'cli'
+    },
+    api: {
+        branch: 'api'
+    },
+    electron: {
+        branch: 'electron'
+    }
+}

package/src/lib/SpecialChar.ts

@@ -0,0 +1,8 @@
+/**
+ * ✓
+ */
+export const charCheck: string = '\u2713'
+/**
+ * ✗
+ */
+export const charCross: string = '\u2717'

package/src/lib/components/DeGitPuller.ts

@@ -0,0 +1,41 @@
+import degit from 'degit'
+import {Configurable, Singleton} from 'lakutata/decorator/di'
+import {Component, DTO} from 'lakutata'
+
+
+@Singleton()
+export class DeGitPuller extends Component {
+
+    @Configurable(DTO.Boolean().optional().default(false))
+    protected readonly cache: boolean = false
+
+    @Configurable(DTO.Boolean().optional().default(true))
+    protected readonly verbose: boolean = true
+
+    @Configurable(DTO.Boolean().optional().default(true))
+    protected readonly force: boolean = true
+
+    @Configurable(DTO.String().required())
+    protected readonly repo: string
+
+    /**
+     * get git source
+     * @param branch
+     */
+    public getGitSource(branch: string): string {
+        return `${this.repo}#${branch}`
+    }
+
+    /**
+     * Exec pull
+     * @param branch
+     * @param localTarget
+     */
+    public async pull(branch: string, localTarget: string): Promise<void> {
+        await degit(this.getGitSource(branch), {
+            cache: this.cache,
+            verbose: this.verbose,
+            force: this.force
+        }).clone(localTarget)
+    }
+}

package/src/lib/components/Spinner.ts

@@ -0,0 +1,48 @@
+import {type Spinner as CliSpinner, dots} from 'cli-spinners'
+import {Configurable, Singleton} from 'lakutata/decorator/di'
+import {Component} from 'lakutata'
+import {As} from 'lakutata/helper'
+
+@Singleton()
+export class Spinner extends Component {
+
+    @Configurable()
+    protected readonly style: CliSpinner = dots
+
+    protected spinnerInterval: NodeJS.Timeout | null = null
+
+    protected logUpdate: any
+
+    /**
+     * Initializer
+     * @protected
+     */
+    protected async init(): Promise<void> {
+        this.logUpdate = As(await import('log-update'))
+    }
+
+    /**
+     * Start spinner
+     * @param description
+     */
+    public start(description?: string | (() => string)): void {
+        this.stop()
+        let i: number = 0
+        this.spinnerInterval = setInterval((): void => {
+            const {frames} = this.style
+            const text: string = description ? `${frames[i = ++i % frames.length]} ${typeof description === 'function' ? description() : description}` : frames[i = ++i % frames.length]
+            this.logUpdate(text)
+        }, dots.interval)
+    }
+
+    /**
+     * Stop spinner
+     */
+    public stop(): void {
+        if (this.spinnerInterval) {
+            clearInterval(this.spinnerInterval)
+            this.spinnerInterval = null
+            this.logUpdate.clear()
+        }
+    }
+}

package/src/lib/providers/Creator.ts

@@ -0,0 +1,125 @@
+import {Information} from './Information.js'
+import {DeGitPuller} from '../components/DeGitPuller.js'
+import {Spinner} from '../components/Spinner.js'
+import {CreateProjectOptions} from '../../options/CreateProjectOptions.js'
+import {ProjectTypeConfig} from '../ProjectTypeConfig.js'
+import path from 'node:path'
+import {mkdir, readdir, stat} from 'node:fs/promises'
+import {Stats} from 'node:fs'
+import {charCheck, charCross} from '../SpecialChar.js'
+import {Application, Provider} from 'lakutata'
+import {Inject} from 'lakutata/decorator/di'
+import {Logger} from 'lakutata/com/logger'
+import {IsExists} from 'lakutata/helper'
+import {Accept} from 'lakutata/decorator/dto'
+import ansis from 'ansis'
+import CLITable from 'cli-table3'
+
+export class Creator extends Provider {
+
+    @Inject(Application)
+    protected readonly app: Application
+
+    @Inject('log')
+    protected readonly log: Logger
+
+    @Inject('spinner')
+    protected readonly spinner: Spinner
+
+    @Inject('puller')
+    protected readonly puller: DeGitPuller
+
+    @Inject('info')
+    protected readonly frameworkInfo: Information
+
+    /**
+     * Check if the target path exists
+     * @param targetDirectory
+     * @param initOnly
+     * @protected
+     */
+    protected async checkTargetPathExistence(targetDirectory: string, initOnly: boolean): Promise<void> {
+        const exists: boolean = await IsExists(targetDirectory)
+        if (!exists && initOnly) {
+            this.log.error(`${charCross} The target path does not exist.`)
+            return this.app.exit(1)
+        }
+        await mkdir(targetDirectory, {recursive: true})
+        this.log.info(`${charCheck} The target path does not exist.`)
+    }
+
+    /**
+     * Check target path is a valid directory
+     * @param targetDirectory
+     * @protected
+     */
+    protected async checkTargetPathIsDirectory(targetDirectory: string): Promise<void> {
+        const targetInfo: Stats = await stat(targetDirectory)
+        if (!targetInfo.isDirectory()) {
+            this.log.error(`${charCross} The target path is not a valid directory.`)
+            return this.app.exit(1)
+        }
+        this.log.info(`${charCheck} The target path is a valid directory.`)
+    }
+
+    /**
+     * Check target directory is empty, if the target directory is not empty, throw error and exit
+     * @param targetDirectory
+     * @protected
+     */
+    protected async checkTargetDirectoryIsEmpty(targetDirectory: string): Promise<void> {
+        const files: string[] = await readdir(targetDirectory)
+        if (files.length) {
+            this.log.error(`${charCross} The target directory is not empty.`)
+            return this.app.exit(1)
+        }
+        this.log.info(`${charCheck} The target directory is empty.`)
+    }
+
+    /**
+     * Exec create
+     * @param options
+     */
+    @Accept(CreateProjectOptions.required())
+    public async create(options: CreateProjectOptions): Promise<void> {
+        const appName: string = options.name
+        const appId: string = options.id
+        const appDescription: string = options.description
+        const packageName: string = appId
+        const authorName: string = options.author
+        const licenseName: string = options.license
+        const appType: string = options.type
+        const targetPath: string = options.initOnly ? path.resolve(options.path) : path.resolve(options.path, options.name)
+        const {branch} = ProjectTypeConfig[appType]
+        const table: CLITable.Table = new CLITable()
+        table.push(
+            [{content: ansis.bold.cyan('Project Creation Information'), colSpan: 2, hAlign: 'center'}],
+            [ansis.blue('APP ID & Project Name'), appId],
+            [ansis.blue('APP Name'), appName],
+            [ansis.blue('APP Description'), appDescription],
+            [ansis.blue('Project Create Target Path'), targetPath],
+            [ansis.blue('Project Create Mode'), options.initOnly ? ansis.yellow('Initialize project in an existing directory') : ansis.green('Create a new folder for the project')],
+            [ansis.blue('Project Author Name'), authorName],
+            [ansis.blue('Project License'), licenseName],
+            [ansis.blue('Project Template Branch'), this.puller.getGitSource(branch)]
+        )
+        console.log(table.toString())
+        await new Promise<void>(resolve => {
+            let timeLeft: number = 15
+            const interval: NodeJS.Timeout = setInterval((): void => {
+                timeLeft -= 1
+                if (!timeLeft) {
+                    clearInterval(interval)
+                    this.spinner.stop()
+                    return resolve()
+                }
+            }, 1000)
+            this.spinner.start((): string => `Please confirm the project creation information; the creation process will commence in ${timeLeft} seconds.`)
+        })
+        await this.checkTargetPathExistence(targetPath, options.initOnly)
+        await this.checkTargetPathIsDirectory(targetPath)
+        await this.checkTargetDirectoryIsEmpty(targetPath)
+        this.log.info('Begin project creation')
+        //TODO
+    }
+}