feat: add support for output modifier flags

[ruicalheno133]

Currently, only -e option is used to execute an inline script.

This PR:

• Adds support for osascript's output modifier flags -s (as specified here).
• Adds tests to ensure current behaviour is kept and -s flag behaviour works

I'm not sure if this solves #4, but using the -s s flag, it returns a string that can be parsed into an array. Neverthless, I think it is useful to have this option available to mirror the behaviour of the osascript command,.

Output without -s flag:

$ osascript -e 'return {{"foo", {"bar"}}}'        
foo, bar

Output with -s flag:

$ osascript -e 'return {{"foo", {"bar"}}}'  -s s
{{"foo", {"bar"}}}

[sindresorhus]

The point of this package is to abstract away the command-line flags. I think this should instead be an option called humanReadableReturnValue that can be set to false to get the wanted behavior.

[ruicalheno133]

Got it 👍 Will update accordingly.

As a follow-up, I was wondering if it wouldn't be useful to also be able to read from a file. I could create a new function specifically for that or add a new argument fromFile and if this was set to true it would consider the script param as a filename. What do you think?

[sindresorhus]

As a follow-up, I was wondering if it wouldn't be useful to also be able to read from a file. I could create a new function specifically for that or add a new argument fromFile and if this was set to true it would consider the script param as a filename. What do you think?

I think the most common use-case for this package are short scripts you can just have inline. If you need to pass a file, you can simply call fs.readFile.

[ruicalheno133]

Right! Let's keep it simple.

I added a new argument humanReadableOutput to the existing functions in 282e882.
I thought wrapping it within an options object, but it seemed overkill since there are no more options to be defined.

[sindresorhus]

I thought wrapping it within an options object, but it seemed overkill since there are no more options to be defined.

I think it should be an options-object.

runApplescript(..., false) is not very readable.

[sindresorhus]

https://github.com/sindresorhus/typescript-definition-style-guide#documentation

[sindresorhus]

Don't forget to add it to the readme. Use this formatting: https://github.com/sindresorhus/boxen#options

[sindresorhus]

Don't forget to add it to the readme. Use this formatting: https://github.com/sindresorhus/boxen#options