-
Notifications
You must be signed in to change notification settings - Fork 782
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
Comments
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". |
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 |
aye |
for now, I prefer keeping both. It's good to get feedback on their uses as I believe Using only one is good for keeping QUnit lean, but we can handle this. |
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.
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>
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:
filter
→QUnit.config.filter
seed
→QUnit.config.seed
(booleantrue
replaced with a random string)module
(QUnit.config
relation to be determined by Reintroduce QUnit.config.module or QUnit.config.moduleFilter #956)testId
→QUnit.config.testId
(splitting on commas until Document and prefer multiply-specified URL parameters over comma-separated #954 is resolved)moduleId
→QUnit.config.moduleId
(splitting on commas until Document and prefer multiply-specified URL parameters over comma-separated #954 is resolved)hidepassed
→QUnit.config.hidepassed
(HTML reporter boolean option)noglobals
→QUnit.config.noglobals
notrycatch
→QUnit.config.notrycatch
QUnit.urlConfig
→QUnit.config[id]
The text was updated successfully, but these errors were encountered: