Skip to content

Commit 9ea45ec

Browse files
committed
test: Extend scope of eslint to __tests__
1 parent 1d85a02 commit 9ea45ec

Some content is hidden

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

45 files changed

+133
-153
lines changed

.eslintignore

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1-
test/fixture/*
2-
src/default_theme/assets/*
1+
__tests__/fixture/*
2+
src/default_theme/*
3+
coverage/*
4+
lib/*
5+
declarations/*

.eslintrc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"no-throw-literal": 2,
2121
"no-self-compare": 2,
2222
"no-void": 2,
23-
"no-unused-vars": 2,
23+
"no-unused-vars": 1,
2424
"wrap-iife": 2,
2525
"no-eq-null": 2,
2626
"strict": [2, "global"],
@@ -31,6 +31,7 @@
3131
},
3232
"extends": [
3333
"eslint:recommended",
34+
"plugin:flowtype/recommended",
3435
"prettier"
3536
],
3637
"env": {
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// Jest Snapshot v1, https://goo.gl/fbAQLP
2+
3+
exports[`readme command --readme-file 1`] = `
4+
"# A title
5+
6+
# API
7+
8+
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
9+
10+
## foo
11+
12+
A function with documentation.
13+
14+
**Parameters**
15+
16+
- \`a\` {string} blah
17+
18+
Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** answer
19+
20+
## bar
21+
22+
A second function with docs
23+
24+
**Parameters**
25+
26+
- \`b\`
27+
28+
# Another section
29+
"
30+
`;
31+
32+
exports[`readme command updates README.md 1`] = `
33+
"# A title
34+
35+
# API
36+
37+
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
38+
39+
## foo
40+
41+
A function with documentation.
42+
43+
**Parameters**
44+
45+
- \`a\` {string} blah
46+
47+
Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** answer
48+
49+
## bar
50+
51+
A second function with docs
52+
53+
**Parameters**
54+
55+
- \`b\`
56+
57+
# Another section
58+
"
59+
`;

__tests__/__snapshots__/test.js.snap

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Array [
4242
"loc": SourceLocation {
4343
"end": Position {
4444
"column": 1,
45-
"line": 13,
45+
"line": 12,
4646
},
4747
"start": Position {
4848
"column": 0,
@@ -178,11 +178,11 @@ Array [
178178
"loc": SourceLocation {
179179
"end": Position {
180180
"column": 2,
181-
"line": 12,
181+
"line": 10,
182182
},
183183
"start": Position {
184184
"column": 0,
185-
"line": 9,
185+
"line": 7,
186186
},
187187
},
188188
},
@@ -244,11 +244,11 @@ Array [
244244
"loc": SourceLocation {
245245
"end": Position {
246246
"column": 3,
247-
"line": 8,
247+
"line": 6,
248248
},
249249
"start": Position {
250250
"column": 0,
251-
"line": 5,
251+
"line": 3,
252252
},
253253
},
254254
"members": Object {

__tests__/bin-readme.js

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
'use strict';
21
var path = require('path'),
32
os = require('os'),
43
exec = require('child_process').exec,
@@ -55,20 +54,10 @@ describe('readme command', function() {
5554
});
5655
});
5756

58-
var expectedFile = path.join(fixtures, 'README.output.md');
59-
var expectedPath = path.join(fixtures, 'README.output.md');
60-
var expected = fs.readFileSync(expectedFile, 'utf-8');
61-
6257
test('updates README.md', function() {
6358
return documentation(['readme index.js -s API'], { cwd: d }).then(() => {
6459
var outputPath = path.join(d, 'README.md');
65-
66-
if (UPDATE) {
67-
fs.writeFileSync(expectedPath, fs.readFileSync(outputPath, 'utf-8'));
68-
}
69-
70-
var actual = fs.readFileSync(outputPath, 'utf-8');
71-
expect(actual).toEqual(expected);
60+
expect(fs.readFileSync(outputPath, 'utf-8')).toMatchSnapshot();
7261
});
7362
});
7463

@@ -80,12 +69,8 @@ describe('readme command', function() {
8069
return documentation(['readme index.js -s API --readme-file other.md'], {
8170
cwd: d
8271
}).then(() => {
83-
var actualPath = path.join(d, 'other.md');
84-
if (UPDATE) {
85-
fs.writeFileSync(actualPath, expected);
86-
}
87-
var actual = fs.readFileSync(actualPath, 'utf-8');
88-
expect(actual).toEqual(expected);
72+
var actual = fs.readFileSync(path.join(d, 'other.md'), 'utf8');
73+
expect(actual).toMatchSnapshot();
8974
});
9075
});
9176

@@ -119,7 +104,7 @@ describe('readme command', function() {
119104
return documentation(['readme index.js'], { cwd: d }).catch(err => {
120105
expect(err).toBeTruthy();
121106
expect(err.code !== 0).toBeTruthy();
122-
expect(stderr.match(/Missing required argument/)).toBeTruthy();
107+
expect(err.stderr.match(/Missing required argument/)).toBeTruthy();
123108
});
124109
});
125110

__tests__/bin-watch-serve.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var path = require('path');
42
var os = require('os');
53
var get = require('./utils').get;

__tests__/bin.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
'use strict';
1+
/* global jasmine */
22

33
var path = require('path'),
44
os = require('os'),

__tests__/fixture/external.input.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ require('./polyglot/blend.cpp');
88
* I am in `external.input.js`.
99
*/
1010
function foo() {
11-
'use strict';
1211
return 'bar';
1312
}
1413

__tests__/fixture/flow-unnamed-params.input.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
// @flow
22

3-
'use strict';
4-
53
/** x */
64
let x: T => string;
75

__tests__/fixture/html/nested.input.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
/**
42
* Creates a new Klass
53
* @extends Stream.Writable

__tests__/fixture/node_modules/external/lib/main.js

Lines changed: 0 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

__tests__/format_type.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
/*eslint max-len: 0 */
2-
'use strict';
32

43
var _formatType = require('../src/output/util/format_type'),
54
LinkerStack = require('../src/output/util/linker_stack'),

__tests__/lib/filter_access.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var filterAccess = require('../../src/filter_access');
42

53
test('filterAccess ignore', function() {

__tests__/lib/flow_doctrine.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var flowDoctrine = require('../../src/flow_doctrine.js'),
42
parse = require('../../src/parsers/javascript'),
53
FLOW_TYPES = require('babel-types').FLOW_TYPES;

__tests__/lib/git/find_git.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var mock = require('mock-fs');
42
var mockRepo = require('../../utils').mockRepo;
53
var path = require('path');

__tests__/lib/git/url_prefix.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var mock = require('mock-fs');
42
var mockRepo = require('../../utils').mockRepo;
53
var getGithubURLPrefix = require('../../../src/git/url_prefix');

__tests__/lib/github.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
/* eslint no-unused-vars: 0 */
42

53
var mock = require('mock-fs'),

__tests__/lib/hierarchy.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../src/parsers/javascript'),
42
hierarchy = require('../../src/hierarchy');
53

__tests__/lib/infer/access.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../../src/parsers/javascript'),
42
inferName = require('../../../src/infer/name'),
53
inferAccess = require('../../../src/infer/access');

__tests__/lib/infer/finders.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../../src/parsers/javascript'),
42
findTarget = require('../../../src/infer/finders').findTarget;
53

__tests__/lib/infer/kind.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
'use strict';
21
/*eslint-disable no-unused-vars*/
32
var inferKind = require('../../../src/infer/kind'),
43
parse = require('../../../src/parsers/javascript');

__tests__/lib/infer/membership.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../../src/parsers/javascript'),
42
inferMembership = require('../../../src/infer/membership')();
53

__tests__/lib/infer/name.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../../src/parsers/javascript'),
42
inferName = require('../../../src/infer/name');
53

__tests__/lib/infer/params.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../../src/parsers/javascript'),
42
inferParams = require('../../../src/infer/params');
53

__tests__/lib/infer/type.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../../src/parsers/javascript'),
42
inferKind = require('../../../src/infer/kind'),
53
inferType = require('../../../src/infer/type');

__tests__/lib/input/shallow.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var path = require('path'), shallow = require('../../../src/input/shallow');
42

53
test('shallow deps', function() {

__tests__/lib/lint.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../src/parsers/javascript'),
42
lintComments = require('../../src/lint').lintComments,
53
formatLint = require('../../src/lint').formatLint;

__tests__/lib/merge_config.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var path = require('path'),
42
_ = require('lodash'),
53
mergeConfig = require('../../src/merge_config');

__tests__/lib/nest.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var nestTag = require('../../src/nest').nestTag;
42

53
// Print a tree of tags in a way that's easy to test.

__tests__/lib/output/util/formatters.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
'use strict';
21
var formatters = require('../../../../src/output/util/formatters')(getHref);
32

43
test('formatters.parameters -- long form', function() {

__tests__/lib/parse.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var parse = require('../../src/parsers/javascript'),
42
remark = require('remark'),
53
visit = require('unist-util-visit');

__tests__/lib/parsers/javascript.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var remark = require('remark'),
42
parse = require('../../../src/parsers/javascript');
53

__tests__/lib/parsers/polyglot.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var fs = require('fs'),
42
path = require('path'),
53
remark = require('remark'),

__tests__/lib/server.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var get = require('../utils').get;
42
var File = require('vinyl');
53
var getPort = require('get-port');

__tests__/lib/sort.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var sort = require('../../src/sort'), path = require('path');
42

53
test('sort stream alphanumeric', function() {

__tests__/lib/walk.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var walk = require('../../src/walk');
42

53
test('walk', function() {

__tests__/linker.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
'use strict';
21
var LinkerStack = require('../src/output/util/linker_stack');
32

43
test('linkerStack', function() {

__tests__/test.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
'use strict';
2-
31
var documentationSchema = require('documentation-schema'),
42
validate = require('json-schema'),
53
documentation = require('../'),

__tests__/utils.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
'use strict';
21
var http = require('http');
32
import { walk } from '../src/walk';
43
var concat = require('concat-stream');

bin/documentation.js

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

33
/* eslint no-console: 0 */
44

5-
'use strict';
6-
75
var yargs = require('yargs');
86
var commands = require('../lib/commands');
97

0 commit comments

Comments
 (0)