/
propDocblockHandler-test.js
191 lines (170 loc) · 4.42 KB
/
propDocblockHandler-test.js
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
/*
* Copyright (c) 2015, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
*/
/*global jest, describe, beforeEach, it, expect*/
var os = require('os');
var EOL = os.EOL;
jest.disableAutomock();
jest.mock('../../Documentation');
describe('propDocBlockHandler', () => {
var expression, statement;
var documentation;
var propDocBlockHandler;
beforeEach(() => {
({expression, statement} = require('../../../tests/utils'));
documentation = new (require('../../Documentation'));
propDocBlockHandler = require('../propDocBlockHandler').default;
});
function test(getSrc, parse) {
it('finds docblocks for prop types', () => {
var definition = parse(getSrc(`
{
/**
* Foo comment
*/
foo: Prop.bool,
/**
* Bar comment
*/
bar: Prop.bool,
}
`));
propDocBlockHandler(documentation, definition);
expect(documentation.descriptors).toEqual({
foo: {
description: 'Foo comment',
},
bar: {
description: 'Bar comment',
},
});
});
it('can handle multline comments', () => {
var definition = parse(getSrc(`
{
/**
* Foo comment with
* many lines!
*
* even with empty lines in between
*/
foo: Prop.bool,
}
`));
propDocBlockHandler(documentation, definition);
expect(documentation.descriptors).toEqual({
foo: {
description:
'Foo comment with'+EOL+'many lines!'+EOL+'\neven with empty lines in between',
},
});
});
it('ignores non-docblock comments', () => {
var definition = parse(getSrc(`
{
/**
* Foo comment
*/
// TODO: remove this comment
foo: Prop.bool,
/**
* Bar comment
*/
/* This is not a doc comment */
bar: Prop.bool,
}
`));
propDocBlockHandler(documentation, definition);
expect(documentation.descriptors).toEqual({
foo: {
description: 'Foo comment',
},
bar: {
description: 'Bar comment',
},
});
});
it('only considers the comment with the property below it', () => {
var definition = parse(getSrc(`
{
/**
* Foo comment
*/
foo: Prop.bool,
bar: Prop.bool,
}
`));
propDocBlockHandler(documentation, definition);
expect(documentation.descriptors).toEqual({
foo: {
description: 'Foo comment',
},
bar: {
description: '',
},
});
});
it('understands and ignores the spread operator', () => {
var definition = parse(getSrc(`
{
...Foo.propTypes,
/**
* Foo comment
*/
foo: Prop.bool,
}
`));
propDocBlockHandler(documentation, definition);
expect(documentation.descriptors).toEqual({
foo: {
description: 'Foo comment',
},
});
});
it('resolves variables', () => {
var definition = parse(`
${getSrc('Props')}
var Props = {
/**
* Foo comment
*/
foo: Prop.bool,
};
`);
propDocBlockHandler(documentation, definition);
expect(documentation.descriptors).toEqual({
foo: {
description: 'Foo comment',
},
});
});
}
describe('React.createClass', () => {
test(
propTypesSrc => `({propTypes: ${propTypesSrc}})`,
src => statement(src).get('expression')
);
});
describe('ClassDefinition', () => {
test(
propTypesSrc => `
class Foo{
static propTypes = ${propTypesSrc};
}
`,
src => statement(src)
);
});
it('does not error if propTypes cannot be found', () => {
var definition = expression('{fooBar: 42}');
expect(() => propDocBlockHandler(documentation, definition)).not.toThrow();
definition = statement('class Foo {}');
expect(() => propDocBlockHandler(documentation, definition)).not.toThrow();
});
});