Stop allowing "unclear types" with Flow

[thibaudcolas]

Bug/documentation issue. Unclear types (Array, Object, Function) shouldn't be allowed in the code.

What is the current behavior?

At the moment, .flowconfig turns off the unclear-type linting rule, which allows code to be written with types like Array<Object>. This is problematic because those types end up in the documentation, and aren't really helpful when the API signature of functions actually expects specific shapes for those objects.

If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. GIFs and screenshots are very helpful too.

For example – shouldKeepEntityByAttribute declares it expects an Array of Objects:

draftjs-filters/src/lib/filters/entities.js

Lines 145 to 149 in 428f7f7

	export const shouldKeepEntityByAttribute = (
	entityTypes: Array<Object>,
	entityType: string,
	data: Object,
	) => {

the whitelist attribute’s values are actually string | boolean. This is not clear in the type definition of shouldKeepEntityByAttribute, and as a result the type definition of filterEditorState is out of date:

draftjs-filters/src/lib/filters/editor.js

Lines 39 to 41 in 428f7f7

	// Refine which entities are kept by whitelisting acceptable values with regular expression patterns.
	whitelist: {
	[attribute: string]: string,

What is the expected behavior?

All functions should be typed with exact types.

Which versions of the filters or of Draft.js, and which browser / OS are affected by this issue? Did this work in previous versions of the filters / Draft.js?

This has always been the case. It’s more problematic now because the types are used to generate documentation (#26), which is not as useful as it could be / wrong / imprecise.

[thibaudcolas]

🎉 This issue is fixed in v2.2.2, available on npm: draftjs-filters@2.2.2.

Generated by 📦🚀 semantic-release