From e57122c4ffff5041ca41b04f24b5b611b83a656a Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Tue, 1 Nov 2022 22:32:41 +0100 Subject: [PATCH] refactor: Restructure names, keys and descs of triggers and actions --- .../actions/send-message-to-channel/index.ts | 2 +- .../src/apps/flickr/triggers/new-albums/index.ts | 2 +- .../apps/github/actions/create-issue/index.ts | 2 +- .../src/apps/github/triggers/new-issues/index.ts | 2 +- .../apps/rss/triggers/new-items-in-feed/index.ts | 2 +- .../apps/scheduler/triggers/every-day/index.ts | 2 +- .../src/apps/slack/actions/find-message/index.ts | 4 ++-- .../actions/send-a-message-to-channel/index.ts | 2 +- .../src/apps/smtp/actions/send-email/index.ts | 4 ++-- .../src/apps/twilio/actions/send-sms/index.ts | 4 ++-- .../apps/twilio/triggers/receive-sms/index.ts | 2 +- .../src/apps/twitter/triggers/my-tweets/index.ts | 4 ++-- .../twitter/triggers/new-follower-of-me/index.ts | 4 ++-- .../apps/twitter/triggers/search-tweets/index.ts | 4 ++-- .../apps/twitter/triggers/user-tweets/index.ts | 4 ++-- packages/docs/pages/apps/discord/actions.md | 2 +- packages/docs/pages/apps/github/actions.md | 2 +- packages/docs/pages/apps/github/triggers.md | 2 +- packages/docs/pages/apps/rss/triggers.md | 2 +- packages/docs/pages/apps/slack/actions.md | 6 +++--- packages/docs/pages/apps/smtp/actions.md | 4 ++-- packages/docs/pages/apps/twilio/actions.md | 4 ++-- packages/docs/pages/apps/twilio/triggers.md | 2 +- packages/docs/pages/apps/twitter/triggers.md | 16 ++++++++-------- 24 files changed, 42 insertions(+), 42 deletions(-) diff --git a/packages/backend/src/apps/discord/actions/send-message-to-channel/index.ts b/packages/backend/src/apps/discord/actions/send-message-to-channel/index.ts index 2aec322a..023ab17b 100644 --- a/packages/backend/src/apps/discord/actions/send-message-to-channel/index.ts +++ b/packages/backend/src/apps/discord/actions/send-message-to-channel/index.ts @@ -3,7 +3,7 @@ import defineAction from '../../../../helpers/define-action'; export default defineAction({ name: 'Send a message to channel', key: 'sendMessageToChannel', - description: 'Send a message to a specific channel you specify.', + description: 'Sends a message to a specific channel you specify.', arguments: [ { label: 'Channel', diff --git a/packages/backend/src/apps/flickr/triggers/new-albums/index.ts b/packages/backend/src/apps/flickr/triggers/new-albums/index.ts index e7da8f43..e7bf9178 100644 --- a/packages/backend/src/apps/flickr/triggers/new-albums/index.ts +++ b/packages/backend/src/apps/flickr/triggers/new-albums/index.ts @@ -4,7 +4,7 @@ import newAlbums from './new-albums'; export default defineTrigger({ name: 'New albums', pollInterval: 15, - key: 'new-albums', + key: 'newAlbums', description: 'Triggers when you create a new album.', async run($) { diff --git a/packages/backend/src/apps/github/actions/create-issue/index.ts b/packages/backend/src/apps/github/actions/create-issue/index.ts index 0545499b..cc62924c 100644 --- a/packages/backend/src/apps/github/actions/create-issue/index.ts +++ b/packages/backend/src/apps/github/actions/create-issue/index.ts @@ -4,7 +4,7 @@ import getRepoOwnerAndRepo from '../../common/get-repo-owner-and-repo'; export default defineAction({ name: 'Create issue', key: 'createIssue', - description: 'Create a new issue.', + description: 'Creates a new issue.', arguments: [ { label: 'Repo', diff --git a/packages/backend/src/apps/github/triggers/new-issues/index.ts b/packages/backend/src/apps/github/triggers/new-issues/index.ts index 4bc46068..81d4a8f8 100644 --- a/packages/backend/src/apps/github/triggers/new-issues/index.ts +++ b/packages/backend/src/apps/github/triggers/new-issues/index.ts @@ -2,7 +2,7 @@ import defineTrigger from '../../../../helpers/define-trigger'; import newIssues from './new-issues'; export default defineTrigger({ - name: 'New issue', + name: 'New issues', key: 'newIssues', pollInterval: 15, description: 'Triggers when a new issue is created', diff --git a/packages/backend/src/apps/rss/triggers/new-items-in-feed/index.ts b/packages/backend/src/apps/rss/triggers/new-items-in-feed/index.ts index b31e1a98..7682cf8e 100644 --- a/packages/backend/src/apps/rss/triggers/new-items-in-feed/index.ts +++ b/packages/backend/src/apps/rss/triggers/new-items-in-feed/index.ts @@ -4,7 +4,7 @@ import newItemsInFeed from './new-items-in-feed'; export default defineTrigger({ name: 'New items in feed', key: 'newItemsInFeed', - description: 'Triggers on new RSS feed items.', + description: 'Triggers on new RSS feed item.', pollInterval: 15, arguments: [ { diff --git a/packages/backend/src/apps/scheduler/triggers/every-day/index.ts b/packages/backend/src/apps/scheduler/triggers/every-day/index.ts index d155b752..5a6fc3de 100644 --- a/packages/backend/src/apps/scheduler/triggers/every-day/index.ts +++ b/packages/backend/src/apps/scheduler/triggers/every-day/index.ts @@ -1,5 +1,5 @@ import { DateTime } from 'luxon'; -import { IGlobalVariable, IJSONValue } from '@automatisch/types'; +import { IGlobalVariable } from '@automatisch/types'; import defineTrigger from '../../../../helpers/define-trigger'; import cronTimes from '../../common/cron-times'; import getNextCronDateTime from '../../common/get-next-cron-date-time'; diff --git a/packages/backend/src/apps/slack/actions/find-message/index.ts b/packages/backend/src/apps/slack/actions/find-message/index.ts index 03963efb..ff8df853 100644 --- a/packages/backend/src/apps/slack/actions/find-message/index.ts +++ b/packages/backend/src/apps/slack/actions/find-message/index.ts @@ -2,9 +2,9 @@ import defineAction from '../../../../helpers/define-action'; import findMessage from './find-message'; export default defineAction({ - name: 'Find message', + name: 'Find a message', key: 'findMessage', - description: 'Find a Slack message using the Slack Search feature.', + description: 'Finds a message using the Slack feature.', arguments: [ { label: 'Search Query', diff --git a/packages/backend/src/apps/slack/actions/send-a-message-to-channel/index.ts b/packages/backend/src/apps/slack/actions/send-a-message-to-channel/index.ts index 33df770e..7983f4c7 100644 --- a/packages/backend/src/apps/slack/actions/send-a-message-to-channel/index.ts +++ b/packages/backend/src/apps/slack/actions/send-a-message-to-channel/index.ts @@ -4,7 +4,7 @@ import postMessage from './post-message'; export default defineAction({ name: 'Send a message to channel', key: 'sendMessageToChannel', - description: 'Send a message to a specific channel you specify.', + description: 'Sends a message to a channel you specify.', arguments: [ { label: 'Channel', diff --git a/packages/backend/src/apps/smtp/actions/send-email/index.ts b/packages/backend/src/apps/smtp/actions/send-email/index.ts index c332f99e..68e525fa 100644 --- a/packages/backend/src/apps/smtp/actions/send-email/index.ts +++ b/packages/backend/src/apps/smtp/actions/send-email/index.ts @@ -3,9 +3,9 @@ import defineAction from '../../../../helpers/define-action'; import transporter from '../../common/transporter'; export default defineAction({ - name: 'Send Email', + name: 'Send an email', key: 'sendEmail', - description: 'Send an email', + description: 'Sends an email', arguments: [ { label: 'From name', diff --git a/packages/backend/src/apps/twilio/actions/send-sms/index.ts b/packages/backend/src/apps/twilio/actions/send-sms/index.ts index 037f14e4..36089727 100644 --- a/packages/backend/src/apps/twilio/actions/send-sms/index.ts +++ b/packages/backend/src/apps/twilio/actions/send-sms/index.ts @@ -1,9 +1,9 @@ import defineAction from '../../../../helpers/define-action'; export default defineAction({ - name: 'Send SMS', + name: 'Send an SMS', key: 'sendSms', - description: 'Send an SMS', + description: 'Sends an SMS', arguments: [ { label: 'From Number', diff --git a/packages/backend/src/apps/twilio/triggers/receive-sms/index.ts b/packages/backend/src/apps/twilio/triggers/receive-sms/index.ts index fe3ad6d1..f434247b 100644 --- a/packages/backend/src/apps/twilio/triggers/receive-sms/index.ts +++ b/packages/backend/src/apps/twilio/triggers/receive-sms/index.ts @@ -5,7 +5,7 @@ export default defineTrigger({ name: 'Receive SMS', key: 'receiveSms', pollInterval: 15, - description: 'Will be triggered when a new SMS is received.', + description: 'Triggers when a new SMS is received.', arguments: [ { label: 'To Number', diff --git a/packages/backend/src/apps/twitter/triggers/my-tweets/index.ts b/packages/backend/src/apps/twitter/triggers/my-tweets/index.ts index fd616b0d..56cb3d56 100644 --- a/packages/backend/src/apps/twitter/triggers/my-tweets/index.ts +++ b/packages/backend/src/apps/twitter/triggers/my-tweets/index.ts @@ -2,10 +2,10 @@ import defineTrigger from '../../../../helpers/define-trigger'; import getUserTweets from '../../common/get-user-tweets'; export default defineTrigger({ - name: 'My Tweets', + name: 'My tweets', key: 'myTweets', pollInterval: 15, - description: 'Will be triggered when you tweet something new.', + description: 'Triggers when you tweet something new.', async run($) { await getUserTweets($, { currentUser: true }); diff --git a/packages/backend/src/apps/twitter/triggers/new-follower-of-me/index.ts b/packages/backend/src/apps/twitter/triggers/new-follower-of-me/index.ts index 04d6eef6..f96afae4 100644 --- a/packages/backend/src/apps/twitter/triggers/new-follower-of-me/index.ts +++ b/packages/backend/src/apps/twitter/triggers/new-follower-of-me/index.ts @@ -3,9 +3,9 @@ import myFollowers from './my-followers'; export default defineTrigger({ name: 'New follower of me', - key: 'myFollowers', + key: 'newFollowerOfMe', pollInterval: 15, - description: 'Will be triggered when you have a new follower.', + description: 'Triggers when you have a new follower.', async run($) { await myFollowers($); diff --git a/packages/backend/src/apps/twitter/triggers/search-tweets/index.ts b/packages/backend/src/apps/twitter/triggers/search-tweets/index.ts index e89436cd..a3bbae6e 100644 --- a/packages/backend/src/apps/twitter/triggers/search-tweets/index.ts +++ b/packages/backend/src/apps/twitter/triggers/search-tweets/index.ts @@ -2,11 +2,11 @@ import defineTrigger from '../../../../helpers/define-trigger'; import searchTweets from './search-tweets'; export default defineTrigger({ - name: 'Search Tweets', + name: 'Search tweets', key: 'searchTweets', pollInterval: 15, description: - 'Will be triggered when any user tweet something containing a specific keyword, phrase, username or hashtag.', + 'Triggers when there is a new tweet containing a specific keyword, phrase, username or hashtag.', arguments: [ { label: 'Search Term', diff --git a/packages/backend/src/apps/twitter/triggers/user-tweets/index.ts b/packages/backend/src/apps/twitter/triggers/user-tweets/index.ts index 50ed3fce..1b6de95a 100644 --- a/packages/backend/src/apps/twitter/triggers/user-tweets/index.ts +++ b/packages/backend/src/apps/twitter/triggers/user-tweets/index.ts @@ -2,10 +2,10 @@ import defineTrigger from '../../../../helpers/define-trigger'; import getUserTweets from '../../common/get-user-tweets'; export default defineTrigger({ - name: 'User Tweets', + name: 'User tweets', key: 'userTweets', pollInterval: 15, - description: 'Will be triggered when a specific user tweet something new.', + description: 'Triggers when a specific user tweet something new.', arguments: [ { label: 'Username', diff --git a/packages/docs/pages/apps/discord/actions.md b/packages/docs/pages/apps/discord/actions.md index 575410e6..cb6015f4 100644 --- a/packages/docs/pages/apps/discord/actions.md +++ b/packages/docs/pages/apps/discord/actions.md @@ -1,7 +1,7 @@ --- items: - name: Send a message to channel - desc: Send a message to a specific channel you specify. + desc: Sends a message to a specific channel you specify. avatar: /favicons/discord.svg --- diff --git a/packages/docs/pages/apps/github/actions.md b/packages/docs/pages/apps/github/actions.md index 45afc09b..cf523c35 100644 --- a/packages/docs/pages/apps/github/actions.md +++ b/packages/docs/pages/apps/github/actions.md @@ -1,7 +1,7 @@ --- items: - name: Create issue - desc: Create a new issue. + desc: Creates a new issue. avatar: /favicons/github.svg --- diff --git a/packages/docs/pages/apps/github/triggers.md b/packages/docs/pages/apps/github/triggers.md index 783db0bd..dd33f009 100644 --- a/packages/docs/pages/apps/github/triggers.md +++ b/packages/docs/pages/apps/github/triggers.md @@ -1,6 +1,6 @@ --- items: - - name: New issue + - name: New issues desc: Triggers when a new issue is created avatar: /favicons/github.svg - name: New pull requests diff --git a/packages/docs/pages/apps/rss/triggers.md b/packages/docs/pages/apps/rss/triggers.md index f056341d..1071116f 100644 --- a/packages/docs/pages/apps/rss/triggers.md +++ b/packages/docs/pages/apps/rss/triggers.md @@ -1,7 +1,7 @@ --- items: - name: New items in feed - desc: Triggers on new RSS feed items. + desc: Triggers on new RSS feed item. avatar: /favicons/rss.svg --- diff --git a/packages/docs/pages/apps/slack/actions.md b/packages/docs/pages/apps/slack/actions.md index 9bbd7ee0..371e7588 100644 --- a/packages/docs/pages/apps/slack/actions.md +++ b/packages/docs/pages/apps/slack/actions.md @@ -1,10 +1,10 @@ --- items: - - name: Find message - desc: Find a Slack message using the Slack Search feature. + - name: Find a message + desc: Finds a message using the Slack search feature. avatar: /favicons/slack.svg - name: Send a message to channel - desc: Send a message to a specific channel you specify. + desc: Sends a message to a channel you specify. avatar: /favicons/slack.svg --- diff --git a/packages/docs/pages/apps/smtp/actions.md b/packages/docs/pages/apps/smtp/actions.md index 90cec3d9..ac215d78 100644 --- a/packages/docs/pages/apps/smtp/actions.md +++ b/packages/docs/pages/apps/smtp/actions.md @@ -1,7 +1,7 @@ --- items: - - name: Send Email - desc: Send an email + - name: Send an email + desc: Sends an email avatar: /favicons/smtp.svg --- diff --git a/packages/docs/pages/apps/twilio/actions.md b/packages/docs/pages/apps/twilio/actions.md index b377058a..cf4dbfdd 100644 --- a/packages/docs/pages/apps/twilio/actions.md +++ b/packages/docs/pages/apps/twilio/actions.md @@ -1,7 +1,7 @@ --- items: - - name: Send SMS - desc: Send an SMS + - name: Send an SMS + desc: Sends an SMS avatar: /favicons/twilio.svg --- diff --git a/packages/docs/pages/apps/twilio/triggers.md b/packages/docs/pages/apps/twilio/triggers.md index 7f0be807..3e1f5e0e 100644 --- a/packages/docs/pages/apps/twilio/triggers.md +++ b/packages/docs/pages/apps/twilio/triggers.md @@ -1,7 +1,7 @@ --- items: - name: Receive SMS - desc: Will be triggered when a new SMS is received. + desc: Triggers when a new SMS is received. avatar: /favicons/twilio.svg --- diff --git a/packages/docs/pages/apps/twitter/triggers.md b/packages/docs/pages/apps/twitter/triggers.md index 5acb4475..7e98a454 100644 --- a/packages/docs/pages/apps/twitter/triggers.md +++ b/packages/docs/pages/apps/twitter/triggers.md @@ -1,16 +1,16 @@ --- items: - - name: My Tweets - desc: Will be triggered when you tweet something new. + - name: My tweets + desc: Triggers when you tweet something new. avatar: /favicons/twitter.svg - - name: New Follower of Me - desc: Will be triggered when you have a new follower. + - name: New followers of me + desc: Triggers when you have a new follower. avatar: /favicons/twitter.svg - - name: Search Tweets - desc: Will be triggered when any user tweet something containing a specific keyword, phrase, username or hashtag. + - name: Search tweets + desc: Triggers when there is a new tweet containing a specific keyword, phrase, username or hashtag. avatar: /favicons/twitter.svg - - name: User Tweets - desc: Will be triggered when a specific user tweet something new. + - name: User tweets + desc: Triggers when a specific user tweet something new. avatar: /favicons/twitter.svg ---