| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435 | 1x
1x
1x
1x
1x
1x
1x
40x
21x
19x
19x
1x
18x
18x
2x
1x
1x
16x
17x
4x
1x
3x
3x
3x
1x
2x
13x
15x
3x
1x
2x
2x
2x
2x
12x
1x
11x
13x
3x
1x
2x
1x
1x
10x
10x
11x
2x
1x
1x
9x
10x
1x | import detectFormat from '../modules/detectFormat';
import detectVersion from '../modules/detectVersion';
import documentConstructor from '../modules/documentConstructor';
import documentFactory from '../modules/documentFactory';
import IDocumentLike from '../NodeLike/ParentNodeLike/DocumentLike/IDocumentLike';
import IElementLike from '../NodeLike/ParentNodeLike/ElementLike/IElementLike';
import ILinter from './ILinter';
import ILinterOptions from './ILinterOptions';
import ILinterOptionsArgument from './ILinterOptionsArgument'
import IParser from '../Parser/IParser';
import isIElementLike from '../TypeGuards/isIElementLike';
import ITask from '../Task/ITask';
import constants from '../constants';
import TIndexableObject from '../TypeAliases/TIndexableObject';
import TPassage from '../TypeAliases/TPassage';
const semver = require('semver');
class Linter implements ILinter {
readonly parser: IParser;
readonly options: ILinterOptions;
constructor(
parser: IParser,
options: ILinterOptionsArgument = {})
{
if (!parser || typeof parser.parse !== 'function') {
throw new Error('The parser argument did not have a parse method.');
}
this.parser = parser;
if (!options || typeof options !== 'object') {
throw new Error('The options argument was not an object.');
}
const opts = <TIndexableObject>{};
if ('passageIgnores' in options) {
if (typeof options.passageIgnores !== 'object') {
throw new Error('The passageIgnores property of the options ' +
'argument was not an object.');
}
opts.passageIgnores = options.passageIgnores;
} else {
opts.passageIgnores = constants.passageIgnores;
}
if ('detectionMode' in options) {
if (!options.detectionMode ||
typeof options.detectionMode !== 'string')
{
throw new Error('The detectionMode property of the options argument ' +
'was not a string with content.');
}
const detectionMode = options.detectionMode.toLowerCase();
const keys = Object.keys(constants.detectionModes);
if (keys.indexOf(detectionMode) === -1) {
throw new Error('The detectionMode property of the options argument ' +
'was not a recognized detection mode. Recognized modes ' +
`are ${keys.join(', ')}.`);
}
opts.detectionMode = detectionMode;
} else {
opts.detectionMode = 'manual';
}
if ('format' in options) {
if (typeof options.format !== 'string') {
throw new Error('The format property of the options argument was ' +
'not a string.');
}
const format = options.format.toLowerCase();
const keys = Object.keys(constants.formats);
Iif (keys.indexOf(format) === -1) {
throw new Error('The format property of the options argument ' +
'was not a recognized format. Recognized formats ' +
`are ${keys.join(', ')}.`);
}
opts.format = format;
} else {
if (!isIElementLike(options.storyData)) {
throw new Error('The options.storyData argument is not an element.');
}
opts.format = detectFormat(options.storyData, opts.detectionMode);
}
if ('version' in options) {
if (typeof options.version !== 'string') {
throw new Error('The version property of the options argument was ' +
'not a string.');
} else if (!semver.valid(options.version)) {
throw new Error('The version property of the options argument was ' +
'not a valid semantic version.');
}
opts.version = options.version;
} else {
Iif (!isIElementLike(options.storyData)) {
throw new Error('The storyDataElem argument is not an element.');
}
opts.version = detectVersion(options.storyData, opts.detectionMode);
}
if ('documentConstructor' in options) {
if (typeof options.documentConstructor !== 'function') {
throw new Error('The documentConstructor property of the options ' +
'argument is not a function.');
}
opts.documentConstructor = options.documentConstructor;
} else {
opts.documentConstructor = documentConstructor;
}
this.options = <ILinterOptions>opts;
}
lint(
storyData: IElementLike,
tasks: Array<ITask>,
options?: ILinterOptions): Array<ITask>
{
if (!tasks ||
typeof tasks !== 'object' ||
Number.isNaN(Number(tasks.length)) ||
typeof tasks.forEach !== 'function')
{
throw new Error('The tasks argument was not an array.');
} else if (tasks.length <= 0) {
throw new Error('No tasks were provided to the lint method.');
}
tasks.forEach((task) => {
if (!task || typeof task !== 'object') {
throw new Error('One of the tasks was not an object.');
} if (typeof task.execute !== 'function' &&
typeof task.executeMicrotask !== 'function')
{
throw new Error('One of the tasks had neither an execute nor an ' +
'executeMicrotask method.');
}
});
let _opts: ILinterOptionsArgument;
if (typeof options === 'undefined') {
if (!this.options || typeof options !== 'object') {
throw new Error('The options property of this Linter is not an object.');
}
_opts = JSON.parse(JSON.stringify(this.options));
} else {
_opts = JSON.parse(JSON.stringify(options));
}
const opts = <ILinterOptions>_opts;
if (!opts.format || typeof opts.format !== 'string') {
throw new Error('The options.format property of this Linter was not a ' +
'string with content.');
}
opts.format = opts.format.toLowerCase();
const keys = Object.keys(constants.formats);
if (keys.indexOf(opts.format.toLowerCase()) === -1) {
throw new Error('The options.format property on this Linter is not ' +
'contained in constants.formats.');
} else if (!opts.version || typeof opts.version !== 'string') {
throw new Error('The options.version property of this Linter was not ' +
'a string.');
} else if (!semver.valid(opts.version)) {
throw new Error('The options.version property of this Linter was not ' +
'a valid semantic version.');
} else if (typeof opts.documentConstructor !== 'function') {
throw new Error('The options.documentConstructor property on this ' +
'Linter was not a function.');
}
const passages = this.generateILStageOne(storyData, opts);
const isolationChambers: Array<IDocumentLike> = [];
let len = 1;
if (opts.runInIsolation) {
len = tasks.length;
}
for (let ii = 0; ii < len; ii += 1) {
const doc = documentFactory(
passages,
opts.documentConstructor);
isolationChambers.push(doc);
}
return this.runTasks(tasks, isolationChambers, opts);
}
generateILStageOne(
storyData: IElementLike,
options?: ILinterOptions): Array<TPassage>
{
let opts = options;
if (!isIElementLike(storyData)) {
throw new Error('The storyDataElem argument was not an element.');
} else if (typeof opts === 'undefined') {
opts = this.options;
if (!opts || typeof opts !== 'object') {
throw new Error('The options argument was not provided, and the ' +
'options property on this Linter was not an object.');
}
}
const passages: Array<TPassage> = [];
let counter = 0;
const children = storyData.children;
for (let ii = 0; ii < children.length; ii += 1) {
const child = children[ii];
const tagName = child.tagName.toLowerCase();
let passageName;
const version = opts.version;
let requirement = '^1';
if (semver.satisfies(version, requirement)) {
passageName = child.getAttribute('tiddler');
}
requirement = '^2';
if (semver.satisfies(require, '2')) {
passageName = child.getAttribute('name');
} else {
passageName = `UNKNOWN_${counter}`;
}
if (!passageName) {
throw new Error('A passage name could not be found in one of the ' +
'passage elements.');
}
/* Don't lint any passages that match on element tag or passage name. */
if (this.options.passageIgnores.elementTags.indexOf(tagName) !== -1 ||
this.options.passageIgnores.passageNames.indexOf(passageName) !== -1)
{
continue;
}
/* Don't lint any passages that match on a passage tag. */
const tags = (child.getAttribute('tags') || '')
.split(' ')
.filter(aa => aa);
let found = false;
for (let ii = 0; ii < tags.length; ii += 1) {
const tag = tags[ii];
if (this.options.passageIgnores.passageTags.indexOf(tag) !== -1) {
found = true;
break;
}
}
/* Skip the passage if a tag matched an ignore rule. */
if (found) {
continue;
}
const abstractSyntaxTree = this.parser.parse(child.textContent);
if (!abstractSyntaxTree || !abstractSyntaxTree.length) {
throw new Error('There is no output.');
}
passages.push({
abstractSyntaxTree,
passageName,
tags,
});
counter += 1;
}
return passages;
}
generateILStageTwo(passages: Array<TPassage>): IDocumentLike {
return documentFactory(passages);
}
protected runTasks(
tasks: Array<ITask>,
isolationChambers: Array<IDocumentLike>,
linterOptions: ILinterOptions,
taskOptions: Array<any> = []): Array<ITask>
{
if (linterOptions.runInIsolation) {
return this.runTasksInIsolation(
tasks,
isolationChambers,
linterOptions,
taskOptions);
} else {
return this.runTasksInParallel(
tasks,
isolationChambers[0],
linterOptions,
taskOptions);
}
}
protected runTasksInParallel(
tasks: Array<ITask>,
document: IDocumentLike,
linterOptions: ILinterOptions,
options: Array<any> = []): Array<ITask>
{
tasks.forEach((task) => {
task.preSetup(document, options);
});
tasks.forEach((task) => {
task.setup(document, options);
});
tasks.forEach((task) => {
task.postSetup(document, options);
});
tasks.forEach((task) => {
task.preExecute(document, options);
});
const children = document.querySelector('tw-storydata').children;
for (let ii = 0; ii < children.length; ii += 1) {
const passageData = children[ii];
const passageName = passageData.getAttribute('name');
const descendants = passageData.querySelectorAll('*');
for (let jj = 0; jj < descendants.length; jj += 1) {
const descendant = descendants[jj];
tasks.forEach((task) => {
(<Function>task.executeMicrotask)(
descendant,
passageName,
linterOptions.format,
linterOptions.version
);
});
}
}
tasks.forEach((task) => {
task.postExecute(document, options);
});
tasks.forEach((task) => {
task.preComplete(document, options);
});
tasks.forEach((task) => {
task.complete(document, options);
});
tasks.forEach((task) => {
task.postComplete(document, options);
});
return tasks;
}
protected runTasksInIsolation(
tasks: Array<ITask>,
isolationChambers: Array<IDocumentLike>,
linterOptions: ILinterOptions,
options: Array<any> = []): Array<ITask>
{
tasks.forEach((task, ii) => {
task.preSetup(isolationChambers[ii], options);
});
tasks.forEach((task, ii) => {
task.setup(isolationChambers[ii], options);
});
tasks.forEach((task, ii) => {
task.postSetup(isolationChambers[ii], options);
});
tasks.forEach((task, ii) => {
task.preExecute(isolationChambers[ii], options);
});
tasks.forEach((task, ii) => {
if (typeof task.execute === 'function') {
task.execute(isolationChambers[ii], options);
} else if (typeof task.executeMicrotask === 'function') {
const doc = isolationChambers[ii];
doc.querySelector('tw-storydata').children
.forEach((passageData) => {
const passageName = passageData.getAttribute('name');
passageData.getDescendants().forEach((descendant) => {
(<Function>task.executeMicrotask)(
descendant,
passageName,
linterOptions.format,
linterOptions.version
)
});
});
} else {
throw new Error('ITask has neither execute or executeMicrotask ' +
'methods.');
}
});
tasks.forEach((task, ii) => {
task.postExecute(isolationChambers[ii], options);
});
tasks.forEach((task, ii) => {
task.preComplete(isolationChambers[ii], options);
});
tasks.forEach((task, ii) => {
task.complete(isolationChambers[ii], options);
});
tasks.forEach((task, ii) => {
task.postComplete(isolationChambers[ii], options);
});
return tasks;
}
};
export default Linter; |