Strict typing for arguments

[naruaway]

IMHO, one of the strong benefit of using TypeScript for shell scripting is to get more static checks.

However, currently dax is using (strings: TemplateStringsArray, ...exprs: any[]): CommandBuilder type (source) for its primary API, which is $. Because of any in the type, we cannot detect incorrect arguments passed such as undefined or random incompatible objects.

import $ from 'dax-sh'

const myobj1 = {'hello': 'world'}
const myobj2 = undefined

// type check passes for the following, which is not desired.
await $`echo ${myobj1} ${myobj2}`

Proposed solution

I propose to stop using any in (strings: TemplateStringsArray, ...exprs: any[]): CommandBuilder by precisely model all the possible arguments.

Related issues

• Regarding "better static checks for dax" in general, I also found that forgotten await is not detected by eslint-typescript and I proposed a fix there (fix(eslint-plugin): [no-floating-promises] handle TaggedTemplateExpression typescript-eslint/typescript-eslint#8758)

[naruaway]

Ok thanks, so the only way to emit error for the above case is to stop supporting objects with toString()....
I think this is actually a good change but it is a breaking change 😢

I'll give up for now 👍