Merge pull request #26 from raisely/qa-fixes

Qa fixes

Author: f1yn

.editorconfig

@@ -8,7 +8,7 @@ insert_final_newline = true
 
 # Matches multiple files with brace expansion notation
 # Set default charset
-[*.{js,jsx,html,sass,less,jade,pug,json,css}]
+[*.{js,jsx,html,scss,sass,less,jade,pug,json,css}]
 charset = utf-8
 indent_style = tab
 indent_size = 4

CHANGELOG.md

@@ -1,4 +1,11 @@
 
+# 1.7.0
+- Now requires node v14+ LTS (esm no longer required)
+- Added better command-line experience (more logs)
+- Updated commander.js
+- Implemented dynamic imports for commands (faster, only load modules when needed for each command)
+- Applied code formatting to match internal development standards
+
 # 1.6.5
 
 - Fixed win32 filesystem handling

bin/raisely.js

@@ -1,6 +1,4 @@
 #!/usr/bin/env node
 
-// require = require("esm")(module);
-// require("../src/cli.js").cli(process.argv);
-import { cli } from "../src/cli.js";
+import { cli } from '../src/cli.js';
 cli(process.argv);

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@raisely/cli",
-	"version": "1.6.5",
+	"version": "1.7.0",
 	"description": "Raisely CLI for local development",
 	"main": "./src/cli.js",
 	"type": "module",
@@ -10,6 +10,9 @@
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1"
 	},
+	"engines": {
+		"node": ">=14"
+	},
 	"author": "Raisely",
 	"license": "SEE LICENSE IN LICENSE.md",
 	"dependencies": {
@@ -18,13 +21,11 @@
 		"@babel/preset-env": "^7.16.11",
 		"@babel/preset-react": "^7.16.7",
 		"chalk": "^2.4.2",
-		"commander": "^2.20.0",
-		"esm": "^3.2.25",
+		"commander": "^9.2.0",
 		"express": "^4.17.3",
 		"folder-hash": "^4.0.2",
 		"glob": "^7.1.6",
 		"glob-promise": "^3.4.0",
-		"global": "^4.4.0",
 		"http-proxy-middleware": "^2.0.4",
 		"inquirer": "^6.3.1",
 		"jwt-decode": "^3.0.0-beta.2",
@@ -35,7 +36,9 @@
 		"open": "^8.4.0",
 		"ora": "^3.4.0"
 	},
-	"devDependencies": {},
+	"devDependencies": {
+		"prettier": "^2.6.2"
+	},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/raisely/cli.git"
@@ -47,5 +50,14 @@
 	"bugs": {
 		"url": "https://github.com/raisely/cli/issues"
 	},
-	"homepage": "https://github.com/raisely/cli#readme"
+	"homepage": "https://github.com/raisely/cli#readme",
+	"prettier": {
+		"trailingComma": "es5",
+		"singleQuote": true,
+		"useTabs": true,
+		"tabWidth": 4,
+		"arrowParens": "always",
+		"quoteProps": "consistent",
+		"bracketSpacing": true
+	}
 }

src/actions/api.js

@@ -1,6 +1,6 @@
-import fetch from "node-fetch";
-import https from "https";
-import { loadConfig, defaults } from "../config.js";
+import fetch from 'node-fetch';
+import https from 'https';
+import { loadConfig, defaults } from '../config.js';
 
 const devHttpsAgent = new https.Agent({
 	rejectUnauthorized: false,
@@ -15,7 +15,7 @@ function getResponseContentType(response) {
 export default async function api(options) {
 	const config = await loadConfig({ allowEmpty: true });
 	const isJson =
-		!options.path.includes(".js") && !options.path.includes(".css");
+		!options.path.includes('.js') && !options.path.includes('.css');
 
 	const fetchUrl = `${config.apiUrl}/v3${options.path}`;
 
@@ -25,17 +25,17 @@ export default async function api(options) {
 			headers: {
 				...(isJson
 					? {
-							"Content-Type": "application/json",
+							'Content-Type': 'application/json',
 					  }
 					: {}),
 				...(config.token
 					? { Authorization: `Bearer ${config.token}` }
 					: {}),
 				...options.headers,
-				"x-raisely-cli": true,
+				'x-raisely-cli': true,
 			},
 			body:
-				options.method !== "GET" && options.json
+				options.method !== 'GET' && options.json
 					? JSON.stringify(options.json)
 					: undefined,
 			agent: config.apiUrl ? devHttpsAgent : undefined,
@@ -53,9 +53,11 @@ export default async function api(options) {
 		// Add extra line break before throwing error - for better visual grep
 		console.error('');
 
-		const formattedError =
-			`${fetchUrl} (${response.status}) failed with message: ${
-				(responseIsJSON && formatted.detail) || response.statusText}`;
+		const formattedError = `${fetchUrl} (${
+			response.status
+		}) failed with message: ${
+			(responseIsJSON && formatted.detail) || response.statusText
+		}`;
 
 		throw new Error(formattedError);
 	}

src/actions/auth.js

@@ -1,11 +1,11 @@
-import jwtDecode from "jwt-decode";
-import inquirer from "inquirer";
-import ora from "ora";
+import jwtDecode from 'jwt-decode';
+import inquirer from 'inquirer';
+import ora from 'ora';
 
-import api from "./api.js";
-import { error, log } from "../helpers.js";
-import { doLogin } from "../login.js";
-import { updateConfig } from "../config.js";
+import api from './api.js';
+import { error, log } from '../helpers.js';
+import { doLogin } from '../login.js';
+import { updateConfig } from '../config.js';
 
 let token = null;
 let tokenExpiresAt = null;
@@ -37,15 +37,15 @@ function setTokenExpiresAt() {
 			const decoded = jwtDecode(token);
 			tokenExpiresAt = new Date(decoded.exp * 1000);
 		} catch (e) {
-			console.warn("Could not decode token, is it a JWT?");
+			console.warn('Could not decode token, is it a JWT?');
 		}
 	}
 }
 
 async function checkCorrectOrganisation(orgUuid, opts, currentOrganisation) {
 	let organisationUuid = orgUuid;
 	if (!organisationUuid) {
-		const permChecker = ora("Checking campaign permissions...").start();
+		const permChecker = ora('Checking campaign permissions...').start();
 		try {
 			const campaignUuid = opts.campaigns[0];
 			const campaign = await api({
@@ -58,7 +58,7 @@ async function checkCorrectOrganisation(orgUuid, opts, currentOrganisation) {
 		} catch (e) {
 			error(e, permChecker);
 			console.error(
-				"Could not retrieve the campaign. Are you switched into the correct organisation?"
+				'Could not retrieve the campaign. Are you switched into the correct organisation?'
 			);
 
 			// A bit hacky, but saves a lot of conditional code all over or
@@ -69,28 +69,28 @@ async function checkCorrectOrganisation(orgUuid, opts, currentOrganisation) {
 
 	if (organisationUuid) {
 		const authData = await api({
-			path: "/authenticate",
+			path: '/authenticate',
 		});
 		if (authData.organisationUuid !== organisationUuid) {
 			log(
 				`This configuration is for organisation ${organisationUuid} but you are currently in organisation ${authData.organisationUuid}`,
-				"white"
+				'white'
 			);
 			const response = await inquirer.prompt([
 				{
-					type: "confirm",
-					name: "confirm",
+					type: 'confirm',
+					name: 'confirm',
 					message: `Would you like to switch your account to ${organisationUuid} now?`,
 				},
 			]);
 			if (response.confirm) {
 				const loader = ora(
-					"Switching to correct organisation ..."
+					'Switching to correct organisation ...'
 				).start();
 				try {
 					await api({
 						path: `/users/${authData.userUuid}/move`,
-						method: "PUT",
+						method: 'PUT',
 						json: {
 							data: {
 								organisationUuid,
@@ -109,8 +109,8 @@ async function checkCorrectOrganisation(orgUuid, opts, currentOrganisation) {
 
 export async function login(body, opts = {}) {
 	return await api({
-		path: "/login",
-		method: "POST",
+		path: '/login',
+		method: 'POST',
 		json: body,
 	});
 }
@@ -126,8 +126,7 @@ export async function getToken(program, opts, warnEarly) {
 	}
 	if (isTokenExpired(warnEarly)) {
 		({ token } = await doLogin(
-			program,
-			"Your token has expired, please login again"
+			'Your token has expired, please login again'
 		));
 		setTokenExpiresAt();
 		await updateConfig({ token });

src/actions/campaigns.js

@@ -1,31 +1,31 @@
-import glob from "glob-promise";
-import path from "path";
-import fs from "fs";
-import api from "./api.js";
+import glob from 'glob-promise';
+import path from 'path';
+import fs from 'fs';
+import api from './api.js';
 
 export async function getCampaigns() {
 	return await api({
-		path: "/campaigns",
-		method: "GET",
+		path: '/campaigns',
+		method: 'GET',
 	});
 }
 
 export async function getCampaign({ uuid }) {
 	return await api({
 		path: `/campaigns/${uuid}`,
-		method: "GET",
+		method: 'GET',
 	});
 }
 
 export async function getBaseStyles({ uuid }) {
 	return await api({
 		path: `/campaigns/${uuid}/base.css?asSass=1`,
-		method: "GET",
+		method: 'GET',
 	});
 }
 
 export async function fetchStyles({ campaign, filename }) {
-	const stylesDir = path.join(process.cwd(), "stylesheets");
+	const stylesDir = path.join(process.cwd(), 'stylesheets');
 	const filePath = campaign || filename.split(path.sep)[0];
 
 	const fullPath = path.join(stylesDir, filePath);
@@ -37,20 +37,20 @@ export async function fetchStyles({ campaign, filename }) {
 			// `glob` above returns paths with forward slashes only,
 			// so we need to replace potential Windows-style back slashes
 			// before attempting to find and remove the full path.
-			.replace(`${fullPath.replace(/\\/g, "/")}/`, "");
+			.replace(`${fullPath.replace(/\\/g, '/')}/`, '');
 
 		// continue if this is the main stylesheet
 
 		if (fileName === `${filePath}.scss`) continue;
 
-		configFiles[fileName] = fs.readFileSync(file, "utf8");
+		configFiles[fileName] = fs.readFileSync(file, 'utf8');
 	}
 
 	return {
 		configFiles,
 		css: fs.readFileSync(
 			path.join(stylesDir, filePath, `${filePath}.scss`),
-			"utf8"
+			'utf8'
 		),
 	};
 }
@@ -73,7 +73,7 @@ export async function uploadStyles(filename) {
 
 	const campaign = await api({
 		path: `/campaigns/${campaignPath}?private=1`,
-		method: "GET",
+		method: 'GET',
 	});
 
 	const { configFiles, css } = await fetchStyles({
@@ -87,7 +87,7 @@ export async function uploadStyles(filename) {
 
 	return await api({
 		path: `/campaigns/${campaignPath}/config/css?private=1`,
-		method: "PATCH",
+		method: 'PATCH',
 		json: { data },
 	});
 }