Skip to content

Commit e500e65

Browse files
committed
Fix code placeholders in docs
1 parent 481d397 commit e500e65

File tree

5 files changed

+74
-73
lines changed

5 files changed

+74
-73
lines changed

compile.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ const path = require("path");
55
const fs = require("fs-extra");
66

77
const pathRegexp = /\.\/src\/(?<language>[^/\s]+)\/(?<module>[^/\s]+)\/(([^\s/]+\/)+)?(?<name>[^/\s.]+)(\.?(?<ext>[^/\s.]+))?/;
8+
const placeholderRegexp = /\${\d+:?(?<placeholder>\S+)?}/g;
89

910
function generateLanguageFile(language) {
1011
const data = [];
@@ -42,11 +43,11 @@ function generateReadme() {
4243
readMe.push("```");
4344
readMe.push("**Generated code**:");
4445
readMe.push(`\`\`\`${ext}`);
45-
readMe.push(`${value.body}`);
46+
readMe.push(`${value.body.replace(/(?<=\${\d+:\S+)}/g, "").replace(/\${\d+:?}?/g, "")}`);
4647
readMe.push("```");
4748
});
4849

49-
fs.outputFileSync(`docs/${language}/${module}/${name}.md`, readMe.join("\n").replace(/\${\d+}/g, ""));
50+
fs.outputFileSync(`docs/${language}/${module}/${name}.md`, readMe.join("\n"));
5051
});
5152
}
5253

docs/javascript/ember-concurrency/cheats.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Returns true if the object passed to it is a TaskCancelation error.
99
```
1010
**Generated code**:
1111
```js
12-
didCancel(${1:error})
12+
didCancel(error)
1313
```
1414
### `task(...)`
1515
**Prefix:** `task`
@@ -44,7 +44,7 @@ Yielding timeout(ms) will pause a task for the duration of time passed in, in mi
4444
```
4545
**Generated code**:
4646
```js
47-
yield timeout(${1:0});
47+
yield timeout(0);
4848
```
4949
### `waitForEvent(eventName)`
5050
**Prefix:** `waitForEvent`
@@ -55,7 +55,7 @@ Use waitForEvent to pause the task until an event is fired.
5555
```
5656
**Generated code**:
5757
```js
58-
yield waitForEvent(${1:eventName});
58+
yield waitForEvent(eventName);
5959
```
6060
### `waitForProperty(propertyName)`
6161
**Prefix:** `waitForProperty`
@@ -66,7 +66,7 @@ Use waitForProperty to pause the task until a property on an object changes to s
6666
```
6767
**Generated code**:
6868
```js
69-
yield waitForProperty(${1:propertyName});
69+
yield waitForProperty(propertyName);
7070
```
7171
### `waitForQueue(queueName)`
7272
**Prefix:** `waitForQueue`
@@ -77,5 +77,5 @@ Use waitForQueue to pause the task until a certain run loop queue is reached.
7777
```
7878
**Generated code**:
7979
```js
80-
yield waitForQueue(${1:queueName});
80+
yield waitForQueue(queueName);
8181
```

docs/javascript/ember-data/cheats.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ findAll(...)
99
```
1010
**Generated code**:
1111
```js
12-
this.store.findAll('${1:model}');
12+
this.store.findAll('model');
1313
```
1414
### `findRecord(...)`
1515
**Prefix:** `findRecord`
@@ -20,7 +20,7 @@ findRecord(...)
2020
```
2121
**Generated code**:
2222
```js
23-
this.store.findRecord('${1:model}', params.${1:model}_id);
23+
this.store.findRecord('model', params.model_id);
2424
```
2525
### `peekAll(...)`
2626
**Prefix:** `peekAll`
@@ -31,7 +31,7 @@ peekAll(...)
3131
```
3232
**Generated code**:
3333
```js
34-
this.store.peekAll('${1:model}');
34+
this.store.peekAll('model');
3535
```
3636
### `peekRecord(...)`
3737
**Prefix:** `peekRecord`
@@ -42,7 +42,7 @@ peekRecord(...)
4242
```
4343
**Generated code**:
4444
```js
45-
this.store.peekRecord('${1:model}', params.${1:model}_id);
45+
this.store.peekRecord('model', params.model_id);
4646
```
4747
### `query(...)`
4848
**Prefix:** `queryAll`
@@ -53,7 +53,7 @@ query(...)
5353
```
5454
**Generated code**:
5555
```js
56-
this.store.query('${1:model}', { ${2:queryKey}: ${3:queryValue}});
56+
this.store.query('model', { queryKey: queryValue);
5757
```
5858
### `queryRecord(...)`
5959
**Prefix:** `queryRecord`
@@ -64,5 +64,5 @@ queryRecord(...)
6464
```
6565
**Generated code**:
6666
```js
67-
this.store.queryRecord('${1:model}', { ${2:queryKey}: ${3:queryValue}});
67+
this.store.queryRecord('model', { queryKey: queryValue);
6868
```

docs/javascript/ember-test-helpers/cheats.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ await click(...)
99
```
1010
**Generated code**:
1111
```js
12-
await click('${1:selector}');
12+
await click('selector');
1313
```
1414
### `await doubleClick(...)`
1515
**Prefix:** `doubleClick`
@@ -20,7 +20,7 @@ await doubleClick(...)
2020
```
2121
**Generated code**:
2222
```js
23-
await doubleClick('${1:selector}');
23+
await doubleClick('selector');
2424
```
2525
### `await tap(...)`
2626
**Prefix:** `tap`
@@ -31,7 +31,7 @@ await tap(...)
3131
```
3232
**Generated code**:
3333
```js
34-
await tap('${1:selector}');
34+
await tap('selector');
3535
```
3636
### `await focus(...)`
3737
**Prefix:** `focus`
@@ -42,7 +42,7 @@ await focus(...)
4242
```
4343
**Generated code**:
4444
```js
45-
await focus('${1:selector}');
45+
await focus('selector');
4646
```
4747
### `await blur(...)`
4848
**Prefix:** `blur`
@@ -53,7 +53,7 @@ await blur(...)
5353
```
5454
**Generated code**:
5555
```js
56-
await blur('${1:selector}');
56+
await blur('selector');
5757
```
5858
### `await triggerKeyEvent(...)`
5959
**Prefix:** `triggerKeyEvent`
@@ -64,7 +64,7 @@ await triggerKeyEvent(...)
6464
```
6565
**Generated code**:
6666
```js
67-
await triggerKeyEvent('${1:sel}', '${2:type}', '${3:key}', '${4:mods}');
67+
await triggerKeyEvent('sel', 'type', 'key', 'mods');
6868
```
6969
### `await triggerEvent(...)`
7070
**Prefix:** `triggerEvent`
@@ -75,7 +75,7 @@ await triggerEvent(...)
7575
```
7676
**Generated code**:
7777
```js
78-
await triggerEvent('${1:selector}', '${2:type}', '${3:options}');
78+
await triggerEvent('selector', 'type', 'options');
7979
```
8080
### `await fillIn(...)`
8181
**Prefix:** `fillIn`
@@ -86,7 +86,7 @@ await fillIn(...)
8686
```
8787
**Generated code**:
8888
```js
89-
await fillIn('${1:selector}', '${2:text}');
89+
await fillIn('selector', 'text');
9090
```
9191
### `await find(...)`
9292
**Prefix:** `find`
@@ -97,7 +97,7 @@ await find(...)
9797
```
9898
**Generated code**:
9999
```js
100-
find('${1:selector}');
100+
find('selector');
101101
```
102102
### `await findAll(...)`
103103
**Prefix:** `findAll`
@@ -108,7 +108,7 @@ await findAll(...)
108108
```
109109
**Generated code**:
110110
```js
111-
findAll('${1:selector}');
111+
findAll('selector');
112112
```
113113
### `getRootElement()`
114114
**Prefix:** `getRootElement`
@@ -130,7 +130,7 @@ await visit(...)
130130
```
131131
**Generated code**:
132132
```js
133-
await visit('${1:url}');
133+
await visit('url');
134134
```
135135
### `currentRouteName()`
136136
**Prefix:** `currentRouteName`
@@ -185,7 +185,7 @@ await waitFor(...)
185185
```
186186
**Generated code**:
187187
```js
188-
await waitFor('${1:selector}'${2:, { timeout: 1000, count: 1 \}});
188+
await waitFor('selector', { timeout: 1000, count: 1 \}});
189189
```
190190
### `await waitUntil(...)`
191191
**Prefix:** `waitUntil`
@@ -196,7 +196,7 @@ await waitUntil(...)
196196
```
197197
**Generated code**:
198198
```js
199-
await waitUntil(() => { $1; }${2:, { timeout: 1000 \}});
199+
await waitUntil(() => { $1; }, { timeout: 1000 \}});
200200
```
201201
### `await settled()`
202202
**Prefix:** `settled`

0 commit comments

Comments
 (0)