Skip to content

[MM-231] Sync the plugin with starter template#85

Merged
mickmister merged 3 commits intomasterfrom
MM-231
Mar 22, 2024
Merged

[MM-231] Sync the plugin with starter template#85
mickmister merged 3 commits intomasterfrom
MM-231

Conversation

@ayusht2810
Copy link
Copy Markdown
Contributor

lieut-data and others added 2 commits February 16, 2024 00:12
…s (#192)

* Revert "Update main.go (#154)"

This reverts commit be4a281d0cc791d10e6e5ae917b325b2f054e475.

* Revert "[MM-33506] Use embed package to include plugin manifest (#145)"

This reverts commit ca9ee3c17c6920a636a33f378e17395afd6f329f.

* Revert "Don't generate manifest.ts (#127)"

This reverts commit 18d30b50bc7ba800c9f05bfd82970781db0aea3e.

* install-go-tools target, adopt gotestsum

* bring back make apply + automatic versioning

* Update build/manifest/main.go

Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com>

* suppress git describe error when no tags match

* make version/release notes opt-in

* fix whitespace in Makefile

* document version management options

---------

Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com>
Co-authored-by: Jesse Hallam <jesse.hallam@gmail.com>
@ayusht2810 ayusht2810 self-assigned this Feb 16, 2024
@ayusht2810 ayusht2810 added the 2: Dev Review Requires review by a core committer label Feb 16, 2024
Comment thread plugin.json
"display_name": "Channels to send notifications to:",
"type": "text",
"help_text": "The channels to send notifications to. Multiple channels can be specified. Format `teamname,channelname;teamname-2,channelname-2`. If the specified channels do not exist, the plugin will create the channels for you.\n \n Note: Must be the team and channel handle used in the URL. For example, in the following URL, set the value to `myteam,mychannel`: https://example.com/myteam/channels/mychannel.",
"help_text": "The channels to send notifications to. Multiple channels can be specified. Format 'teamname,channelname;teamname-2,channelname-2'. If the specified channels do not exist, the plugin will create the channels for you.\n \n Note: Must be the team and channel handle used in the URL. For example, in the following URL, set the value to 'myteam,mychannel': https://example.com/myteam/channels/mychannel.",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to escape the backtick with a backslash?

Suggested change
"help_text": "The channels to send notifications to. Multiple channels can be specified. Format 'teamname,channelname;teamname-2,channelname-2'. If the specified channels do not exist, the plugin will create the channels for you.\n \n Note: Must be the team and channel handle used in the URL. For example, in the following URL, set the value to 'myteam,mychannel': https://example.com/myteam/channels/mychannel.",
"help_text": "The channels to send notifications to. Multiple channels can be specified. Format \`teamname,channelname;teamname-2,channelname-2\`. If the specified channels do not exist, the plugin will create the channels for you.\n \n Note: Must be the team and channel handle used in the URL. For example, in the following URL, set the value to 'myteam,mychannel': https://example.com/myteam/channels/mychannel.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mickmister I don't think so as it is an invalid escape character and the VS code is showing the same error

Invalid escape character in string.json(261)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do think it's important to use backticks here if possible, so the help text is using code snippet syntax to highlight those words. If it's not possible, I understand

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mickmister I have tried but the problem here is that when we are creating the manifest file it contains the manifestStr string which basically contains the plugin.json settings that are created inside the backticks as it is a multi-line string and if we try to use backticks in any of the plugin.json settings that will be generated in that file as well and we cannot use backticks inside backticks and this will error out.
Screenshot from 2024-03-21 14-33-53

Copy link
Copy Markdown
Contributor

@mickmister mickmister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, please give the backtick thing in the comment above one more try, and we can merge whether we can do that or not

@Kshitij-Katiyar
Copy link
Copy Markdown
Contributor

LGTM, please give the backtick thing in the comment above one more try, and we can merge whether we can do that or not

@mickmister Tried that please look into the comment #85 (comment)

@mickmister mickmister merged commit e0e6a94 into master Mar 22, 2024
@mickmister mickmister deleted the MM-231 branch March 22, 2024 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2: Dev Review Requires review by a core committer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants