feat: show proper error message on init

Also check for common stuff under project and server config files. See #28
swashata · Oct 30, 2018 · ea4c3a9 · ea4c3a9
1 parent b1d3c07
commit ea4c3a9
Show file tree

Hide file tree

Showing 17 changed files with 225 additions and 45 deletions.
diff --git a/packages/scripts/__tests__/config/getProjectAndServerConfig.spec.ts b/packages/scripts/__tests__/config/getProjectAndServerConfig.spec.ts
@@ -9,6 +9,22 @@ const pathToDummyWrong = path.resolve(
 	__dirname,
 	'../helpers/dummyConfigWrong.js'
 );
+const pathToDummyPCRight = path.resolve(
+	__dirname,
+	'../helpers/dummyPCRight.js'
+);
+const pathToDummyPCWrong = path.resolve(
+	__dirname,
+	'../helpers/dummyPCWrong.js'
+);
+const pathToDummySCRight = path.resolve(
+	__dirname,
+	'../helpers/dummySCRight.js'
+);
+const pathToDummySCWrong = path.resolve(
+	__dirname,
+	'../helpers/dummySCWrong.js'
+);
 const validCwd = path.resolve(__dirname, '../helpers');
 
 describe('getProjectAndServerConfig', () => {
@@ -29,8 +45,8 @@ describe('getProjectAndServerConfig', () => {
 		test('works properly if module.exports is an object', () => {
 			expect(() => {
 				getProjectAndServerConfig(__dirname, {
-					projectConfig: pathToDummyRight,
-					serverConfig: pathToDummyRight,
+					projectConfig: pathToDummyPCRight,
+					serverConfig: pathToDummySCRight,
 				});
 			}).not.toThrow();
 		});
@@ -39,23 +55,23 @@ describe('getProjectAndServerConfig', () => {
 		test('throws error if file not found', () => {
 			expect(() => {
 				getProjectAndServerConfig(__dirname, {
-					projectConfig: pathToDummyRight,
+					projectConfig: pathToDummyPCRight,
 				});
 			}).toThrowError('not find server configuration');
 		});
 		test('throws error if module.exports not an object', () => {
 			expect(() => {
 				getProjectAndServerConfig(__dirname, {
-					projectConfig: pathToDummyRight,
+					projectConfig: pathToDummyPCRight,
 					serverConfig: pathToDummyWrong,
 				});
 			}).toThrow('Server configuration must export an object literal.');
 		});
 		test('works properly if module.exports is an object', () => {
 			expect(() => {
 				getProjectAndServerConfig(__dirname, {
-					projectConfig: pathToDummyRight,
-					serverConfig: pathToDummyRight,
+					projectConfig: pathToDummyPCRight,
+					serverConfig: pathToDummySCRight,
 				});
 			}).not.toThrow();
 		});

diff --git a/packages/scripts/__tests__/helpers/dummyConfigRight.js b/packages/scripts/__tests__/helpers/dummyConfigRight.js
@@ -1,3 +1,12 @@
 module.exports = {
+	appName: 'helloWorld',
+	files: [
+		{
+			entry: {
+				foo: './src/index.js',
+			},
+			name: 'app',
+		},
+	],
 	foo: 'bar',
 };
diff --git a/packages/scripts/__tests__/helpers/dummyPCRight.js b/packages/scripts/__tests__/helpers/dummyPCRight.js
@@ -0,0 +1,11 @@
+module.exports = {
+	appName: 'helloWorld',
+	files: [
+		{
+			entry: {
+				foo: './src/index.js',
+			},
+			name: 'app',
+		},
+	],
+};
diff --git a/packages/scripts/__tests__/helpers/dummyPCWrong.js b/packages/scripts/__tests__/helpers/dummyPCWrong.js
@@ -0,0 +1,4 @@
+module.exports = {
+	// No appName
+	files: [],
+};
diff --git a/packages/scripts/__tests__/helpers/dummySCRight.js b/packages/scripts/__tests__/helpers/dummySCRight.js
@@ -0,0 +1,4 @@
+module.exports = {
+	host: undefined,
+	proxy: 'http://localhost',
+};
diff --git a/packages/scripts/__tests__/helpers/dummySCWrong.js b/packages/scripts/__tests__/helpers/dummySCWrong.js
@@ -0,0 +1,3 @@
+module.exports = {
+	host: undefined,
+};
diff --git a/packages/scripts/__tests__/helpers/wpackio.project.js b/packages/scripts/__tests__/helpers/wpackio.project.js
@@ -1,4 +1,5 @@
 module.exports = {
+	appName: 'helloWorld',
 	files: [
 		{
 			entry: {

diff --git a/packages/scripts/__tests__/helpers/wpackio.server.js b/packages/scripts/__tests__/helpers/wpackio.server.js
@@ -1,3 +1,4 @@
 module.exports = {
 	host: undefined,
+	proxy: 'http://localhost',
 };
diff --git a/packages/scripts/package.json b/packages/scripts/package.json
@@ -100,6 +100,7 @@
 		"access": "public"
 	},
 	"devDependencies": {
-		"dts-gen": "0.5.7"
+		"dts-gen": "0.5.7",
+		"fork-ts-checker-webpack-plugin": "^0.4.14"
 	}
 }
diff --git a/packages/scripts/src/bin/build.ts b/packages/scripts/src/bin/build.ts
@@ -8,6 +8,7 @@ import { Build } from '../scripts/Build';
 import { ProgramOptions } from './index';
 import {
 	endBuildInfo,
+	prettyPrintError,
 	resolveCWD,
 	watchEllipsis,
 	wpackLogoSmall,
@@ -77,8 +78,8 @@ export function build(options: ProgramOptions | undefined): void {
 				process.exit(1);
 			});
 	} catch (e) {
-		spinner.fail(`${wpackLogoSmall} could not start webpack compiler.`);
-		console.error(pe.render(e));
+		spinner.stop();
+		prettyPrintError(e, 'could not start webpack compiler.');
 		process.exit(1);
 	}
 }
diff --git a/packages/scripts/src/bin/index.ts b/packages/scripts/src/bin/index.ts
@@ -83,7 +83,7 @@ program
 program
 	.command('build')
 	.description('Build production files.')
-	.option('-c, --context', contextHelp)
+	.option('-c, --context [path]', contextHelp)
 	.option(
 		'-p, --project-config [path]',
 		'Path to project config. If it differs from ./wpackio.project.js'
@@ -101,7 +101,7 @@ program
 program
 	.command('bootstrap')
 	.description('create project and/or server configuration files.')
-	.option('-c, --context', contextHelp)
+	.option('-c, --context [path]', contextHelp)
 	.action((options: ProgramOptions | undefined) => {
 		isValidCommand = true;
 		bootstrap(options, pkg.version);

diff --git a/packages/scripts/src/bin/serve.ts b/packages/scripts/src/bin/serve.ts
@@ -1,14 +1,17 @@
 import chalk from 'chalk';
+import figures from 'figures';
 import logSymbols from 'log-symbols';
 import ora from 'ora';
 import path from 'path';
 import PrettyError from 'pretty-error';
 import clearConsole from 'react-dev-utils/clearConsole';
 import { getProjectAndServerConfig } from '../config/getProjectAndServerConfig';
+import { WpackioError } from '../errors/WpackioError';
 import { Server } from '../scripts/Server';
 import { ProgramOptions } from './index';
 import {
 	endServeInfo,
+	prettyPrintError,
 	resolveCWD,
 	serverInfo,
 	watchEllipsis,
@@ -29,8 +32,6 @@ export function serve(options: ProgramOptions | undefined): void {
 	// Get project and server config JSONs.
 	const cwd = resolveCWD(options);
 	const relCwd = path.relative(process.cwd(), cwd);
-	// For pretty logging
-	const pe = new PrettyError();
 
 	// For spinner
 	const spinner = ora({
@@ -162,8 +163,7 @@ export function serve(options: ProgramOptions | undefined): void {
 		}
 	} catch (e) {
 		spinner.stop();
-		console.log(`${logSymbols.error} could not start server.`);
-		console.error(pe.render(e));
+		prettyPrintError(e, 'could not start server.');
 		process.exit(1);
 	}
 }
diff --git a/packages/scripts/src/bin/utils.ts b/packages/scripts/src/bin/utils.ts
@@ -4,7 +4,10 @@ import figlet from 'figlet';
 import figures from 'figures';
 import findUp from 'find-up';
 import gradient from 'gradient-string';
+import logSymbols from 'log-symbols';
 import path from 'path';
+import PrettyError from 'pretty-error';
+import { WpackioError } from '../errors/WpackioError';
 
 let isYarnCache: boolean | null = null;
 
@@ -207,3 +210,27 @@ To spread the ${chalk.red(figures.heart)} please tweet.`;
 		})
 	);
 }
+
+export function prettyPrintError(
+	e: Error | WpackioError,
+	errorMsg: string
+): void {
+	const errorPrefix = `  ${chalk.dim.red(figures.pointer)}  `;
+	console.log(chalk.dim('='.repeat(errorMsg.length + 2)));
+	console.log(`${logSymbols.error} ${errorMsg}`);
+	console.log(chalk.dim('='.repeat(errorMsg.length + 2)));
+	console.log('');
+	if (e instanceof WpackioError) {
+		console.log(chalk.bgRed.black(' please review the following errors '));
+		console.log('');
+		console.error(
+			errorPrefix +
+				e.message
+					.split('\n')
+					.reduce((acc, line) => `${acc}\n${errorPrefix}${line}`)
+		);
+	} else {
+		const pe = new PrettyError();
+		console.error(pe.render(e));
+	}
+}
diff --git a/packages/scripts/src/config/WebpackConfigHelper.ts b/packages/scripts/src/config/WebpackConfigHelper.ts
@@ -11,6 +11,7 @@ import slugify from 'slugify';
 import TimeFixPlugin from 'time-fix-plugin';
 import webpack from 'webpack';
 import WebpackAssetsManifest from 'webpack-assets-manifest';
+import { WpackioError } from '../errors/WpackioError';
 import {
 	BannerConfig,
 	FileConfig,
@@ -265,20 +266,26 @@ export class WebpackConfigHelper {
 		const tsconfigPath = path.resolve(this.cwd, './tsconfig.json');
 		if (this.fileExists(tsconfigPath)) {
 			// dynamic require forktschecker otherwise it will throw error
-			// tslint:disable-next-line:variable-name
-			const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
-			plugins.push(
-				new ForkTsCheckerWebpackPlugin({
-					tsconfig: tsconfigPath,
-					tslint: undefined,
-					async: false,
-					silent: true,
-					formatter: 'codeframe',
-					formatterOptions: {
-						highlightCode: true,
-					},
-				})
-			);
+			try {
+				// tslint:disable-next-line:variable-name no-implicit-dependencies
+				const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
+				plugins.push(
+					new ForkTsCheckerWebpackPlugin({
+						tsconfig: tsconfigPath,
+						tslint: undefined,
+						async: false,
+						silent: true,
+						formatter: 'codeframe',
+						formatterOptions: {
+							highlightCode: true,
+						},
+					})
+				);
+			} catch (e) {
+				throw new WpackioError(
+					'please install fork-ts-checker-webpack-plugin package'
+				);
+			}
 		}
 		// Add development specific plugins
 		if (this.isDev) {