Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace 'IDE Key' terminology with 'Debug Trigger' #7

Merged
merged 4 commits into from
Mar 10, 2025

Conversation

derickr
Copy link
Contributor

@derickr derickr commented Mar 4, 2025

No description provided.

derickr added 2 commits March 4, 2025 16:37
The 'IDE Key' concept hasn't been a thing for a long time, and perpetuating it
through hints and documentation is not a good idea. The pre-defined values also
make no sense, as they should refer to a **user's** name, and not an IDE name.

It is now called 'trigger' and the same cooking value can be used for Xdebug
Cloud.
Copy link
Collaborator

@FraserChapman FraserChapman left a comment

Choose a reason for hiding this comment

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

Hi,

Many thanks, just looking at this, you would also need to update the reference to idekey in options.js -

i.e.

const ideKeyInput = document.getElementById('idekey');

As is this PR would break the options form!

@FraserChapman FraserChapman added the enhancement New feature or request label Mar 6, 2025
@derickr
Copy link
Contributor Author

derickr commented Mar 6, 2025

I had totally missed those. I have made this change now, and also set up the test runner locally. Everything is green for me.

Copy link
Collaborator

@FraserChapman FraserChapman left a comment

Choose a reason for hiding this comment

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

Looks fine, and the tests pass :)

I think cleaning out the datalist makes sense, especially if the debugtrigger has additional use as "Xdebug Cloud Key".

<option value="macgdbp">MacGDBp</option>
<option value="VSCODE">VSCode</option>
</datalist>
<label for="debugtrigger">Debug Trigger or Xdebug Cloud Key</label>
Copy link
Collaborator

Choose a reason for hiding this comment

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

what is "Xdebug Cloud Key" in this context?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is the key that you can use with https://xdebug.cloud — the cloud service uses the value of the same XDEBUG_SESSION cookie, to link that incoming HTTP/Xdebug connection with an IDE, that has registered with the cloud service with the same value.

It can also be set with the xdebug.cloud_id setting, but it's much easier to be able to set/override it through the session cookie, as this would allow every different developer (or rather, browser profile) to have their own connection.

src/options.html Outdated
<option value="VSCODE">VSCode</option>
</datalist>
<label for="debugtrigger">Debug Trigger or Xdebug Cloud Key</label>
<input type="text" id="debugtrigger" placeholder="Debug trigger or Xdebug Cloud Key" value="">
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should the placeholder perhaps also be YOUR-NAME - to show the default?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good plan. I have pushed that change.

@FraserChapman FraserChapman merged commit 1a528e2 into JetBrains:main Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants