eslint-plugin-ft-flow
Version:
Flowtype linting rules for ESLint by flow-typed
20 lines (16 loc) • 615 B
Flow
import isFlowFileAnnotation from './isFlowFileAnnotation';
/**
* Checks whether a file has an @flow or @noflow annotation.
*
* @param context
* @param [strict] - By default, the function returns true if the file
* starts with @flow but not if it starts by @noflow. When the strict flag
* is set to false, the function returns true if the flag has @noflow also.
*/
export default (context, strict = true) => {
const comments = context.getSourceCode().getAllComments();
if (!comments.length) {
return false;
}
return comments.some((comment) => isFlowFileAnnotation(comment.value, strict));
};