What is there to do before v1?

[joshfarrant]

There's been a lot going on with Shortcuts JS since launch, the vast majority of which has been thanks to work done by our Contributors, so a massive thank you to @pietropizzi, @Archez, @DanielRuf, @xAlien95, @gcordalis, @JB1905, @bachya, and @ikaikastine. 🎉

With so much going on, I thought it could be useful to try to consolidate all of the tasks that will need to be completed before we can consider the library at v1. We can branch off individual tasks into their own issues as need be, but at the moment it would be nice to get a big picture of everything that's left to do.

In my mind, I'd imagined that a v1 release would essentially expose all of the main functionality found in the official Shortcuts app. That includes:

• Supporting all 312 built-in actions.
• Full support for creating and using variables.
• Ability to choose an icon colour and glyph for the generated Shortcut
• Import questions

Progress with these items so far is as follows:

• Actions - As of this morning we passed 1/6th (16.6%) of all actions implemented! 🎉 Slightly more if we include #37 (pending discussion in #39).
• Variables - @xAlien95 has been doing some fantastic work on this in #10.
• Shortcut Icon - This was added by @gcordalis in #16 and is working very well. It would be a bonus if we could get the names of the glyphs in before v1, as outlined in #45.
• Import Questions - This hasn't been looked at at all, as far as I'm aware.

I'm probably missing some things here, so please let me know and I'll add it in.

As an aside, I'd also like to come up with a better documentation solution before hitting v1. The current docs are just ok and, while they're better than the previous solution (using jsdoc), they're still not fantastic. I get the feeling we're going to have to roll our own solution, as none of the out-of-the-box options are quite right. Hopefully we'll be able to base this custom solution on the JSON output from typedoc as that won't require any changes to the code, and typedoc is actually pretty good at what it does.

Thanks again to everyone for their contributions! 💙

[xAlien95]

Hopefully we'll be able to base this custom solution on the JSON output from typedoc as that won't require any changes to the code, and typedoc is actually pretty good at what it does.

Few days ago I created a local branch with some customization to the default/minimal theme of TypeDoc (TypeStrong/typedoc-default-themes). I didn't thought to look for an exported/compiled JSON output at all.. that would be more than great: that would be awesome.

There's a problem with the current TypeDoc implementation: it cannot specify what kind of WFSerialization is allowed to be passed to an action parameter. There are parameters that can accept only an askWhenRun global variable, other ones that can only accept strings or withVariable serializations. That's something that should be worked on in the docs.

[gcordalis]

We also need to take a look at Show in Widget and Show in Share Sheet.

At the moment all shortcuts default to Show in Widget = true and having the option to customise these would be great.

[regaw-leinad]

At the moment all shortcuts default to Show in Widget = true and having the option to customise these would be great.

Just submitted PR https://github.com/joshfarrant/shortcuts-js/pull/59 for this. Found (what I think to be) a Shortcuts iOS client bug while working on it.