@qelos/plugins-cli 0.0.1

package/.nvmrc

@@ -0,0 +1 @@
+16

package/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contribute to Greenpress cli
+## Greenpress [Contribute Guide](https://docs.greenpress.info/guide/contribute/getting-started.html)
+
+## Greenpress [Installation Guide](https://docs.greenpress.info/guide/getting-started.html)
+
+## greenpress-cli [README](./README.md)
+
+## [Open Issues](https://github.com/greenpress/greenpress-cli/issues)

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 David Meir-Levy
+
+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

@@ -0,0 +1,13 @@
+# Qelos CLI
+
+A command-line interface to help you create and manage your Qelos plugins.
+
+## Installation
+> npm install -g @qelos/plugins-cli
+
+## Commands
+
+### Create a new plugin
+
+Basic usage to create new plugin
+> qplay create my-app

package/cli.mjs

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+import 'zx/globals';
+
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import yargs from 'yargs'
+import {hideBin} from 'yargs/helpers';
+import process from 'node:process';
+import createCommand from './commands/create.mjs';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const program = yargs(hideBin(process.argv));
+const pkg = await fs.readJSON(join(__dirname, 'package.json'));
+program.version(pkg.version)
+
+program.option('verbose', {
+  alias: 'V',
+  type: 'boolean',
+  description: 'Run with verbose logging'
+});
+
+createCommand(program)
+
+program.help().argv;

package/commands/create.mjs

@@ -0,0 +1,15 @@
+import createController from "../controllers/create.mjs";
+
+export default function createCommand(program) {
+  program
+    .command('create [name]', 'create a new plugin',
+      (yargs) => {
+        return yargs
+          .positional('name', {
+            describe: 'The name of your application. A folder with that name will be created here.',
+            default: 'qelos',
+            type: 'string'
+          })
+      },
+      createController)
+}

package/controllers/create.mjs

@@ -0,0 +1,56 @@
+import follow from "follow-redirects";
+import cliSelect from "cli-select";
+import {blue} from "../utils/colors.mjs";
+import DecompressZip from "decompress-zip";
+import {join} from "path";
+import rimraf from 'rimraf'
+import ProgressBar from "../utils/progress-bar.mjs";
+
+const https = follow.https;
+
+export default async function createController({name}) {
+  console.log(blue('Choose a boilerplate:'))
+  const result = await cliSelect({
+    values: {vanilla: 'Vanilla', react: 'React', vue: 'Vue', solid: 'Solid', custom: 'Custom from Github'},
+  })
+  const tempFolder = 'ql-plugin-' + Date.now();
+  const file = fs.createWriteStream(tempFolder + '.zip')
+
+  function extract(unzipper) {
+    const progress = new ProgressBar(100);
+    return new Promise((resolve) => {
+      unzipper.on('extract', function (log) {
+        resolve(log[0].folder)
+        progress.stop();
+      });
+
+      unzipper.on('progress', function (fileIndex, fileCount) {
+        progress.update(fileIndex / fileCount);
+      });
+
+      unzipper.extract({
+        path: tempFolder
+      });
+    })
+  }
+
+  const request = https.get(`https://github.com/qelos-boilerplates/${result.id}/archive/refs/heads/main.zip`, (response) => {
+    response.pipe(file);
+    response.on('end', async () => {
+      try {
+        file.close();
+        const unzipper = new DecompressZip(tempFolder + '.zip');
+        const rootFolder = await extract(unzipper);
+
+        fs.renameSync(join(tempFolder, rootFolder), name);
+
+        console.log(`Created ${name} successfully.`)
+      } catch (err) {
+        console.log('Failed');
+      } finally {
+        await rimraf(tempFolder)
+        fs.rmSync(tempFolder + '.zip');
+      }
+    })
+  });
+};

package/jest.config.js

@@ -0,0 +1,195 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/zz/q3q8dtb14s3d6g9q49fk4zbh0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  testPathIgnorePatterns: [
+    "/node_modules/",
+    "/tmp/"
+  ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  watchman: false,
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@qelos/plugins-cli",
+  "version": "0.0.1",
+  "description": "CLI to manage QELOS plugins",
+  "main": "cli.js",
+  "bin": {
+    "qplay": "cli.js"
+  },
+  "keywords": [
+    "qelos",
+    "cli"
+  ],
+  "author": "David Meir-Levy <davidmeirlevy@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "cli-progress": "^3.11.2",
+    "cli-select": "^1.1.2",
+    "decompress-zip": "^0.3.3",
+    "follow-redirects": "^1.15.2",
+    "rimraf": "^4.1.2",
+    "yargs": "^17.2.0",
+    "zx": "^7.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "jest --runInBand"
+  },
+  "devDependencies": {
+    "jest": "^27.5.1"
+  }
+}

package/services/create.js

@@ -0,0 +1,20 @@
+const fs = require("fs");
+const execute = require("../utils/execute");
+const { red } = require("../utils/colors");
+
+function installNodeDependencies(directoryName) {
+  console.log(process.cwd(), directoryName);
+  try {
+    execute(`npm install`, "install dependencies", {
+      cwd: directoryName,
+      stdio: "inherit",
+    });
+  } catch {
+    console.log(red(`Failed to install dependencies using \`npm install\`.`));
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  installNodeDependencies,
+};

package/services/hashing.js

@@ -0,0 +1,9 @@
+const crypto = require('crypto');
+
+function getRandomHash() {
+	const currentDate = new Date().valueOf().toString()
+	const random = Math.random().toString()
+	return crypto.createHash('sha1').update(currentDate + random).digest('hex');
+}
+
+module.exports = { getRandomHash }

package/store/cli.js

@@ -0,0 +1,20 @@
+class CliStore {
+
+  isVerbose = true;
+
+  constructor() {
+    this.isVerbose = process.argv.includes('--verbose');
+  }
+}
+
+let store;
+
+
+module.exports = {
+  getCliStore() {
+    if (!store) {
+      store = new CliStore();
+    }
+    return store;
+  }
+}

package/store/progress-bar.js

@@ -0,0 +1,46 @@
+const ProgressBar = require('../utils/progress-bar');
+
+class ProgressBarStore {
+	state = {
+		progress: 0,
+		total: 0
+	};
+
+	start(total) {
+		this.state.total = total;
+		this.state.progress = 0;
+		if (this._progressBar) {
+			this.stop();
+		}
+		this._progressBar = new ProgressBar(total, this.state.progress);
+	}
+
+	increment(progress = 0) {
+		this.state.progress += progress;
+		this._progressBar.increment(progress);
+	}
+
+	isResolved() {
+		return this.state.progress >= this.state.total;
+	}
+
+	stop() {
+		this._progressBar.stop();
+	}
+}
+
+let store;
+
+module.exports = {
+	/**
+	 *
+	 * @returns {ProgressBarStore}
+	 */
+	getProgressBarStore() {
+		if (!store) {
+			store = new ProgressBarStore();
+		}
+		return store;
+	}
+}
+

package/utils/colors.mjs

@@ -0,0 +1,22 @@
+const colorMap = new Map();
+colorMap.set("cyan", 36);
+colorMap.set("yellow", 33);
+colorMap.set("green", 32);
+colorMap.set("red", 31);
+
+/**
+ * logs the text to the console with the required color
+ * @param {string} text 
+ * @param {string} color
+ * @returns {string} 
+ */
+function logColor(text, color) {
+  if (colorMap.has(color)) {
+    return `\x1b[${colorMap.get(color)}m${text}\x1b[0m`;
+  }
+}
+
+export const green = (text) => logColor(text, "green");
+export const blue = (text) => logColor(text, "cyan");
+export const yellow = (text) => logColor(text, "yellow");
+export const red = (text) => logColor(text, "red");

package/utils/process-handler.js

@@ -0,0 +1,29 @@
+function getProcessHandler(proc) {
+  let onExit, onData, onError;
+
+  proc.stderr.on('error', (err) => {
+    console.log(err.toString());
+    onError && onError(err);
+  });
+
+  proc.stdout.on('data', (data) => {
+    onData && onData(data);
+  });
+
+  proc.on('close', (code) => {
+    console.log('process exited');
+    onExit && onExit(code);
+  });
+
+  return {
+    onExit: (func) => onExit = func,
+    onData: (func) => onData = func,
+    onError: (func) => onError = func,
+    exit: () => proc.kill('SIGTERM'),
+    process: proc
+  };
+}
+
+module.exports = {
+  getProcessHandler
+}

package/utils/progress-bar.mjs

@@ -0,0 +1,21 @@
+import * as cliProgress from "cli-progress";
+
+export default class ProgressBar {
+	_progressBar = new cliProgress.SingleBar({}, cliProgress.Presets.shades_classic);
+
+	constructor(total = 100, start = 0) {
+		this._progressBar.start(total, start);
+	}
+
+	stop() {
+		this._progressBar.stop();
+	}
+
+	update(progress) {
+		this._progressBar.update(progress);
+	}
+
+	increment(progress = 0) {
+		this._progressBar.increment(progress);
+	}
+}