blob: 578bac96d3d061c881ceefb66e0a606848ddcfc8 [file] [log] [blame]
/**
* @fileoverview Rule to check for properties whose identifier ends with the string Sync
* @author Matt DuVall<http://mattduvall.com/>
*/
/* jshint node:true */
"use strict";
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = {
meta: {
type: "suggestion",
docs: {
description: "disallow synchronous methods",
category: "Node.js and CommonJS",
recommended: false,
url: "https://eslint.org/docs/rules/no-sync"
},
schema: [
{
type: "object",
properties: {
allowAtRootLevel: {
type: "boolean",
default: false
}
},
additionalProperties: false
}
]
},
create(context) {
const selector = context.options[0] && context.options[0].allowAtRootLevel
? ":function MemberExpression[property.name=/.*Sync$/]"
: "MemberExpression[property.name=/.*Sync$/]";
return {
[selector](node) {
context.report({
node,
message: "Unexpected sync method: '{{propertyName}}'.",
data: {
propertyName: node.property.name
}
});
}
};
}
};