Docs: Add "version added" to all methods

Krinkle · Krinkle · commit 7db059dd9ced · 2020-07-21T03:06:24.000+01:00
Those marked as added in 1.0 were confirmed via source at: <https://github.com/qunitjs/qunit/blob/1.0.0/qunit/qunit.js#L254>. The others based on release notes in History.md. Fixes #1353.
diff --git a/docs/QUnit/module.md b/docs/QUnit/module.md
@@ -7,6 +7,7 @@ categories:
 redirect_from:
   - "/QUnit.module/"
   - "/module/"
+version_added: "1.0"
 ---
 
 `QUnit.module( name [, hooks] [, nested ] )`
diff --git a/docs/QUnit/only.md b/docs/QUnit/only.md
@@ -4,6 +4,7 @@ title: QUnit.only()
 description: Add a test that is exclusively run.
 categories:
   - main
+version_added: "1.20"
 ---
 
 `QUnit.only( name, callback )`
diff --git a/docs/QUnit/skip.md b/docs/QUnit/skip.md
@@ -4,6 +4,7 @@ title: QUnit.skip()
 description: Add a test that will be skipped.
 categories:
   - main
+version_added: "1.16"
 ---
 
 `QUnit.skip( name )`
diff --git a/docs/QUnit/start.md b/docs/QUnit/start.md
@@ -7,6 +7,7 @@ categories:
   - async
 redirect_from:
   - "/start/"
+version_added: "1.0"
 ---
 
 `QUnit.start()` must be used to start a test run that has [`QUnit.config.autostart`](../config/QUnit.config.md) set to `false`.
diff --git a/docs/QUnit/test.md b/docs/QUnit/test.md
@@ -10,6 +10,7 @@ redirect_from:
   - "/QUnit.test/"
   - "/asyncTest/"
   - "/test/"
+version_added: "1.0"
 ---
 
 `QUnit.test( name, callback )`
diff --git a/docs/QUnit/todo.md b/docs/QUnit/todo.md
@@ -4,6 +4,7 @@ title: QUnit.todo()
 description: Add a test which expects at least one failing assertion.
 categories:
   - main
+version_added: "2.2"
 ---
 
 `QUnit.todo( name, callback )`
diff --git a/docs/_includes/version.html b/docs/_includes/version.html
@@ -0,0 +1,18 @@
+{%- comment -%}
+    @param (string) version Like "1.0", "2.2", or "unreleased".
+    @param (string) label Like "version added", "deprecated in", or "removed in".
+{%- endcomment -%}
+
+{%- assign _old_releases = " v1.0.0 v1.11.0 " -%}
+
+{%- assign _full_version = include.version | append: ".0" -%}
+{%- assign _old_version = _full_version | prepend: "v" -%}
+{%- if _old_releases contains _old_version -%}
+    {%- assign _full_version = _old_version -%}
+{%- endif -%}
+
+{%- if include.version == "unreleased" -%}
+not yet released
+{%- else -%}
+{{ include.label }}: <a href="https://github.com/qunitjs/qunit/releases/tag/{{ _full_version }}">{{ include.version }}</a>
+{%- endif -%}
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -58,5 +58,26 @@ <h4>Async control</h4>
 </section>
 <div id="main" class="main" role="main">
     <h2>{{ page.title }}</h2>
+    {%- if page.version_added or page.version_deprecated -%}
+        {%- assign warning = false -%}
+        {%- if page.version_added == "unreleased" or page.version_deprecated or page.version_removed -%}
+            {%- assign warning = true -%}
+        {%- endif -%}
+
+    <p class="version-details{% if warning %} version-details--warning{% endif %}">
+        {%- capture lines -%}
+            {%- if page.version_added %}
+                {% include version.html version=page.version_added label="version added" %}
+            {%- endif -%}
+            {%- if page.version_deprecated %}
+                {% include version.html version=page.version_deprecated label="deprecated in" %}
+            {%- endif -%}
+            {%- if page.version_removed %}
+                {% include version.html version=page.version_removed label="removed in" %}
+            {%- endif -%}
+        {%- endcapture -%}
+        {{ lines | strip | newline_to_br }}
+    </p>
+    {%- endif %}
     {{ content }}
 </div>
diff --git a/docs/assert/async.md b/docs/assert/async.md
@@ -9,6 +9,7 @@ redirect_from:
   - "/QUnit.stop/"
   - "/QUnit/stop/"
   - "/stop/"
+version_added: "1.16"
 ---
 
 `async( [ acceptCallCount = 1 ] )`
diff --git a/docs/assert/deepEqual.md b/docs/assert/deepEqual.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/deepEqual/"
+version_added: "1.0"
 ---
 
 `deepEqual( actual, expected [, message ] )`
diff --git a/docs/assert/equal.md b/docs/assert/equal.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/equal/"
+version_added: "1.0"
 ---
 
 `equal( actual, expected [, message ] )`
diff --git a/docs/assert/expect.md b/docs/assert/expect.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/expect/"
+version_added: "1.0"
 ---
 
 `expect( amount )`
diff --git a/docs/assert/false.md b/docs/assert/false.md
@@ -4,6 +4,7 @@ title: assert.false()
 description: A strict boolean false comparison.
 categories:
   - assert
+version_added: unreleased
 ---
 
 `false( actual [, message ] )`
diff --git a/docs/assert/notDeepEqual.md b/docs/assert/notDeepEqual.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/notDeepEqual/"
+version_added: "1.0"
 ---
 
 `notDeepEqual( actual, expected [, message ] )`
diff --git a/docs/assert/notEqual.md b/docs/assert/notEqual.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/notEqual/"
+version_added: "1.0"
 ---
 
 `notEqual( actual, expected [, message ] )`
diff --git a/docs/assert/notOk.md b/docs/assert/notOk.md
@@ -4,6 +4,7 @@ title: assert.notOk()
 description: Check if the first argument is falsy.
 categories:
   - assert
+version_added: "1.18"
 ---
 
 `notOk( state [, message ] )`
diff --git a/docs/assert/notPropEqual.md b/docs/assert/notPropEqual.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/notPropEqual/"
+version_added: "1.11"
 ---
 
 `notPropEqual( actual, expected [, message ] )`
diff --git a/docs/assert/notStrictEqual.md b/docs/assert/notStrictEqual.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/notStrictEqual/"
+version_added: "1.0"
 ---
 
 `notStrictEqual( actual, expected [, message ] )`
diff --git a/docs/assert/ok.md b/docs/assert/ok.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/ok/"
+version_added: "1.0"
 ---
 
 `ok( state [, message ] )`
diff --git a/docs/assert/propEqual.md b/docs/assert/propEqual.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/propEqual/"
+version_added: "1.11"
 ---
 
 `propEqual( actual, expected [, message ] )`
diff --git a/docs/assert/pushResult.md b/docs/assert/pushResult.md
@@ -4,6 +4,7 @@ title: assert.pushResult()
 description: Report the result of a custom assertion.
 categories:
   - assert
+version_added: "1.22"
 ---
 
 `pushResult( data: { result, actual, expected, message } )`
diff --git a/docs/assert/rejects.md b/docs/assert/rejects.md
@@ -4,6 +4,7 @@ title: assert.rejects()
 description: Test if the provided promise rejects.
 categories:
   - assert
+version_added: "2.5"
 ---
 
 `rejects( promise[, expectedMatcher][, message ] )`
diff --git a/docs/assert/step.md b/docs/assert/step.md
@@ -4,6 +4,7 @@ title: assert.step()
 description: A marker for progress in a given test.
 categories:
   - assert
+version_added: "2.2"
 ---
 
 `step( [ message ] )`
diff --git a/docs/assert/strictEqual.md b/docs/assert/strictEqual.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/strictEqual/"
+version_added: "1.0"
 ---
 
 `strictEqual( actual, expected [, message ] )`
diff --git a/docs/assert/throws.md b/docs/assert/throws.md
@@ -6,6 +6,7 @@ categories:
   - assert
 redirect_from:
   - "/throws/"
+version_added: "1.0"
 ---
 
 `throws( blockFn[, expectedMatcher][, message ] )`
diff --git a/docs/assert/timeout.md b/docs/assert/timeout.md
@@ -5,6 +5,7 @@ description: Set the length of time to wait for async operations before failing
 categories:
   - assert
   - async
+version_added: "2.4"
 ---
 
 `timeout( duration )`
diff --git a/docs/assert/true.md b/docs/assert/true.md
@@ -4,6 +4,7 @@ title: assert.true()
 description: A strict boolean true comparison.
 categories:
   - assert
+version_added: unreleased
 ---
 
 `true( actual [, message ] )`
diff --git a/docs/assert/verifySteps.md b/docs/assert/verifySteps.md
@@ -4,6 +4,7 @@ title: assert.verifySteps()
 description: A helper assertion to verify the order and number of steps in a test.
 categories:
   - assert
+version_added: "2.2"
 ---
 
 `verifySteps( steps [, message ] )`
diff --git a/docs/callbacks/QUnit.begin.md b/docs/callbacks/QUnit.begin.md
@@ -6,6 +6,7 @@ categories:
   - callbacks
 redirect_from:
   - "/QUnit.begin/"
+version_added: "1.0"
 ---
 
 `QUnit.begin( callback )`
diff --git a/docs/callbacks/QUnit.done.md b/docs/callbacks/QUnit.done.md
@@ -6,6 +6,7 @@ categories:
   - callbacks
 redirect_from:
   - "/QUnit.done/"
+version_added: "1.0"
 ---
 
 `QUnit.done( callback )`
diff --git a/docs/callbacks/QUnit.log.md b/docs/callbacks/QUnit.log.md
@@ -6,6 +6,7 @@ categories:
   - callbacks
 redirect_from:
   - "/QUnit.log/"
+version_added: "1.0"
 ---
 
 `QUnit.log( callback )`
diff --git a/docs/callbacks/QUnit.moduleDone.md b/docs/callbacks/QUnit.moduleDone.md
@@ -6,6 +6,7 @@ categories:
   - callbacks
 redirect_from:
   - "/QUnit.moduleDone/"
+version_added: "1.0"
 ---
 
 `QUnit.moduleDone( callback )`
diff --git a/docs/callbacks/QUnit.moduleStart.md b/docs/callbacks/QUnit.moduleStart.md
@@ -6,6 +6,7 @@ categories:
   - callbacks
 redirect_from:
   - "/QUnit.moduleStart/"
+version_added: "1.0"
 ---
 
 `QUnit.moduleStart( callback )`
diff --git a/docs/callbacks/QUnit.on.md b/docs/callbacks/QUnit.on.md
@@ -4,6 +4,7 @@ title: QUnit.on()
 description: Register a callback to fire whenever the specified event is emitted.
 categories:
   - callbacks
+version_added: "2.2"
 ---
 
 `QUnit.on( eventName, callback )`
diff --git a/docs/callbacks/QUnit.testDone.md b/docs/callbacks/QUnit.testDone.md
@@ -6,6 +6,7 @@ categories:
   - callbacks
 redirect_from:
   - "/QUnit.testDone/"
+version_added: "1.0"
 ---
 
 `QUnit.testDone( callback )`
diff --git a/docs/callbacks/QUnit.testStart.md b/docs/callbacks/QUnit.testStart.md
@@ -6,6 +6,7 @@ categories:
   - callbacks
 redirect_from:
   - "/QUnit.testStart/"
+version_added: "1.0"
 ---
 
 `QUnit.testStart( callback )`
diff --git a/docs/config/QUnit.assert.md b/docs/config/QUnit.assert.md
@@ -4,6 +4,7 @@ title: QUnit.assert
 description: Namespace for QUnit assertions.
 categories:
   - config
+version_added: "1.7"
 ---
 
 Namespace for QUnit assertions.
diff --git a/docs/config/QUnit.dump.parse.md b/docs/config/QUnit.dump.parse.md
@@ -6,6 +6,7 @@ description: Advanced and extensible data dumping for JavaScript
 redirect_from:
   - "/QUnit.dump.parse/"
   - "/QUnit.jsDump.parse/"
+version_added: "1.0"
 ---
 
 `QUnit.dump.parse( data )`
diff --git a/docs/config/QUnit.extend.md b/docs/config/QUnit.extend.md
@@ -3,6 +3,7 @@ layout: default
 categories: [config]
 title: QUnit.extend()
 description: Copy the properties defined by the <code>mixin</code> object into the <code>target</code> object.
+version_added: "1.0"
 ---
 
 `QUnit.extend( target, mixin )`
diff --git a/docs/config/QUnit.push.md b/docs/config/QUnit.push.md
@@ -4,11 +4,13 @@ categories: [config]
 title: QUnit.push()
 status: deprecated
 description: "<strong>DEPRECATED</strong> Report the result of a custom assertion."
+version_added: "1.0"
+version_deprecated: "2.1"
 ---
 
 `QUnit.push( result, actual, expected, message )`
 
-__DEPRECATED__: Report the result of a custom assertion.
+Report the result of a custom assertion.
 
 | name               | description                          |
 |--------------------|--------------------------------------|
diff --git a/docs/config/QUnit.stack.md b/docs/config/QUnit.stack.md
@@ -3,6 +3,7 @@ layout: default
 categories: [config]
 title: QUnit.stack()
 description: Return a single line string representing the stacktrace.
+version_added: "1.19"
 ---
 
 `QUnit.stack( [ offset = 0 ] )`
diff --git a/docs/css/styles.scss b/docs/css/styles.scss
@@ -176,6 +176,17 @@ hr {
 	display: none;
 }
 
+.version-details {
+	font-size: 90%;
+	font-weight: bold;
+	background: $color-light;
+	padding: 0.2em 0.4em;
+}
+.version-details--warning {
+	background-color: #fdf5c5;
+	border-color: #e6d252;
+}
+
 @media (min-width: $screen-m) {
 	.body {
 		display: flex;
@@ -186,6 +197,13 @@ hr {
 		flex: 0 0 220px;
 		margin-right: 20px;
 	}
+
+	.version-details {
+		clear: right;
+		float: right;
+		text-align: right;
+		border: 1px solid $color-off-white;
+	}
 }
 
 table {
