@gjsify/cli 0.0.1-b → 0.0.2

package/package.json

@@ -1,90 +1,39 @@
 {
   "name": "@gjsify/cli",
-  "description": "Command line tool for gjsify",
-  "version": "0.0.1-b",
-  "author": "Pascal Garber <pascal@artandcode.studio>",
+  "version": "0.0.2",
+  "description": "CLI for Gjsify",
+  "type": "module",
+  "main": "lib/index.js",
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
   "bin": {
-    "gjsify": "./bin/run"
-  },
-  "bugs": "https://github.com/gjsify/cli/issues",
-  "dependencies": {
-    "@gjsify/console": "0.0.1",
-    "@gjsify/fs": "0.0.1",
-    "@gjsify/os": "0.0.1",
-    "@gjsify/path": "0.0.1",
-    "@gjsify/process": "0.0.1",
-    "@oclif/command": "^1",
-    "@oclif/config": "^1",
-    "@oclif/plugin-help": "^2",
-    "assert": "^2.0.0",
-    "browserify-zlib": "^0.2.0",
-    "buffer": "^5.4.3",
-    "constants-browserify": "^1.0.0",
-    "crypto-browserify": "^3.12.0",
-    "domain-browser": "^3.5.0",
-    "events": "^3.1.0",
-    "inherits": "^2.0.4",
-    "json-loader": "^0.5.7",
-    "punycode": "^2.1.1",
-    "querystring-es3": "^0.2.1",
-    "stream-browserify": "^2.0.2",
-    "string_decoder": "^1.3.0",
-    "terser-webpack-plugin": "^2.3.5",
-    "ts-loader": "^6.2.1",
-    "tslib": "^1",
-    "tty-browserify": "0.0.1",
-    "url": "^0.11.0",
-    "util": "^0.12.2",
-    "webpack": "^4.41.6"
+    "gjsify": "./lib/index.js"
   },
-  "devDependencies": {
-    "@oclif/dev-cli": "^1",
-    "@oclif/test": "^1",
-    "@types/chai": "^4",
-    "@types/mocha": "^5",
-    "@types/node": "^10",
-    "@types/terser-webpack-plugin": "^2.2.0",
-    "@types/webpack": "^4.41.6",
-    "chai": "^4",
-    "eslint": "^5.13",
-    "eslint-config-oclif": "^3.1",
-    "eslint-config-oclif-typescript": "^0.1",
-    "globby": "^10",
-    "mocha": "^5",
-    "nyc": "^14",
-    "ts-node": "^8",
-    "typescript": "^3.3"
-  },
-  "engines": {
-    "node": ">=8.0.0"
+  "scripts": {
+    "clear": "rm -rf lib tsconfig.tsbuildinfo tsconfig.types.tsbuildinfo || exit 0",
+    "print:name": "echo '@gjsify/cli'",
+    "start": "node lib/index.js",
+    "build": "yarn print:name && tsc && yarn chmod",
+    "chmod": "chmod +x ./lib/index.js"
   },
-  "files": [
-    "/bin",
-    "/lib",
-    "/npm-shrinkwrap.json",
-    "/oclif.manifest.json"
-  ],
-  "homepage": "https://github.com/gjsify/cli",
   "keywords": [
-    "oclif"
+    "gjs",
+    "node",
+    "gjsify",
+    "cli"
   ],
-  "license": "MIT",
-  "main": "lib/index.js",
-  "oclif": {
-    "commands": "./lib/commands",
-    "bin": "gjsify",
-    "plugins": [
-      "@oclif/plugin-help"
-    ]
-  },
-  "repository": "gjsify/cli",
-  "scripts": {
-    "postpack": "rm -f oclif.manifest.json",
-    "posttest": "eslint . --ext .ts --config .eslintrc",
-    "prepack": "rm -rf lib && npm run build && oclif-dev manifest && oclif-dev readme",
-    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif-dev readme && git add README.md",
-    "build": "tsc -b"
+  "dependencies": {
+    "@gjsify/esbuild-plugin-deepkit": "^0.0.2",
+    "@gjsify/esbuild-plugin-gjsify": "^0.0.2",
+    "cosmiconfig": "^8.2.0",
+    "esbuild": "^0.18.2",
+    "get-tsconfig": "^4.6.0",
+    "lodash": "^4.17.21",
+    "pkg-types": "^1.0.3",
+    "yargs": "^17.7.2"
   },
-  "types": "lib/index.d.ts"
-}
+  "devDependencies": {
+    "@types/yargs": "^17.0.24",
+    "typescript": "^5.1.3"
+  }
+}

package/src/actions/build.ts

@@ -0,0 +1,117 @@
+import type { ConfigData } from '../types/index.js';
+import type { App } from '@gjsify/esbuild-plugin-gjsify';
+import { build, analyzeMetafile, BuildOptions, BuildResult } from 'esbuild';
+import { gjsifyPlugin } from '@gjsify/esbuild-plugin-gjsify';
+import { dirname, extname } from 'path';
+import { writeFile } from 'fs/promises';
+
+export class BuildAction {
+    constructor(readonly configData: ConfigData = {}) {
+
+    }
+
+    getEsBuildDefaults() {
+        const defaults: BuildOptions = {
+            allowOverwrite: true
+        }
+        return defaults;
+    }
+
+    /** Library mode */
+    async buildLibrary() {
+        let { verbose, library, esbuild, typescript, exclude } = this.configData;
+        library ||= {};
+        esbuild ||= {};
+        typescript ||= {};
+
+        const moduleOutdir = library?.module ? dirname(library.module) : undefined;
+        const mainOutdir = library?.main ? dirname(library.main) : undefined;
+
+        const moduleOutExt = library.module ? extname(library.module) : '.js';
+        const mainOutExt = library.main ? extname(library.main) : '.js';
+
+        const multipleBuilds = moduleOutdir && mainOutdir && (moduleOutdir !== mainOutdir);
+
+        const results: BuildResult[] = [];
+    
+        if(multipleBuilds) {
+
+            const moduleFormat = moduleOutdir.includes('/cjs') || moduleOutExt === '.cjs' ? 'cjs' : 'esm';
+            results.push(await build({
+                ...this.getEsBuildDefaults(),
+                ...esbuild,
+                format: moduleFormat,
+                outdir: moduleOutdir,
+                plugins: [
+                    gjsifyPlugin({debug: verbose, library: moduleFormat, exclude, reflection: typescript?.reflection, jsExtension: moduleOutExt}),
+                ]
+            }));
+    
+            const mainFormat = mainOutdir.includes('/cjs') || mainOutExt === '.cjs' ? 'cjs' : 'esm';
+            results.push(await build({
+                ...this.getEsBuildDefaults(),
+                ...esbuild,
+                format: moduleFormat,
+                outdir: mainOutdir,
+                plugins: [
+                    gjsifyPlugin({debug: verbose, library: mainFormat, exclude, reflection: typescript?.reflection, jsExtension: mainOutdir})
+                ]
+            }));
+        } else {
+            const outfilePath = esbuild?.outfile || library?.module || library?.main;
+            const outExt = outfilePath ? extname(outfilePath) : '.js';
+            const outdir = esbuild?.outdir || (outfilePath ? dirname(outfilePath) : undefined);
+            const format = esbuild?.format || outdir?.includes('/cjs') || outExt === '.cjs' ? 'cjs' : 'esm';
+            results.push(await build({
+                ...this.getEsBuildDefaults(),
+                ...esbuild,
+                format,
+                outdir,
+                plugins: [
+                    gjsifyPlugin({debug: verbose, library: format, exclude, reflection: typescript?.reflection, jsExtension: outExt})
+                ]
+            }));
+        }
+        return results;
+    }
+
+    /** Application mode */
+    async buildApp(app: App = 'gjs') {
+
+        const { verbose, esbuild, typescript, exclude } = this.configData;
+
+        const format: 'cjs' | 'esm' = esbuild?.format || esbuild?.outfile?.endsWith('.cjs') ? 'cjs' : 'esm';
+
+        const result = await build({
+            ...this.getEsBuildDefaults(),
+            ...esbuild,
+            format,
+            plugins: [
+                gjsifyPlugin({debug: verbose, app, format, exclude, reflection: typescript?.reflection}),
+            ]
+        });
+
+        // See https://esbuild.github.io/api/#metafile
+        // TODO add cli options for this 
+        // if(result.metafile) {
+        //     const outFile = esbuild?.outfile ? esbuild.outfile + '.meta.json' : 'meta.json';
+        //     await writeFile(outFile, JSON.stringify(result.metafile));
+
+        //     let text = await analyzeMetafile(result.metafile)
+        //     console.log(text)
+        // }
+
+        return [result];
+    }
+
+    async start(buildType: {library?: boolean, app?: App} = {app: 'gjs'}) {
+        const results: BuildResult[] = [];
+        if(buildType.library) {
+            results.push(...(await this.buildLibrary()));
+        } else {
+            results.push(...(await this.buildApp(buildType.app)));
+        }
+
+        return results;
+    }
+}

package/src/actions/index.ts

@@ -0,0 +1 @@
+export * from './build.js';

package/src/commands/build.ts

@@ -0,0 +1,80 @@
+import { Config } from '../config.js';
+import { BuildAction } from '../actions/build.js';
+import type { Command, CliBuildOptions } from '../types/index.js';
+
+export const buildCommand: Command<any, CliBuildOptions> = {
+    command: 'build [entryPoints..]',
+    description: 'Build and bundle your Gjs project',
+    builder: (yargs) => {
+        return yargs
+            .option('entry-points', {
+                description: "The entry points you want to bundle",
+                array: true,
+                type: 'string',
+                normalize: true,
+                default: ['src/index.ts'],
+                coerce: (arg: string[]) => {
+                    // Removes duplicates
+                    return [...new Set(arg)];
+                }
+            })
+            .option('exclude', {
+                description: "An array of glob patterns to exclude entry-points and aliases",
+                array: true,
+                type: 'string',
+                normalize: true,
+                default: []
+            })
+            .option('verbose', {
+                description: "Switch on the verbose mode",
+                type: 'boolean',
+                normalize: true,
+                default: false
+            })
+            .option('app', {
+                description: "Use this if you want to build a application, the application platforms node and deno are usually only used for tests",
+                type: 'string',
+                choices: ['gjs', 'node', 'deno', 'browser'],
+                normalize: true,
+                default: 'gjs'
+            })
+            .option('library', {
+                description: "Use this if you want to build a library for Gjsify",
+                type: 'boolean',
+                normalize: true,
+                default: false
+            })
+            .option('outfile', {
+                description: "Sets the output file name for the build operation. If no outfile is specified, the outfile will be parsed from the package.json. Only used if application mode is active",
+                type: 'string',
+                normalize: true,
+            })
+            .option('outdir', {
+                description: "Sets the output directory for the build operation. If no outdir is specified, the outdir will be parsed from the package.json. Only used if library mode is active",
+                type: 'string',
+                normalize: true,
+            })
+            .option('reflection', {
+                description: "Enables TypeScript types on runtime using Deepkit's type compiler",
+                type: 'boolean',
+                normalize: true,
+                default: false
+            })
+            .option('log-level', {
+                description: "The log level can be changed to prevent esbuild from printing warning and/or error messages to the terminal",
+                type: 'string',
+                choices: ['silent', 'error', 'warning', 'info', 'debug', 'verbose'],
+                normalize: true,
+                default: 'warning'
+            })
+    },
+    handler: async (args) => {
+        const config = new Config();
+        const configData = await config.forBuild(args);
+        const action = new BuildAction(configData);
+        await action.start({
+            library: args.library,
+            app: args.app,
+        })
+    }
+}

package/src/commands/index.ts

@@ -0,0 +1 @@
+export * from './build.js';

package/src/config.ts

@@ -0,0 +1,80 @@
+import { APP_NAME } from  './constants.js';
+import { cosmiconfig, Options as LoadOptions } from 'cosmiconfig';
+import { readPackageJSON, resolvePackageJSON } from 'pkg-types';
+import { getTsconfig } from 'get-tsconfig';
+import lodash from "lodash";
+const { merge } = lodash;
+
+import type { CliBuildOptions, ConfigData, CosmiconfigResult, ConfigDataTypescript, ConfigDataLibrary} from './types/index.js';
+import type { ArgumentsCamelCase } from 'yargs';
+
+export class Config {
+
+    readonly loadOptions: LoadOptions = {
+        searchPlaces: [APP_NAME]
+    }
+
+    constructor(loadOptions: LoadOptions = {}) {
+        if(Object.keys(loadOptions).length) {
+            this.loadOptions = loadOptions;
+        }
+    }
+
+    /** Loads gjsify config file, e.g `gjsify.js` */
+    private async load(searchFrom?: string) {        
+        let configFile = await cosmiconfig(APP_NAME, this.loadOptions).search(searchFrom) as CosmiconfigResult<ConfigData> | null;
+
+        configFile ||= {
+            config: {},
+            filepath: '',
+            isEmpty: true,
+        }
+
+        configFile.config ||= {};
+        configFile.config.esbuild ||= {};
+        configFile.config.library ||= {};
+        configFile.config.typescript ||= {};
+        return configFile;
+    }
+
+    /** Loads package.json of the current project */
+    private async readPackageJSON(dirPath?: string) {   
+        dirPath = await resolvePackageJSON(dirPath)     
+        const pkg = await readPackageJSON(dirPath);
+        return pkg;
+    }
+
+    /** Loads tsconfig.json of the current project */
+    private async readTSConfig(dirPath?: string) {     
+        const tsconfig = getTsconfig(dirPath)?.config || {};
+        return tsconfig;
+    }
+
+    async forBuild(cliArgs: ArgumentsCamelCase<CliBuildOptions>) {
+        const configFile = await this.load(process.cwd());
+        const configData: ConfigData = {...configFile.config};
+        const configFilePath = configFile.filepath || process.cwd();
+        const pkg = await this.readPackageJSON(configFilePath) as ConfigDataLibrary;
+        const tsConfig = await this.readTSConfig(configFilePath) as ConfigDataTypescript;
+
+        tsConfig.reflection ||= cliArgs.reflection;
+
+        // TODO replace with `cliArgs.logLevel`
+        configData.verbose = cliArgs.verbose || false;
+        configData.exclude = cliArgs.exclude || [];
+
+        merge(configData.library, pkg, configData.library);
+        merge(configData.typescript, tsConfig, configData.typescript);
+        merge(configData.esbuild, {
+            entryPoints: cliArgs.entryPoints,
+            outfile: cliArgs.outfile,
+            outdir: cliArgs.outdir,
+            logLevel: cliArgs.logLevel || 'warning'
+        });
+
+        if(configData.verbose) console.debug("configData", configData);
+
+        return configData;
+
+    }
+}

package/src/constants.ts

@@ -0,0 +1 @@
+export const APP_NAME = 'gjsify'

package/src/index.ts

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import yargs from 'yargs'
+import { hideBin } from 'yargs/helpers'
+
+import { buildCommand as build } from './commands/index.js'
+import { APP_NAME } from './constants.js'
+
+void yargs(hideBin(process.argv))
+    .scriptName(APP_NAME)
+    .strict()
+    // .usage(Config.usage)
+    .command(build.command, build.description, build.builder, build.handler)
+    .demandCommand(1)
+    .help().argv

package/src/types/cli-build-options.ts

@@ -0,0 +1,36 @@
+import type { App } from '@gjsify/esbuild-plugin-gjsify';
+
+export interface CliBuildOptions {
+  /**
+   * This is an array of files that each serve as an input to the bundling algorithm.
+   * @see https://esbuild.github.io/api/#entry-points
+   */
+  entryPoints?: string[];
+  /** Switch on the verbose mode */
+  verbose?: boolean;
+  /** Use this if you want to build a application or test, the platforms node and deno are usually only used internally to build the tests for Gjsify */
+  app?: App;
+  /** Use this if you want to build a library for Gjsify */
+  library?: boolean;
+  /**
+   * This option sets the output file name for the build operation.
+   * This is only applicable if there is a single entry point.
+   * If there are multiple entry points, you must use the outdir option instead to specify an output directory.
+   * @see https://esbuild.github.io/api/#outfile
+   */
+  outfile?: string;
+  /**
+   * This option sets the output directory for the build operation.
+   * @see https://esbuild.github.io/api/#outdir
+   */
+  outdir?: string;
+  /** Enables TypeScript types on runtime using Deepkit's type compiler */
+  reflection?: boolean;
+  /**
+   * The log level can be changed to prevent esbuild from printing warning and/or error messages to the terminal
+   * @see https://esbuild.github.io/api/#log-level
+   */
+  logLevel: 'silent' | 'error' | 'warning' | 'info' | 'debug' | 'verbose';
+  /** An array of glob patterns to exclude matches and aliases */
+  exclude?: string[];
+}

package/src/types/command.ts

@@ -0,0 +1,10 @@
+import type { ArgumentsCamelCase, MiddlewareFunction, BuilderCallback } from 'yargs';
+
+export interface Command <T = any, U = T> {
+    command: string | ReadonlyArray<string>,
+    description: string,
+    builder?: BuilderCallback<T, U>,
+    handler?: (args: ArgumentsCamelCase<U>) => void | Promise<void>,
+    middlewares?: MiddlewareFunction[],
+    deprecated?: boolean | string,
+}

package/src/types/config-data-library.ts

@@ -0,0 +1,5 @@
+import type { PackageJson } from 'pkg-types';
+
+export interface ConfigDataLibrary extends PackageJson {
+
+}

package/src/types/config-data-typescript.ts

@@ -0,0 +1,6 @@
+import type { TsConfigJsonResolved } from 'get-tsconfig';
+
+export interface ConfigDataTypescript extends TsConfigJsonResolved {
+    /** Enables TypeScript types on runtime using Deepkit's type compiler */
+    reflection?: boolean;
+}

package/src/types/config-data.ts

@@ -0,0 +1,12 @@
+import type { BuildOptions as EsbuildOptions} from 'esbuild';
+import type { ConfigDataLibrary, ConfigDataTypescript } from './index.js';
+
+export interface ConfigData {
+    /** Switch on the verbose mode */
+    verbose?: boolean;
+    esbuild?: EsbuildOptions;
+    library?: ConfigDataLibrary;
+    typescript?: ConfigDataTypescript;
+    /** An array of glob patterns to exclude matches and aliases */
+    exclude?: string[];
+}

package/src/types/cosmiconfig-result.ts

@@ -0,0 +1,5 @@
+export type CosmiconfigResult<C = any> = {
+    config: C;
+    filepath: string;
+    isEmpty?: boolean;
+} | null;

package/src/types/index.ts

@@ -0,0 +1,6 @@
+export * from './cli-build-options.js';
+export * from './command.js';
+export * from './config-data-library.js';
+export * from './config-data-typescript.js';
+export * from './config-data.js';
+export * from './cosmiconfig-result.js';

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "compilerOptions": {
+      "outDir": "lib",
+      "declarationDir": "lib",
+      "declaration": true,
+      "target": "ESNext",
+      "moduleResolution":"Node",
+      "allowSyntheticDefaultImports": true,
+      "strict": true
+    },
+    "files": ["src/index.ts"]
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 gjsify
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,79 +0,0 @@
-@gjsify/cli
-===========
-
-Command line tool for gjsify
-
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/@gjsify/cli.svg)](https://npmjs.org/package/@gjsify/cli)
-[![Downloads/week](https://img.shields.io/npm/dw/@gjsify/cli.svg)](https://npmjs.org/package/@gjsify/cli)
-[![License](https://img.shields.io/npm/l/@gjsify/cli.svg)](https://github.com/gjsify/cli/blob/master/package.json)
-
-<!-- toc -->
-* [Usage](#usage)
-* [Commands](#commands)
-* [CommonJS compatibility](#commonjs-compatibility)
-<!-- tocstop -->
-# Usage
-<!-- usage -->
-```sh-session
-$ npm install -g @gjsify/cli
-$ gjsify COMMAND
-running command...
-$ gjsify (-v|--version|version)
-@gjsify/cli/0.0.1-b linux-x64 node-v12.14.1
-$ gjsify --help [COMMAND]
-USAGE
-  $ gjsify COMMAND
-...
-```
-<!-- usagestop -->
-# Commands
-<!-- commands -->
-* [`gjsify build [FILE]`](#gjsify-build-file)
-* [`gjsify help [COMMAND]`](#gjsify-help-command)
-
-## `gjsify build [FILE]`
-
-describe the command here
-
-```
-USAGE
-  $ gjsify build [FILE]
-
-OPTIONS
-  -b, --beautify                       Beautify build output
-  -h, --help                           show CLI help
-  -m, --minimize                       Minimize build output
-  -o, --outputFilename=outputFilename  [default: index.js] File name of the output bundle
-  -p, --outputPath=outputPath          [default: ./dist] Output destination path
-  --mangle                             Mangle build output
-
-EXAMPLE
-  $ gjsify build ./src/hello.ts
-```
-
-_See code: [src/commands/build.ts](https://github.com/gjsify/cli/blob/v0.0.1-b/src/commands/build.ts)_
-
-## `gjsify help [COMMAND]`
-
-display help for gjsify
-
-```
-USAGE
-  $ gjsify help [COMMAND]
-
-ARGUMENTS
-  COMMAND  command to show help for
-
-OPTIONS
-  --all  see all commands in CLI
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_
-<!-- commandsstop -->
-
-# CommonJS compatibility
-
-Many [npm](https://www.npmjs.com/) modules that don't do IO will just work after being browserified. Others take more work.
-
-When you require() any of these modules, you will get a gjs-specific shim:

package/bin/run

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

package/bin/run.cmd

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

package/lib/actions/init.js

@@ -1,7 +0,0 @@
-"use strict";
-// TODO add npm dev modules:
-// ts-loader -D
-// json-loader -D
-// typescript -D
-// TODO add configs
-// tsconfig.json

package/lib/defaults.d.ts

@@ -1,7 +0,0 @@
-export declare const flags: {
-    outputFilename: string;
-    outputPath: string;
-    beautify: boolean;
-    minimize: boolean;
-    mangle: boolean;
-};