Add support for user-configurable workflows #113
Conversation
SamVerschueren
force-pushed
the
issue36
branch
from
d6a1bbc
to
413acba
Compare
SamVerschueren
force-pushed
the
issue36
branch
from
413acba
to
3c327a3
Compare
| @@ -378,6 +378,19 @@ alfy.config.get('unicorn'); | |||
| //=> '🦄' | |||
| ``` | |||
|
|
|||
| #### userConfig | |||
There was a problem hiding this comment.
Not sure if we have to document how this works? By creating a config.json file in the root of your package? Or link directly to https://github.com/SamVerschueren/alfred-config#workflow-configuration?
There was a problem hiding this comment.
I would add a short description of how it works, and then link to alfred-config for more details. I would also include the use-cases here. Not clear from the property what a Alfred workflow creator would use it for when they read the docs.
https://github.com/SamVerschueren/alfred-config#workflow-configuration should describe where to put the JSON file, etc.
sindresorhus
changed the title
| @@ -378,6 +378,19 @@ alfy.config.get('unicorn'); | |||
| //=> '🦄' | |||
| ``` | |||
|
|
|||
| #### userConfig | |||
There was a problem hiding this comment.
I would add a short description of how it works, and then link to alfred-config for more details. I would also include the use-cases here. Not clear from the property what a Alfred workflow creator would use it for when they read the docs.
https://github.com/SamVerschueren/alfred-config#workflow-configuration should describe where to put the JSON file, etc.
readme.md
Outdated
|
|
||
| Type: `object` | ||
|
|
||
| If the workflow supports user configuration, it will export a readable [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) with the user workflow configuration. |
There was a problem hiding this comment.
Shouldn't it always export the Map? Only it will be empty if the workflow doesn't support user config. It's also not clear what it means for a workflow to "support user configuration".
There was a problem hiding this comment.
You are right, it seems that it does export a Map always.
|
Awesome how few changes |
|
@SamVerschueren Bump, in case you missed it. If you're just busy, feel free to ignore. |
|
Should definitely finish this one :). Thanks for the reminder. |
|
@SamVerschueren Bump :) |
|
Closing for lack of activity. |
|
I feel so bad for letting this one go stale. I think we are super close though. I addressed your feedback. I'm going to upgrade the dependencies of |
|
Tests are failing, waiting for #135. @sindresorhus could you check that the docs are better? It's been a while since I worked on this. I think it would be nice to have a link to a Alfy workflow which uses this. I could for instance setup a I'm thinking about a workflow which shows you all the pokemon, and allows you to specify the levenstein distance for fuzzy search. If you have anything better, I'm up for it 😂 . |
|
Fixed |
Don't worry. I was just trying to clean up my PR list. |
|
I agree it would be useful to link to an example. It's not entirely clear still how you would set up everything.
I like the idea of Pokemon list, but I would make the language configurable. |
|
Thanks for finishing this :) |
|
Oh configurable language is a good one 🎉 |
This PR fixes #36 by adding support for user configurable workspaces. It's as simple as creating a
config.jsonfile in your workflow package and it will open it with the default text editor when installing the workflow.IssueHunt Summary
Referenced issues
This pull request has been submitted to: