Skip to content

Commit f0bab89

Browse files
committed
Assume methods are non-optional for now
This makes e.g. `app.commandLine.appendSwitch` non-optional and does not result in false positives.
1 parent a262fed commit f0bab89

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

lib/utils.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,10 @@ const isOptional = (param) => {
122122
return !param.required
123123
}
124124

125+
// Assume that methods are never optional because electron-docs-linter
126+
// doesn't currently mark them as required.
125127
debug(`Could not determine optionality for ${param.name}`)
126-
return true
128+
return param.type !== 'Function'
127129
}
128130

129131
const genMethodString = (paramInterfaces, module, moduleMethod, parameters, returns, includeType, paramTypePrefix) => {

test/utils_spec.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,5 +107,13 @@ describe('utils', () => {
107107
it('should return false if param is required', () => {
108108
expect(utils.isOptional({ required: true })).to.eq(false)
109109
})
110+
111+
it('should default to true if param is a non-function', () => {
112+
expect(utils.isOptional({ type: 'Foo' })).to.eq(true)
113+
})
114+
115+
it('should default to false if param is a function', () => {
116+
expect(utils.isOptional({ type: 'Function' })).to.eq(false)
117+
})
110118
})
111119
})

0 commit comments

Comments
 (0)