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

Document URL parameters for HTML Runner #1747

Closed
gibson042 opened this issue Dec 15, 2015 · 4 comments
Closed

Document URL parameters for HTML Runner #1747

gibson042 opened this issue Dec 15, 2015 · 4 comments
Assignees

Comments

@gibson042
Copy link
Member

Assuming the QUnit URL parameters are to be treated as part of the public interface (rather than just a mechanism for conveying GUI interactions to subsequent loads), we should document them:

@gibson042
Copy link
Member Author

Since this issue is getting hot, I think it's worth asking if all of those parameters are to be treated as public interface... in short, do we feel comfortable with encouraging manually-constructed URLs and not breaking them between major releases?

For my own part, I say "yes".

@trentmwillis
Copy link
Member

do we feel comfortable with encouraging manually-constructed URLs and not breaking them between major releases?

I vote "yes" as well, and know that most developers I work with do manually construct urls currently anyway.

With that said, I'm not sure we should keep both module and moduleId as they seem redundant. I'll add more context to that in the appropriate issue.

@leobalter
Copy link
Member

aye

@leobalter
Copy link
Member

I'm not sure we should keep both module and moduleId as they seem redundant.

for now, I prefer keeping both. It's good to get feedback on their uses as I believe module=<name> might still be better for some particular and manual usages, but moduleId is good for interface use.

Using only one is good for keeping QUnit lean, but we can handle this.

@Krinkle Krinkle transferred this issue from qunitjs/api.qunitjs.com Dec 29, 2018
@Krinkle Krinkle transferred this issue from qunitjs/qunit Aug 30, 2020
@Krinkle Krinkle changed the title Document URL parameters Create page for HTML Runner to document URL parameters Mar 29, 2024
@Krinkle Krinkle transferred this issue from qunitjs/qunitjs.com Mar 29, 2024
@Krinkle Krinkle changed the title Create page for HTML Runner to document URL parameters Document URL parameters for HTML Runner Mar 29, 2024
@Krinkle Krinkle self-assigned this Jun 28, 2024
Krinkle added a commit that referenced this issue Jun 28, 2024
This restores the first half of the Cookbook that Jörn originally
wrote on the original qunitjs.com website. We removed this during the
redesign in 2020, but we hadn't found a new place for everything.

qunitjs/qunitjs.com#151
https://github.com/qunitjs/qunitjs.com/blob/v2.10.2/pages/cookbook.html

* Update config doc pages to reflect whether something is part of
  Browser Runner (active in any browser environment), or the
  HTML Reporter. These have been separated now per
  #1118, as QUnit.reporters.html,
  and deals purely with what happens inside the optional `div[id=qunit]`
  element.

* Move browser-related content from intro.md to the new browser.md.
  We should probably do the same for Node.js/CLI as well, and focus
  this only on env-agnostic getting started. This would be easier
  if the example use export/import ESM instead of having to assume
  either module.exports (Node.js) or globals (browser).

Co-authored-by: Jörn Zaefferer <joern.zaefferer@gmail.com>

Fixes #1748.
Fixes #1747.
Krinkle added a commit that referenced this issue Jun 28, 2024
This restores the first half of the Cookbook that Jörn originally
wrote on the original qunitjs.com website. We removed this during the
redesign in 2020, but we hadn't found a new place for everything.

qunitjs/qunitjs.com#151
https://github.com/qunitjs/qunitjs.com/blob/v2.10.2/pages/cookbook.html

* Update config doc pages to reflect whether something is part of
  Browser Runner (active in any browser environment), or the
  HTML Reporter. These have been separated now per
  #1118, as QUnit.reporters.html,
  and deals purely with what happens inside the optional `div[id=qunit]`
  element.

* Move browser-related content from intro.md to the new browser.md.
  We should probably do the same for Node.js/CLI as well, and focus
  this only on env-agnostic getting started. This would be easier
  if the example use export/import ESM instead of having to assume
  either module.exports (Node.js) or globals (browser).

Fixes #1748.
Fixes #1747.

Co-authored-by: Jörn Zaefferer <joern.zaefferer@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants