check for cfinclude inside cfcs

src/main/java/com/cflint/plugins/core/CFXTagChecker.java

@@ -12,8 +12,12 @@ public class CFXTagChecker extends CFLintScannerAdapter {
 	public void element(final Element element, final Context context, final BugList bugs) {
 		final String tagName = element.getName();
 		final String cfmlTagCheck = getParameter("tagName");
+		final String scope = getParameter("scope");
+
 		if (tagName.matches(cfmlTagCheck)) {
-			context.addMessage("AVOID_USING_" + tagName.toUpperCase() + "_TAG", tagName);
+			if (scope == null || scope.equals("component") && context.isInComponent()) {
+				context.addMessage("AVOID_USING_" + tagName.toUpperCase() + "_TAG", tagName);
+			}
 		}
 	}
 }

src/main/resources/cflint.definition.json

@@ -242,6 +242,27 @@
         }
       ]
     },
+    {
+      "name": "CFIncludeChecker",
+      "className": "CFXTagChecker",
+      "message": [
+        {
+          "code": "AVOID_USING_CFINCUDE_TAG",
+          "messageText": "Avoid using <${tagName}> tags. Use components instead.",
+          "severity": "WARNING"
+        }
+      ],
+      "parameter": [
+        {
+          "name": "tagName",
+          "value": "cfinclude"
+        },
+        {
+          "name": "scope",
+          "value": "component"
+        }
+      ]
+    },
     {
       "name": "ComponentHintChecker",
       "className": "ComponentHintChecker",

src/main/resources/cflint.definition.xml

@@ -113,6 +113,14 @@
 		</message>
 		<parameter name="tagName" value="cfupdate"/>
 	</ruleImpl>
+	<ruleImpl name="CFIncludeChecker" className="CFXTagChecker">
+		<message code="AVOID_USING_CFINCLUDE_TAG">
+			<messageText>Avoid using &lt;${tagName}&gt; tags. Use components instead.</messageText>
+			<severity>WARNING</severity>
+		</message>
+		<parameter name="tagName" value="cfinclude"/>
+		<parameter name="scope" value="component"/>
+	</ruleImpl>
 	<ruleImpl name="ComponentHintChecker" className="ComponentHintChecker">
         <message code="COMPONENT_HINT_MISSING">
         	<severity>WARNING</severity>

src/test/java/com/cflint/TestCFIncludeChecker.java

@@ -0,0 +1,67 @@
+package com.cflint;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Map;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import cfml.parsing.reporting.ParseException;
+
+import com.cflint.config.CFLintPluginInfo.PluginInfoRule;
+import com.cflint.config.CFLintPluginInfo.PluginInfoRule.PluginMessage;
+import com.cflint.config.ConfigRuntime;
+import com.cflint.plugins.core.CFXTagChecker;
+
+public class TestCFIncludeChecker {
+
+	private CFLint cfBugs;
+
+	@Before
+	public void setUp() {
+		final ConfigRuntime conf = new ConfigRuntime();
+		final PluginInfoRule pluginRule = new PluginInfoRule();
+		pluginRule.setName("CFXTagChecker");
+		pluginRule.addParameter("tagName", "cfinclude");
+		pluginRule.addParameter("scope", "component");
+		conf.getRules().add(pluginRule);
+		final PluginMessage pluginMessage = new PluginMessage("AVOID_USING_CFINCLUDE_TAG");
+		pluginMessage.setSeverity("WARNING");
+		pluginRule.getMessages().add(pluginMessage);
+		final CFXTagChecker checker = new CFXTagChecker();
+		checker.setParameter("tagName", "cfinclude");
+		checker.setParameter("scope", "component");
+		cfBugs = new CFLint(conf, checker);
+	}
+
+	@Test
+	public void testCfIncludeIncomponent() throws ParseException, IOException {
+
+		final String scriptSrc = "<cfcomponent>\r\n"
+			+ "<cffunction>\r\n"
+			+ "<cfinclude template=\"functions.cfm\">\r\n"
+			+ "</cffunction>\r\n"
+			+ "</cfcomponent>\r\n";
+
+		cfBugs.process(scriptSrc, "test");
+		final List<BugInfo> result = cfBugs.getBugs().getBugList().values().iterator().next();
+		assertEquals(1, result.size());
+		assertEquals("AVOID_USING_CFINCLUDE_TAG", result.get(0).getMessageCode());
+	}
+
+	@Test
+	public void testLonelyCfInclude() throws ParseException, IOException {
+
+		final String scriptSrc = "<cffunction>\r\n"
+			+ "<cfinclude template=\"functions.cfm\">\r\n"
+			+ "</cffunction>\r\n";
+
+		cfBugs.process(scriptSrc, "test");
+		final Map<String, List<BugInfo>> result = cfBugs.getBugs().getBugList();
+		assertEquals(0, result.size());
+	}
+
+}