Merge pull request #348 from sparksuite/better-spec-error

Better spec error

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "waterfall-cli",
-	"version": "1.0.0-alpha.1",
+	"version": "1.0.0-alpha.2",
 	"description": "Effortlessly create CLIs powered by Node.js",
 	"types": "dist/cjs/index.d.ts",
 	"files": [

src/utils/get-command-spec.test.ts

@@ -19,7 +19,7 @@ describe('#getCommandSpec()', () => {
 
 	it('Complains about invalid spec JS', async () => {
 		await expect(getCommandSpec(path.join(testFileTrees, 'bad-structure', 'cli', 'invalid-spec-js'))).rejects.toThrow(
-			'This spec file contains invalid JS'
+			'Encountered this error while importing the spec file at'
 		);
 	});
 

src/utils/get-command-spec.ts

@@ -4,6 +4,7 @@ import path from 'path';
 import chalk from './chalk.js';
 import { PrintableError } from './errors.js';
 import { ExcludeMe, OmitExcludeMeProperties } from '../types/exclude-matching-properties.js';
+import getContext from './get-context.js';
 
 // Define what command input looks like
 export interface CommandInput {
@@ -170,16 +171,20 @@ export default async function getCommandSpec(directory: string): Promise<Generic
 		);
 	}
 
-	// Get the file path
+	// Get the context
+	const context = await getContext();
+
+	// Get the file paths
 	const specFilePath = specFiles[0];
+	const truncatedPath = specFilePath.replace(`${path.dirname(context.entryFile)}/`, '');
 
 	// Return
 	try {
 		const spec = (await import(specFilePath)) as { default: GenericCommandSpec } | GenericCommandSpec;
 		return 'default' in spec ? spec.default : spec;
 	} catch (error) {
 		throw new PrintableError(
-			`This spec file contains invalid JS: ${specFilePath}\n${chalk.bold('JS Error: ')}${String(error)}`
+			`${String(error)}\n\nEncountered this error while importing the spec file at: ${chalk.bold(truncatedPath)}`
 		);
 	}
 }