testilo 7.0.8 → 7.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -55,7 +55,7 @@ const aimScript = async () => {
|
|
|
55
55
|
id: w3c
|
|
56
56
|
};
|
|
57
57
|
const {aim} = require('testilo/aim');
|
|
58
|
-
const scriptJSON = await fs.readFile(`${process.env.SCRIPTDIR}/
|
|
58
|
+
const scriptJSON = await fs.readFile(`${process.env.SCRIPTDIR}/ts25.json`, 'utf8');
|
|
59
59
|
const script = JSON.parse(scriptJSON);
|
|
60
60
|
const aimedScript = aim(script, host, 'developer@w3c.org');
|
|
61
61
|
await fs.writeFile(
|
|
@@ -69,10 +69,10 @@ aimScript();
|
|
|
69
69
|
Execution by a user:
|
|
70
70
|
|
|
71
71
|
```bash
|
|
72
|
-
node call aim
|
|
72
|
+
node call aim ts25 https://w3.org/ 'World Wide Web Consortium' w3c developer@w3c.org
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
In these examples, a copy of the script file named `
|
|
75
|
+
In these examples, a copy of the script file named `ts25.json` in the `SCRIPTDIR` directory is aimed at the World Wide Web Consortium and then saved in the `JOBDIR` directory.
|
|
76
76
|
|
|
77
77
|
The `aim` function neither reads nor writes files. Its arguments are a script object, a host object, and a requester-email-address string, and it returns a job object, aimed at the host.
|
|
78
78
|
|
|
@@ -107,7 +107,7 @@ Execution by a module:
|
|
|
107
107
|
|
|
108
108
|
```javaScript
|
|
109
109
|
const {merge} = require('testilo/merge');
|
|
110
|
-
merge('
|
|
110
|
+
merge('ts25', 'weborgs', 'developer@w3.org')
|
|
111
111
|
.then(() => {
|
|
112
112
|
console.log('Merger complete');
|
|
113
113
|
});
|
|
@@ -116,10 +116,10 @@ merge('tp25', 'weborgs', 'developer@w3.org')
|
|
|
116
116
|
Execution by a user:
|
|
117
117
|
|
|
118
118
|
```bash
|
|
119
|
-
node call merge
|
|
119
|
+
node call merge ts25 weborgs developer@w3.org
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
In these examples, a copy of the script file named `
|
|
122
|
+
In these examples, a copy of the script file named `ts25.json` in the `SCRIPTDIR` directory is aimed at all the hosts in the batch file named `weborgs.json` in the `BATCHDIR` directory, and the resulting jobs are saved in the `JOBDIR` directory. Each job has a `sources` property that identifies an email address to be notified after the job has been run.
|
|
123
123
|
|
|
124
124
|
### `score`
|
|
125
125
|
|
|
@@ -144,7 +144,7 @@ const scoreReport = async (scoreProcID, rawReportID) => {
|
|
|
144
144
|
);
|
|
145
145
|
console.log(`Report ${scoredReport.id} scored`);
|
|
146
146
|
};
|
|
147
|
-
scoreReport('sp25a', '756mr-
|
|
147
|
+
scoreReport('sp25a', '756mr-ts25-w3c');
|
|
148
148
|
```
|
|
149
149
|
|
|
150
150
|
Execution by a user:
|
|
@@ -154,7 +154,7 @@ node call score sp25a
|
|
|
154
154
|
node call score sp25a 756mr
|
|
155
155
|
```
|
|
156
156
|
|
|
157
|
-
In these examples, the `score` function applies a score proc named `sp25a`, of which a copy is in the file `sp25a.json` in the `SCOREPROCDIR` directory, to a raw report `756mr-
|
|
157
|
+
In these examples, the `score` function applies a score proc named `sp25a`, of which a copy is in the file `sp25a.json` in the `SCOREPROCDIR` directory, to a raw report `756mr-ts25-w3c.json` in the `REPORTDIR_RAW` directory and returns the same report with score data added. The scored report is saved in the `REPORTDIR_SCORED` directory.
|
|
158
158
|
|
|
159
159
|
The user statement can pass only 2 arguments to `call` if the first report in the `REPORTDIR_RAW` directory is the desired raw report. If there are multiple reports in that directory and the desired one is not the first, the user must pass 3 arguments to `call`, and the third argument must be a string, such that the first report in that directory that begins with that string is the desired report.
|
|
160
160
|
|
|
@@ -203,7 +203,7 @@ const digestReport = async (digestProcID, scoredReportID) => {
|
|
|
203
203
|
await fs.writeFile(`${process.env.REPORTDIR_DIGESTED}/${digestedReport.id}.html`, digestedReport);
|
|
204
204
|
console.log(`Report ${digestedReport.id} digested`);
|
|
205
205
|
};
|
|
206
|
-
digestReport('dp25a', '756mr-
|
|
206
|
+
digestReport('dp25a', '756mr-ts25-w3c');
|
|
207
207
|
```
|
|
208
208
|
|
|
209
209
|
Execution by a user:
|
|
@@ -213,7 +213,7 @@ node call digest sp25a
|
|
|
213
213
|
node call digest sp25a 756mr
|
|
214
214
|
```
|
|
215
215
|
|
|
216
|
-
In these examples, the `digest` function applies a digest proc named `dp25a`, of which a copy is in the file `dp25a.json` in the `DIGESTPROCDIR` directory, to a scored report `756mr-
|
|
216
|
+
In these examples, the `digest` function applies a digest proc named `dp25a`, of which a copy is in the file `dp25a.json` in the `DIGESTPROCDIR` directory, to a scored report `756mr-ts25-w3c.json` in the `REPORTDIR_SCORED` directory and returns an HTML digest for that same report. The digest is saved in the `REPORTDIR_DIGESTED` directory.
|
|
217
217
|
|
|
218
218
|
The user statement can pass only 2 arguments to `call` if the first report in the `REPORTDIR_SCORED` directory is the desired scored report. If there are multiple reports in that directory and the desired one is not the first, the user must pass 3 arguments to `call`, and the third argument must be a string, such that the first report in that directory that begins with that string is the desired report.
|
|
219
219
|
|