Improve validation of $.sync options binding (#551)

sindresorhus · Mar 14, 2023 · 881fbad · 881fbad
1 parent 5fa61d8
commit 881fbad
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/index.js b/index.js
@@ -234,15 +234,19 @@ export function execaSync(file, args, options) {
 
 function create$(options) {
 	function $(templatesOrOptions, ...expressions) {
-		if (Array.isArray(templatesOrOptions)) {
-			const [file, ...args] = parseTemplates(templatesOrOptions, expressions);
-			return execa(file, args, options);
+		if (!Array.isArray(templatesOrOptions)) {
+			return create$({...options, ...templatesOrOptions});
 		}
 
-		return create$({...options, ...templatesOrOptions});
+		const [file, ...args] = parseTemplates(templatesOrOptions, expressions);
+		return execa(file, args, options);
 	}
 
 	$.sync = (templates, ...expressions) => {
+		if (!Array.isArray(templates)) {
+			throw new TypeError('Please use $(options).sync`command` instead of $.sync(options)`command`.');
+		}
+
 		const [file, ...args] = parseTemplates(templates, expressions);
 		return execaSync(file, args, options);
 	};

diff --git a/test/command.js b/test/command.js
@@ -196,6 +196,10 @@ test('$.sync accepts options', t => {
 	t.is(stdout, 'foo');
 });
 
+test('$.sync must be used after options binding, not before', t => {
+	t.throws(() => $.sync({})`noop.js`, {message: /Please use/});
+});
+
 test('$.sync allows execa return value interpolation', t => {
 	const foo = $.sync`echo.js foo`;
 	const {stdout} = $.sync`echo.js ${foo} bar`;