Skip to content

Commit b0523fd

Browse files
authored
Allow any case for activity types (#284)
1 parent 739d577 commit b0523fd

58 files changed

Lines changed: 283 additions & 207 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

documentation/activity-types/cd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ that its embedded link or code block points to.
66

77
#### Example
88

9-
Assuming the workspace contains a <a textrun="createDirectory">`foo`</a> directory,
9+
Assuming the workspace contains a <a textrun="create-directory">`foo`</a> directory,
1010
you can change into it via this Markdown code:
1111

12-
<a textrun="runMarkdownInTextrun">
12+
<a textrun="run-markdown-in-textrun">
1313
```markdown
1414
<a textrun="cd">
1515
Let's change into the [foo](foo) directory.

documentation/activity-types/create_directory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
#### Example
88

9-
<a textrun="runMarkdownInTextrun">
9+
<a textrun="run-markdown-in-textrun">
1010
```markdown
11-
<a textrun="createDirectory">
11+
<a textrun="create-directory">
1212
`directory_name`
1313
</a>
1414
```

documentation/activity-types/create_file.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77

88
#### Example
99

10-
<a textrun="runMarkdownInTextrun">
10+
<a textrun="run-markdown-in-textrun">
1111
```markdown
12-
<a textrun="createFile">
12+
<a textrun="create-file">
1313
_test.txt_ with content `foo`
1414
</a>
1515
```
1616
</a>
1717

1818
- or -
1919

20-
<a textrun="runMarkdownInTextrun">
20+
<a textrun="run-markdown-in-textrun">
2121
```markdown
22-
<a textrun="createFile">
22+
<a textrun="create-file">
2323

2424
__test.txt__
2525

documentation/activity-types/minimum-node-version.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ matches what CI servers test against.
77
#### Example
88

99
Assuming you have a file
10-
<a textrun="createFile">
10+
<a textrun="create-file">
1111
__.travis.yml__ with content:
1212

1313
```
@@ -19,9 +19,9 @@ node_js:
1919

2020
then you can verify that documentation like:
2121

22-
<a textrun="runMarkdownInTextrun">
22+
<a textrun="run-markdown-in-textrun">
2323
```markdown
24-
Runs on Node <a textrun="minimumNodeVersion">4</a> or above.
24+
Runs on Node <a textrun="minimum-node-version">4</a> or above.
2525
</a>
2626
```
2727
</a>

documentation/activity-types/run_console_command.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
- if you just want to verify that your Javascript has no syntax errors,
99
use the [validateJavascript](validate_javascript.md) action instead
1010

11-
<a textrun="runMarkdownInTextrun">
11+
<a textrun="run-markdown-in-textrun">
1212
```markdown
13-
<a textrun="runConsoleCommand">
13+
<a textrun="run-console-command">
1414
`​``
1515
$ echo "hello world"
1616
`​``
@@ -21,7 +21,7 @@ $ echo "hello world"
2121
You can enter text into the running command by providing an HTML table
2222
with the content to enter.
2323
Assuming we have a little application called
24-
<a textrun="createFile">
24+
<a textrun="create-file">
2525
__greeter.js__
2626
```js
2727
const readline = require('readline');
@@ -36,9 +36,9 @@ rl.question('Your name?', (name) => {
3636
```
3737
</a>
3838

39-
<a textrun="runMarkdownInTextrun">
39+
<a textrun="run-markdown-in-textrun">
4040
```markdown
41-
<a textrun="runConsoleCommand">
41+
<a textrun="run-console-command">
4242
`​``
4343
$ node greeter.js
4444
`​``
@@ -61,9 +61,9 @@ and the last one text to enter once the output from the first column has appeare
6161
Middle columns are ignored.
6262
`<th>` elements are considered descriptions and are also ignored.
6363

64-
<a textrun="runMarkdownInTextrun">
64+
<a textrun="run-markdown-in-textrun">
6565
```markdown
66-
<a textrun="runConsoleCommand">
66+
<a textrun="run-console-command">
6767
`​``
6868
$ node greeter.js
6969
`​``
@@ -102,7 +102,7 @@ If you want to call a command provided by your code base,
102102
you have to tell TextRunner the path to it.
103103
As an example, if your code provides an executable called `tool`,
104104
and it is stored as `public/tool` in your source code,
105-
<a textrun="verifySourceFileContent">
105+
<a textrun="verify-source-file-content">
106106
your __text-run.yml__ needs to contains this section:
107107

108108
```

documentation/activity-types/run_javascript.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
To run JavaScript code:
44

5-
<a textrun="runMarkdownInTextrun">
5+
<a textrun="run-markdown-in-textrun">
66
```html
7-
<a textrun="runJavascript">
7+
<a textrun="run-javascript">
88
`​``
99
console.log('This is getting executed by TextRunner!')
1010
`​``
@@ -20,9 +20,9 @@ To make it wait for asynchronous code,
2020
add the placeholder `<CALLBACK>` where your code would call the callback when its done.
2121
Example:
2222

23-
<a textrun="runMarkdownInTextrun">
23+
<a textrun="run-markdown-in-textrun">
2424
```html
25-
<a textrun="runJavascript">
25+
<a textrun="run-javascript">
2626
`​``
2727
const fs = require('fs')
2828
fs.writeFile('hello.txt', 'hello world', <CALLBACK>)
@@ -33,9 +33,9 @@ fs.writeFile('hello.txt', 'hello world', <CALLBACK>)
3333

3434

3535
Alternatively you can also use the placeholder `// ...`
36-
<a textrun="runMarkdownInTextrun">
36+
<a textrun="run-markdown-in-textrun">
3737
```html
38-
<a textrun="runJavascript">
38+
<a textrun="run-javascript">
3939
`​``
4040
const fs = require('fs')
4141
fs.writeFile('hello.txt', 'hello world', function(err) {

documentation/activity-types/start_stop_console_command.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ and stop the long-running process using a `stopCommand` block.
1010

1111

1212
#### Example
13-
<a textrun="runMarkdownInTextrun">
13+
<a textrun="run-markdown-in-textrun">
1414
```markdown
15-
<a textrun="startConsoleCommand">
15+
<a textrun="start-console-command">
1616

1717
`​``
1818
$ echo Enter your name:
@@ -22,15 +22,15 @@ $ read foo
2222

2323
Wait until it is fully booted up ...
2424

25-
<a textrun="waitForOutput">
25+
<a textrun="wait-for-output">
2626
`​``
2727
Enter your name
2828
`​``
2929
</a>
3030

3131
Interact with the server here ...
3232

33-
<a textrun="stopConsoleCommand">
33+
<a textrun="stop-console-command">
3434
Stop the current process by hitting Ctrl-C
3535
</a>
3636
```

documentation/activity-types/validate_javascript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ This action just checks that JavaScript code contains no syntax errors.
44
It is for code blocks that aren't runnable in the context of the tutorial.
55
To run Javascript code use the [runJavascript](run_javascript.md) action.
66

7-
<a textrun="runMarkdownInTextrun">
7+
<a textrun="run-markdown-in-textrun">
88
```html
9-
<a textrun="runJavascript">
9+
<a textrun="run-javascript">
1010
`​``
1111
console.log('This is getting executed by TextRunner!')
1212
`​``

documentation/activity-types/verify_npm_global_command.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This action verifies those command names in documenation.
77

88
#### Example
99

10-
<a textrun="createFile">
10+
<a textrun="create-file">
1111
Assuming our __package.json__ file looks like this:
1212

1313
```json
@@ -22,11 +22,11 @@ Assuming our __package.json__ file looks like this:
2222
then the action below verifies that the instructions describe
2323
the correct global command name exported by this NPM module.
2424

25-
<a textrun="runMarkdownInTextrun">
25+
<a textrun="run-markdown-in-textrun">
2626
```markdown
2727
To run this app, call:
2828

29-
<a textrun="verifyNpmGlobalCommand">
29+
<a textrun="verify-npm-global-command">
3030
`​``
3131
$ foo
3232
`​``

documentation/activity-types/verify_npm_install.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ that is listed in `package.json`.
88

99
#### Example
1010

11-
<a textrun="createFile">
11+
<a textrun="create-file">
1212
Assuming our __package.json__ file looks like this:
1313

1414
```json
@@ -20,9 +20,9 @@ Assuming our __package.json__ file looks like this:
2020

2121
then the action below verifies that the instructions use the correct NPM package name:
2222

23-
<a textrun="runMarkdownInTextrun">
23+
<a textrun="run-markdown-in-textrun">
2424
```markdown
25-
<a textrun="verifyNpmInstall">
25+
<a textrun="verify-npm-install">
2626
`​``
2727
$ npm i -g my_enormous_package
2828
`​``

0 commit comments

Comments
 (0)