Skip to content

Commit a111e3b

Browse files
brettz9brettz9
committed
- Testing: Rename browserEnv option to window 
1 parent 448800f commit a111e3b

File tree

4 files changed

+41
-41
lines changed

4 files changed

+41
-41
lines changed

‎.README/rules/require-jsdoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ be checked by the rule.
2222
- `ancestorsOnly` - Only check node ancestors to check if node is exported
2323
- `esm` - ESM exports are checked for JSDoc comments (Defaults to `true`)
2424
- `cjs` - CommonJS exports are checked for JSDoc comments (Defaults to `true`)
25-
- `browserEnv` - Window global exports are checked for JSDoc comments
25+
- `window` - Window global exports are checked for JSDoc comments
2626

2727
- `require` - An object with the following optional boolean keys which all
2828
default to `false` except as noted:

‎README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3436,7 +3436,7 @@ be checked by the rule.
34363436
- `ancestorsOnly` - Only check node ancestors to check if node is exported
34373437
- `esm` - ESM exports are checked for JSDoc comments (Defaults to `true`)
34383438
- `cjs` - CommonJS exports are checked for JSDoc comments (Defaults to `true`)
3439-
- `browserEnv` - Window global exports are checked for JSDoc comments
3439+
- `window` - Window global exports are checked for JSDoc comments
34403440

34413441
- `require` - An object with the following optional boolean keys which all
34423442
default to `false` except as noted:
@@ -3699,37 +3699,37 @@ export default class A {
36993699
var test = function () {
37003700

37013701
}
3702-
// Options: [{"publicOnly":{"browserEnv":true},"require":{"FunctionExpression":true}}]
3702+
// Options: [{"publicOnly":{"window":true},"require":{"FunctionExpression":true}}]
37033703
// Message: Missing JSDoc comment.
37043704

37053705
window.test = function () {
37063706

37073707
}
3708-
// Options: [{"publicOnly":{"browserEnv":true},"require":{"FunctionExpression":true}}]
3708+
// Options: [{"publicOnly":{"window":true},"require":{"FunctionExpression":true}}]
37093709
// Message: Missing JSDoc comment.
37103710

37113711
function test () {
37123712

37133713
}
3714-
// Options: [{"publicOnly":{"browserEnv":true}}]
3714+
// Options: [{"publicOnly":{"window":true}}]
37153715
// Message: Missing JSDoc comment.
37163716

37173717
module.exports = function() {
37183718

37193719
}
3720-
// Options: [{"publicOnly":{"browserEnv":false,"cjs":true,"esm":false},"require":{"FunctionExpression":true}}]
3720+
// Options: [{"publicOnly":{"cjs":true,"esm":false,"window":false},"require":{"FunctionExpression":true}}]
37213721
// Message: Missing JSDoc comment.
37223722

37233723
export function someMethod() {
37243724

37253725
}
3726-
// Options: [{"publicOnly":{"browserEnv":false,"cjs":false,"esm":true},"require":{"FunctionDeclaration":true}}]
3726+
// Options: [{"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionDeclaration":true}}]
37273727
// Message: Missing JSDoc comment.
37283728

37293729
export function someMethod() {
37303730

37313731
}
3732-
// Options: [{"publicOnly":{"browserEnv":false,"cjs":false,"esm":true},"require":{"FunctionDeclaration":true}}]
3732+
// Options: [{"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionDeclaration":true}}]
37333733
// Message: Missing JSDoc comment.
37343734
````
37353735

@@ -3971,7 +3971,7 @@ test = function() {
39713971
module.exports = {
39723972
prop: { prop2: test }
39733973
}
3974-
// Options: [{"publicOnly":{"browserEnv":false,"cjs":true,"esm":false},"require":{"FunctionExpression":true}}]
3974+
// Options: [{"publicOnly":{"cjs":true,"esm":false,"window":false},"require":{"FunctionExpression":true}}]
39753975

39763976
/**
39773977
*
@@ -3983,7 +3983,7 @@ test = function() {
39833983
exports.someMethod = {
39843984
prop: { prop2: test }
39853985
}
3986-
// Options: [{"publicOnly":{"browserEnv":false,"cjs":false,"esm":true},"require":{"FunctionExpression":true}}]
3986+
// Options: [{"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionExpression":true}}]
39873987

39883988
/**
39893989
*
@@ -4154,27 +4154,27 @@ export default class A {
41544154
var test = function () {
41554155

41564156
}
4157-
// Options: [{"publicOnly":{"browserEnv":true},"require":{"FunctionExpression":true}}]
4157+
// Options: [{"publicOnly":{"window":true},"require":{"FunctionExpression":true}}]
41584158

41594159
let test = function () {
41604160

41614161
}
4162-
// Options: [{"publicOnly":{"browserEnv":true},"require":{"FunctionExpression":true}}]
4162+
// Options: [{"publicOnly":{"window":true},"require":{"FunctionExpression":true}}]
41634163

41644164
export function someMethod() {
41654165

41664166
}
4167-
// Options: [{"publicOnly":{"browserEnv":false,"cjs":true,"esm":false},"require":{"FunctionDeclaration":true}}]
4167+
// Options: [{"publicOnly":{"cjs":true,"esm":false,"window":false},"require":{"FunctionDeclaration":true}}]
41684168

41694169
export function someMethod() {
41704170

41714171
}
4172-
// Options: [{"publicOnly":{"browserEnv":false,"cjs":true,"esm":false},"require":{"FunctionDeclaration":true}}]
4172+
// Options: [{"publicOnly":{"cjs":true,"esm":false,"window":false},"require":{"FunctionDeclaration":true}}]
41734173

41744174
exports.someMethod = function() {
41754175

41764176
}
4177-
// Options: [{"publicOnly":{"browserEnv":false,"cjs":false,"esm":true},"require":{"FunctionExpression":true}}]
4177+
// Options: [{"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionExpression":true}}]
41784178
````
41794179

41804180

‎src/rules/requireJsdoc.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,17 @@ const OPTIONS_SCHEMA = {
2020
default: false,
2121
type: 'boolean'
2222
},
23-
browserEnv: {
24-
default: false,
25-
type: 'boolean'
26-
},
2723
cjs: {
2824
default: true,
2925
type: 'boolean'
3026
},
3127
esm: {
3228
default: true,
3329
type: 'boolean'
30+
},
31+
window: {
32+
default: false,
33+
type: 'boolean'
3434
}
3535
},
3636
type: 'object'
@@ -144,7 +144,7 @@ export default iterateJsdoc(null, {
144144
ancestorsOnly: publicOnly.ancestorsOnly,
145145
esm: publicOnly.esm,
146146
initModuleExports: publicOnly.cjs,
147-
initWindow: publicOnly.browserEnv
147+
initWindow: publicOnly.window
148148
};
149149
const parseResult = exportParser.parse(sourceCode.ast, node, opt);
150150
const exported = exportParser.isExported(node, parseResult, opt);

‎test/rules/assertions/requireJsdoc.js

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -678,7 +678,7 @@ export default {
678678
}],
679679
options: [{
680680
publicOnly: {
681-
browserEnv: true
681+
window: true
682682
},
683683
require: {
684684
FunctionExpression: true
@@ -700,7 +700,7 @@ export default {
700700
}],
701701
options: [{
702702
publicOnly: {
703-
browserEnv: true
703+
window: true
704704
},
705705
require: {
706706
FunctionExpression: true
@@ -722,7 +722,7 @@ export default {
722722
}],
723723
options: [{
724724
publicOnly: {
725-
browserEnv: true
725+
window: true
726726
}
727727
}],
728728
parserOptions: {
@@ -744,9 +744,9 @@ export default {
744744
}],
745745
options: [{
746746
publicOnly: {
747-
browserEnv: false,
748747
cjs: true,
749-
esm: false
748+
esm: false,
749+
window: false
750750
},
751751
require: {
752752
FunctionExpression: true
@@ -768,9 +768,9 @@ export default {
768768
}],
769769
options: [{
770770
publicOnly: {
771-
browserEnv: false,
772771
cjs: false,
773-
esm: true
772+
esm: true,
773+
window: false
774774
},
775775
require: {
776776
FunctionDeclaration: true
@@ -796,9 +796,9 @@ export default {
796796
}],
797797
options: [{
798798
publicOnly: {
799-
browserEnv: false,
800799
cjs: false,
801-
esm: true
800+
esm: true,
801+
window: false
802802
},
803803
require: {
804804
FunctionDeclaration: true
@@ -1213,9 +1213,9 @@ export default {
12131213
},
12141214
options: [{
12151215
publicOnly: {
1216-
browserEnv: false,
12171216
cjs: true,
1218-
esm: false
1217+
esm: false,
1218+
window: false
12191219
},
12201220
require: {
12211221
FunctionExpression: true
@@ -1240,9 +1240,9 @@ export default {
12401240
},
12411241
options: [{
12421242
publicOnly: {
1243-
browserEnv: false,
12441243
cjs: false,
1245-
esm: true
1244+
esm: true,
1245+
window: false
12461246
},
12471247
require: {
12481248
FunctionExpression: true
@@ -1609,7 +1609,7 @@ export default {
16091609
`,
16101610
options: [{
16111611
publicOnly: {
1612-
browserEnv: true
1612+
window: true
16131613
},
16141614
require: {
16151615
FunctionExpression: true
@@ -1627,7 +1627,7 @@ export default {
16271627
`,
16281628
options: [{
16291629
publicOnly: {
1630-
browserEnv: true
1630+
window: true
16311631
},
16321632
require: {
16331633
FunctionExpression: true
@@ -1648,9 +1648,9 @@ export default {
16481648
},
16491649
options: [{
16501650
publicOnly: {
1651-
browserEnv: false,
16521651
cjs: true,
1653-
esm: false
1652+
esm: false,
1653+
window: false
16541654
},
16551655
require: {
16561656
FunctionDeclaration: true
@@ -1671,9 +1671,9 @@ export default {
16711671
},
16721672
options: [{
16731673
publicOnly: {
1674-
browserEnv: false,
16751674
cjs: true,
1676-
esm: false
1675+
esm: false,
1676+
window: false
16771677
},
16781678
require: {
16791679
FunctionDeclaration: true
@@ -1694,9 +1694,9 @@ export default {
16941694
},
16951695
options: [{
16961696
publicOnly: {
1697-
browserEnv: false,
16981697
cjs: false,
1699-
esm: true
1698+
esm: true,
1699+
window: false
17001700
},
17011701
require: {
17021702
FunctionExpression: true

0 commit comments

Comments
 (0)