-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from CloudCannon/linting
Linting
- Loading branch information
Showing
12 changed files
with
2,352 additions
and
1,356 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "extends": [ | ||
| "cloudcannon" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,164 +1,168 @@ | ||
| const runner = require("./lib/runner"); | ||
| const path = require("path"); | ||
| const path = require('path'); | ||
| const log = require('fancy-log'); | ||
| const chalk = require('chalk'); | ||
|
|
||
| const runner = require('./lib/runner'); | ||
|
|
||
| /** | ||
| * Factory function for creating commands. | ||
| * @param {function} func The function that calling this command will run. These functions | ||
| * Factory function for creating commands. | ||
| * @param {function} func The function that calling this command will run. These functions | ||
| * are usually included in the runner class. Implementing new functinoality shoud | ||
| * be done n runner.js. | ||
| * @return {Object} The command. | ||
| */ | ||
| const command = ( func, requiredFlags = []) => { | ||
| return { | ||
| run: func, | ||
| requiredFlags: requiredFlags | ||
| } | ||
| } | ||
|
|
||
| const command = (func, requiredFlags = []) => ({ | ||
| run: func, | ||
| requiredFlags: requiredFlags | ||
| }); | ||
|
|
||
| /** | ||
| The different commands for operation. New commands can be specified here. | ||
| Each command requires a function to run, and a lsi of required flags. | ||
| Each command requires a function to run, and a lsi of required flags. | ||
| Required flags will be checked before the command is run. | ||
| */ | ||
| const commands = { | ||
| "build": command(runner.build, ["baseurl"]), | ||
| "clean": command(runner.clean, ["dest"]), | ||
| "clone-assets": command(runner.clone_assets, ["baseurl"]), | ||
| "dist": command(runner.dist, ["baseurl"]), | ||
| "rewrite_css": command(runner.rewrite_css, ["baseurl"]), | ||
| "rewrite-html": command(runner.rewrite_html, ["baseurl"]), | ||
| "serve": command(runner.serve), | ||
| "watch": command(runner.watch) | ||
| } | ||
|
|
||
|
|
||
| const defaultSrc = "dist/site" | ||
| const defaultDest = "dist/prod"; | ||
| /* eslint-disable quote-props */ | ||
| 'build': command(runner.build, ['baseurl']), | ||
| // eslint-disable-next-line quote-props | ||
| 'clean': command(runner.clean, ['dest']), | ||
| 'clone-assets': command(runner.clone_assets, ['baseurl']), | ||
| 'dist': command(runner.dist, ['baseurl']), | ||
| 'rewrite_css': command(runner.rewrite_css, ['baseurl']), | ||
| 'rewrite-html': command(runner.rewrite_html, ['baseurl']), | ||
| 'serve': command(runner.serve), | ||
| 'watch': command(runner.watch) | ||
| /* eslint-enable quote-props */ | ||
| }; | ||
|
|
||
| const defaultSrc = 'dist/site'; | ||
| const defaultDest = 'dist/prod'; | ||
| const defaultPort = 9000; | ||
|
|
||
| let exitCode = 0; | ||
|
|
||
|
|
||
| module.exports = { | ||
| /** | ||
| * Checks if the required flags for a command were given by the user. | ||
| * | ||
| * @param {string[]} requiredFlags An array of the required flags for the command (in any order). | ||
| */ | ||
| checkRequiredFlags: function ( enteredFlags, requiredFlags ) { | ||
| if ( requiredFlags.every(flag => { return flag in enteredFlags; }) ) return true; | ||
|
|
||
| log.error( chalk.red("required flags:") ); | ||
| log.error( chalk.red( requiredFlags ) ); | ||
| exitCode = 1; | ||
| return false; | ||
| }, | ||
|
|
||
| /** | ||
| * Checks a given port number to see if it is valid. | ||
| * | ||
| * @param {string} portString | ||
| * @returns {number} The number representation of portString on no-error. | ||
| * Returns the default port number on error. | ||
| */ | ||
| checkPortNumber: function ( portString ) { | ||
| if ( !portString ) return; | ||
|
|
||
| let port = parseInt(portString); | ||
| let defaultString = "Reverting to default port (" + defaultPort + ")."; | ||
|
|
||
| if ( !port ){ | ||
| log.error(chalk.yellow(portString + " is not a valid port number.")); | ||
| log.error(chalk.yellow(defaultString)); | ||
| return; | ||
| } | ||
|
|
||
| if ( port < 1024 || port > 65535 ) { | ||
| log.error(chalk.yellow("Port number outside of allowed range. (1024 - 65535).")); | ||
| log.error(chalk.yellow(defaultString)); | ||
| return; | ||
| } | ||
|
|
||
| return port; | ||
| }, | ||
|
|
||
| /** | ||
| * Function that ajusts the options that the cli runs on. | ||
| * | ||
| * @param {Object} Flags the flags that were set by the user in the command line. | ||
| * @return {Object} An object containing information on how to run the given CLI command. | ||
| */ | ||
| setOptions: function ( flags ){ | ||
| const source = flags["source"] || defaultSrc; | ||
| const destination = flags["dest"] || defaultDest; | ||
| const baseurl = flags["baseurl"] || ""; | ||
| const port = this.checkPortNumber(flags["port"]) || defaultPort; | ||
| const split = flags["split"] || 1; | ||
| const partition = flags["partition"] || 1; | ||
|
|
||
| let options = { | ||
| cwd: process.cwd(), | ||
|
|
||
| dist: { | ||
| src: source, | ||
| dest: destination, | ||
| baseurl: baseurl | ||
| }, | ||
| serve: { | ||
| port: port, | ||
| open: true, | ||
| path: "/" | ||
| } , | ||
| flags:{ | ||
| overwrite: flags["overwrite"], | ||
| split, | ||
| partition | ||
| } | ||
| }; | ||
|
|
||
| options.dist.fullPathToSource = path.resolve(options.cwd, options.dist.src); | ||
| options.dist.fullPathToDest = path.resolve(options.cwd, options.dist.dest, baseurl); | ||
| return options; | ||
| }, | ||
|
|
||
| /** | ||
| * Takes the command line arguments and runs the appropriate commands. | ||
| * | ||
| * @param {Object} cli The meow object that handled the user input. | ||
| * @return {int} Returns the exit code of the operation. (0) means no error, | ||
| * non-zero means an error occured. | ||
| */ | ||
| run: async function ( cli ) { | ||
| exitCode = 0; | ||
|
|
||
| let options = this.setOptions( cli.flags ); | ||
|
|
||
| let date = new Date() | ||
| let startTime = date.getTime(); | ||
|
|
||
| let cmd = cli.input[0] || "dist"; | ||
|
|
||
| if (commands[cmd]){ | ||
| if (this.checkRequiredFlags(cli.flags, commands[cmd].requiredFlags)){ | ||
| let exit = await commands[cmd].run.call(runner, options); //run function in the context of the runner module. | ||
| if (typeof exit === "number"){ | ||
| exitCode = exit; | ||
| } | ||
| } | ||
| } else { | ||
| log(chalk.red("command not recognized")); | ||
| exitCode = 1; | ||
| } | ||
|
|
||
| let end = new Date(); | ||
| let elapsedTime = end.getTime() - startTime; | ||
| log(chalk.yellow("⏱ process completed in " + elapsedTime + " ms. ")); | ||
|
|
||
| return exitCode; | ||
| } | ||
|
|
||
| } | ||
| module.exports = { | ||
| /** | ||
| * Checks if the required flags for a command were given by the user. | ||
| * | ||
| * @param {string[]} requiredFlags An array of the required flags for the command (in any order). | ||
| */ | ||
| checkRequiredFlags: function (enteredFlags, requiredFlags) { | ||
| if (requiredFlags.every((flag) => { | ||
| return flag in enteredFlags; | ||
| })) { | ||
| return true; | ||
| } | ||
|
|
||
| log.error(chalk.red('required flags:')); | ||
| log.error(chalk.red(requiredFlags)); | ||
| exitCode = 1; | ||
| return false; | ||
| }, | ||
|
|
||
| /** | ||
| * Checks a given port number to see if it is valid. | ||
| * | ||
| * @param {string} portString | ||
| * @returns {number} The number representation of portString on no-error. | ||
| * Returns the default port number on error. | ||
| */ | ||
| checkPortNumber: function (portString) { | ||
| if (!portString) { | ||
| return; | ||
| } | ||
|
|
||
| const port = parseInt(portString, 10); | ||
| const defaultString = `Reverting to default port (${defaultPort}).`; | ||
|
|
||
| if (!port) { | ||
| log.error(chalk.yellow(`${portString} is not a valid port number.`)); | ||
| log.error(chalk.yellow(defaultString)); | ||
| return; | ||
| } | ||
|
|
||
| if (port < 1024 || port > 65535) { | ||
| log.error(chalk.yellow('Port number outside of allowed range. (1024 - 65535).')); | ||
| log.error(chalk.yellow(defaultString)); | ||
| return; | ||
| } | ||
|
|
||
| return port; | ||
| }, | ||
|
|
||
| /** | ||
| * Function that ajusts the options that the cli runs on. | ||
| * | ||
| * @param {Object} Flags the flags that were set by the user in the command line. | ||
| * @return {Object} An object containing information on how to run the given CLI command. | ||
| */ | ||
| setOptions: function (flags) { | ||
| const source = flags.source || defaultSrc; | ||
| const destination = flags.dest || defaultDest; | ||
| const baseurl = flags.baseurl || ''; | ||
| const port = this.checkPortNumber(flags.port) || defaultPort; | ||
| const split = flags.split || 1; | ||
| const partition = flags.partition || 1; | ||
|
|
||
| const options = { | ||
| cwd: process.cwd(), | ||
|
|
||
| dist: { | ||
| src: source, | ||
| dest: destination, | ||
| baseurl: baseurl | ||
| }, | ||
| serve: { | ||
| port: port, | ||
| open: true, | ||
| path: '/' | ||
| }, | ||
| flags: { | ||
| overwrite: flags.overwrite, | ||
| split: split, | ||
| partition: partition | ||
| } | ||
| }; | ||
|
|
||
| options.dist.fullPathToSource = path.resolve(options.cwd, options.dist.src); | ||
| options.dist.fullPathToDest = path.resolve(options.cwd, options.dist.dest, baseurl); | ||
| return options; | ||
| }, | ||
|
|
||
| /** | ||
| * Takes the command line arguments and runs the appropriate commands. | ||
| * | ||
| * @param {Object} cli The meow object that handled the user input. | ||
| * @return {int} Returns the exit code of the operation. (0) means no error, | ||
| * non-zero means an error occured. | ||
| */ | ||
| run: async function (cli) { | ||
| exitCode = 0; | ||
|
|
||
| const options = this.setOptions(cli.flags); | ||
|
|
||
| const date = new Date(); | ||
| const startTime = date.getTime(); | ||
|
|
||
| const cmd = cli.input[0] || 'dist'; | ||
|
|
||
| if (commands[cmd]) { | ||
| if (this.checkRequiredFlags(cli.flags, commands[cmd].requiredFlags)) { | ||
| // run function in the context of the runner module. | ||
| const exit = await commands[cmd].run.call(runner, options); | ||
| if (typeof exit === 'number') { | ||
| exitCode = exit; | ||
| } | ||
| } | ||
| } else { | ||
| log(chalk.red('command not recognized')); | ||
| exitCode = 1; | ||
| } | ||
|
|
||
| const end = new Date(); | ||
| const elapsedTime = end.getTime() - startTime; | ||
| log(chalk.yellow(`⏱ process completed in ${elapsedTime} ms. `)); | ||
|
|
||
| return exitCode; | ||
| } | ||
| }; |
Oops, something went wrong.