feat: introduce --ext-override option to process non-std (non js/ts like) file extensions

resolves #1104

Author: antongolub

man/zx.1

@@ -25,6 +25,8 @@ prefer locally installed packages bins
 evaluate script
 .SS --ext=<.mjs>
 default extension
+.SS --ext-override
+override script extensions
 .SS --install, -i
 install dependencies
 .SS --registry=<URL>

src/cli.ts

@@ -65,6 +65,7 @@ export function printUsage() {
    --cwd=<path>         set current directory
    --eval=<js>, -e      evaluate script
    --ext=<.mjs>         default extension
+   --ext-override       override script extensions
    --install, -i        install dependencies
    --registry=<URL>     npm registry, defaults to https://registry.npmjs.org/
    --version, -v        print current zx version
@@ -80,7 +81,7 @@ export function printUsage() {
 // prettier-ignore
 export const argv: minimist.ParsedArgs = parseArgv(process.argv.slice(2), {
   string: ['shell', 'prefix', 'postfix', 'eval', 'cwd', 'ext', 'registry', 'env'],
-  boolean: ['version', 'help', 'quiet', 'verbose', 'install', 'repl', 'experimental', 'prefer-local'],
+  boolean: ['version', 'help', 'quiet', 'verbose', 'install', 'repl', 'experimental', 'prefer-local', 'ext-override'],
   alias: { e: 'eval', i: 'install', v: 'version', h: 'help', l: 'prefer-local', 'env-file': 'env' },
   stopEarly: true,
   parseBoolean: true,
@@ -180,7 +181,7 @@ async function readScript() {
   }
 
   const { ext, base, dir } = path.parse(tempPath || scriptPath)
-  if (ext === '') {
+  if (ext === '' || argv.extOverride) {
     tempPath = getFilepath(dir, base)
   }
   if (ext === '.md') {

test/cli.test.js

@@ -223,6 +223,12 @@ describe('cli', () => {
     )
   })
 
+  test('scripts with non standard extension (override)', async () => {
+    const o =
+      await $`node build/cli.js --ext-override test/fixtures/non-std-ext.zx`
+    assert.ok(o.stdout.trim().endsWith('zx/test/fixtures/non-std-ext.zx.mjs'))
+  })
+
   test22('scripts from stdin with explicit extension', async () => {
     const out =
       await $`node --experimental-strip-types build/cli.js --ext='.ts' <<< 'const foo: string = "bar"; console.log(foo)'`

test/export.test.js

@@ -64,6 +64,7 @@ describe('cli', () => {
     assert.equal(typeof cli.argv, 'object', 'cli.argv')
     assert.equal(typeof cli.argv._, 'object', 'cli.argv._')
     assert.equal(typeof cli.argv.experimental, 'boolean', 'cli.argv.experimental')
+    assert.equal(typeof cli.argv.extOverride, 'boolean', 'cli.argv.extOverride')
     assert.equal(typeof cli.argv.h, 'boolean', 'cli.argv.h')
     assert.equal(typeof cli.argv.help, 'boolean', 'cli.argv.help')
     assert.equal(typeof cli.argv.i, 'boolean', 'cli.argv.i')

test/fixtures/non-std-ext.zx

@@ -0,0 +1,19 @@
+#!/usr/bin/env zx
+
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+console.log(chalk.yellowBright`If file has non-std ext and 'ext-override' option specified, zx assumes it's ESM.`)
+await $`pwd`
+console.log('__filename =', __filename)