@galacean/cli 0.0.1-0

package/README.md

@@ -0,0 +1,66 @@
+Galacean CLI
+=================
+
+The all-in-one Galacean CLI that helps you build Galacean applications.
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @galacean/cli
+$ galacean COMMAND
+running command...
+$ galacean (--version)
+@galacean/cli/0.0.1-0 darwin-x64 node-v16.17.0
+$ galacean --help [COMMAND]
+USAGE
+  $ galacean COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`galacean generate NAME`](#galacean-generate-name)
+* [`galacean help [COMMANDS]`](#galacean-help-commands)
+
+## `galacean generate NAME`
+
+generate a new Galacean Editor plugin
+
+```
+USAGE
+  $ galacean generate NAME
+
+ARGUMENTS
+  NAME  directory name of new plugin
+
+DESCRIPTION
+  generate a new Galacean Editor plugin
+  This will clone the specific folder in 'galacean/galacean-editor-plugin-examples' and update package properties
+```
+
+_See code: [dist/commands/generate.ts](https://github.com/galacean/cli/blob/v0.0.1-0/dist/commands/generate.ts)_
+
+## `galacean help [COMMANDS]`
+
+Display help for galacean.
+
+```
+USAGE
+  $ galacean help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for galacean.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.14/src/commands/help.ts)_
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({ project })
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/commands/generate.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+export default class Generate extends Command {
+    static description: string;
+    static flags: {};
+    static args: {
+        name: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+    };
+    protected generate(type?: string, generatorOptions?: Record<string, unknown>): Promise<void>;
+    run(): Promise<void>;
+}

package/dist/commands/generate.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const yeoman_environment_1 = require("yeoman-environment");
+class Generate extends core_1.Command {
+    async generate(type = 'plugin', generatorOptions = {}) {
+        const env = (0, yeoman_environment_1.createEnv)();
+        env.register(require.resolve(`../generators/${type}`), `galacean:${type}`);
+        await env.run(`galacean:${type}`, generatorOptions);
+    }
+    async run() {
+        const { args } = await this.parse(Generate);
+        await this.generate('plugin', { name: args.name, force: true });
+    }
+}
+exports.default = Generate;
+Generate.description = `generate a new Galacean Editor plugin
+This will clone the specific folder in 'galacean/galacean-editor-plugin-examples' and update package properties`;
+Generate.flags = {};
+Generate.args = {
+    name: core_1.Args.string({ required: true, description: 'directory name of new plugin' }),
+};

package/dist/generators/plugin.d.ts

@@ -0,0 +1,33 @@
+import * as Generator from 'yeoman-generator';
+export default class PluginGenerator extends Generator {
+    options: {
+        force: boolean;
+    };
+    exampleRepoUrl: string;
+    name: string;
+    pjson: any;
+    githubUser: string;
+    answers: {
+        name: string;
+        bin: string;
+        description: string;
+        version: string;
+        github: {
+            repo: string;
+            user: string;
+        };
+        author: string;
+        files: string;
+        license: string;
+        galacean: string;
+        pkg: string;
+        typescript: boolean;
+        eslint: boolean;
+    };
+    repository?: string;
+    constructor(args: string | string[], opts: Generator.GeneratorOptions);
+    prompting(): Promise<void>;
+    writing(): void;
+    end(): void;
+    private _gitignore;
+}

package/dist/generators/plugin.js

@@ -0,0 +1,173 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const fs = require("fs");
+const _ = require("lodash");
+const path = require("path");
+const nodeDebug = require("debug");
+const Generator = require("yeoman-generator");
+const debug = nodeDebug('galacean-plugin-generator');
+const { version } = require('../../package.json');
+class PluginGenerator extends Generator {
+    constructor(args, opts) {
+        super(args, opts);
+        this.exampleRepoUrl = 'https://github.com/galacean/galacean-editor-plugin-examples';
+        this.githubUser = '';
+        this.name = opts.name;
+        this.options.force = opts.force;
+    }
+    async prompting() {
+        this.log(`Galacean Editor Plugin Generator. version: ${version}`);
+        const { pluginType } = await this.prompt([
+            {
+                type: 'list',
+                name: 'pluginType',
+                message: 'Select a plugin type',
+                choices: [
+                    { name: 'Basic', value: 'basic' },
+                    { name: 'React', value: 'react' },
+                ],
+                default: 'blank',
+            },
+        ]);
+        const targetDir = path.resolve(this.name);
+        (0, child_process_1.execSync)(`git clone ${this.exampleRepoUrl} "${targetDir}" --depth=1`);
+        for (const f of fs.readdirSync(path.resolve(this.name)).filter(file => file !== pluginType)) {
+            const p = `${path.resolve(this.name, f)}`;
+            this.log(p);
+            fs.rmSync(p, { recursive: true, force: true });
+        }
+        (0, child_process_1.execSync)(`mv ${path.resolve(this.name, pluginType, '*')} ${path.resolve(this.name)}`);
+        fs.rmSync(`${path.resolve(this.name, pluginType)}`, { recursive: true, force: true });
+        this.destinationRoot(path.resolve(this.name));
+        this.env.cwd = this.destinationPath();
+        try {
+            this.githubUser = await this.user.github.username();
+        }
+        catch (error) {
+            debug(error);
+        }
+        this.pjson = {
+            name: '',
+            version: '',
+            description: '',
+            author: '',
+            bin: {},
+            homepage: '',
+            license: '',
+            main: '',
+            repository: '',
+            files: [],
+            dependencies: {},
+            devDependencies: {},
+            galacean: '',
+            scripts: {},
+            engines: {},
+            ...this.fs.readJSON(path.join(this.env.cwd, 'package.json'), {}),
+        };
+        let repository = this.destinationRoot().split(path.sep).slice(-2).join('/');
+        if (this.githubUser) {
+            repository = `${this.githubUser}/${repository.split('/')[1]}`;
+        }
+        const defaults = {
+            ...this.pjson,
+            name: (this.name || this.determineAppname()).replace(/ /g, '-'),
+            version: '0.0.0',
+            license: 'MIT',
+            author: this.githubUser ? `${this.user.git.name()} @${this.githubUser}` : this.user.git.name(),
+            dependencies: {},
+            repository,
+            engines: {
+                node: '>=12.0.0',
+                ...this.pjson.engines,
+            },
+        };
+        this.repository = defaults.repository;
+        if (this.repository && this.repository.url) {
+            this.repository = this.repository.url;
+        }
+        this.answers = await this.prompt([
+            {
+                type: 'input',
+                name: 'name',
+                message: 'plugin package name',
+                default: defaults.name,
+            },
+            {
+                type: 'input',
+                name: 'description',
+                message: 'description',
+                default: defaults.description,
+            },
+            {
+                type: 'input',
+                name: 'author',
+                message: 'author',
+                default: defaults.author,
+            },
+            {
+                type: 'input',
+                name: 'galacean',
+                message: 'The minimum version of Galacean that this plugin supports',
+                default: defaults.galacean,
+            },
+            {
+                type: 'input',
+                name: 'license',
+                message: 'license',
+                default: defaults.license,
+            },
+            {
+                type: 'input',
+                name: 'github.user',
+                message: 'Who is the GitHub owner of repository (https://github.com/OWNER/repo)',
+                default: repository.split('/').slice(0, -1).pop(),
+            },
+            {
+                type: 'input',
+                name: 'github.repo',
+                message: 'What is the GitHub name of repository (https://github.com/owner/REPO)',
+                default: (answers) => (answers.name || this.pjson.repository || this.pjson.name).split('/').pop(),
+            },
+        ]);
+        debug(this.answers);
+        this.pjson.name = this.answers.name || defaults.name;
+        this.pjson.description = this.answers.description || defaults.description;
+        this.pjson.version = this.answers.version || defaults.version;
+        this.pjson.engines.node = defaults.engines.node;
+        this.pjson.author = this.answers.author || defaults.author;
+        this.pjson.files = this.answers.files || defaults.files || '/lib';
+        this.pjson.license = this.answers.license || defaults.license;
+        // eslint-disable-next-line no-multi-assign
+        this.repository = this.pjson.repository = this.answers.github ? `${this.answers.github.user}/${this.answers.github.repo}` : defaults.repository;
+        this.pjson.homepage = `https://github.com/${this.repository}`;
+        this.pjson.bugs = `https://github.com/${this.repository}/issues`;
+    }
+    writing() {
+        this.pjson.files = _.uniq((this.pjson.files || []).sort());
+        this.fs.writeJSON(this.destinationPath('./package.json'), this.pjson);
+        this.fs.write(this.destinationPath('.gitignore'), this._gitignore());
+        this.fs.delete(this.destinationPath('LICENSE'));
+    }
+    end() {
+        this.spawnCommandSync(this.env.options.nodePackageManager, ['run', 'build'], { cwd: this.env.cwd });
+        this.log(`\nCreated ${this.pjson.name} in ${this.destinationRoot()}`);
+    }
+    _gitignore() {
+        const existing = this.fs.exists(this.destinationPath('.gitignore')) ? this.fs.read(this.destinationPath('.gitignore')).split('\n') : [];
+        return _([
+            '*-debug.log',
+            '*-error.log',
+            'node_modules',
+            '/tmp',
+            '/dist',
+            '/lib',
+        ])
+            .concat(existing)
+            .compact()
+            .uniq()
+            .sort()
+            .join('\n') + '\n';
+    }
+}
+exports.default = PluginGenerator;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/oclif.manifest.json

@@ -0,0 +1,22 @@
+{
+  "version": "0.0.1-0",
+  "commands": {
+    "generate": {
+      "id": "generate",
+      "description": "generate a new Galacean Editor plugin\nThis will clone the specific folder in 'galacean/galacean-editor-plugin-examples' and update package properties",
+      "strict": true,
+      "pluginName": "@galacean/cli",
+      "pluginAlias": "@galacean/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {},
+      "args": {
+        "name": {
+          "name": "name",
+          "description": "directory name of new plugin",
+          "required": true
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@galacean/cli",
+  "version": "0.0.1-0",
+  "description": "All-in-one cli tool that help you using Galacean Framework.",
+  "author": "Kbscript @MrKou47",
+  "bin": {
+    "galacean": "./bin/run"
+  },
+  "homepage": "https://github.com/galacean/cli",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": "galacean/cli",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^2",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^2.4.7",
+    "yeoman-environment": "^3.19.3",
+    "yeoman-generator": "^5.9.0"
+  },
+  "devDependencies": {
+    "@oclif/test": "^2.4.0",
+    "@types/chai": "^4",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.18.39",
+    "@types/yeoman-generator": "^5.2.11",
+    "chai": "^4",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.3",
+    "mocha": "^9",
+    "oclif": "^3.10.0",
+    "shx": "^0.3.3",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.6.1",
+    "typescript": "^4.9.5"
+  },
+  "oclif": {
+    "bin": "galacean",
+    "dirname": "galacean",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help"
+    ]
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "npm run build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "bugs": "https://github.com/galacean/cli/issues",
+  "keywords": [
+    "galacean",
+    "cli",
+    "plugin"
+  ],
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  }
+}