mirror of
https://github.com/conan-io/conan-center-index.git
synced 2025-08-09 07:48:56 +00:00
45 lines
1.6 KiB
Python
45 lines
1.6 KiB
Python
from pylint.checkers import BaseChecker
|
|
from pylint.interfaces import IAstroidChecker
|
|
from astroid import nodes
|
|
|
|
WHY_SRC_FOLDER = "Setting the `src_folder` for layouts will help keep an organized and clean workspace when developing recipes locally. " \
|
|
"The extra folder will help ensure there are no collisions between the upstream sources and recipe's exports - which " \
|
|
"also extends to what happens in the cache when creating packages"
|
|
|
|
|
|
class LayoutSrcFolder(BaseChecker):
|
|
"""
|
|
Ensure `src_folder=src` when using built-in layouts
|
|
"""
|
|
|
|
__implements__ = IAstroidChecker
|
|
|
|
name = "conan-layout-src-folder"
|
|
msgs = {
|
|
"E9012": (
|
|
"layout is missing `src_folder` argument which should be to `src`",
|
|
"conan-missing-layout-src-folder",
|
|
WHY_SRC_FOLDER,
|
|
),
|
|
"E9013": (
|
|
"layout should set `src_folder` to `src`",
|
|
"conan-layout-src-folder-is-src",
|
|
WHY_SRC_FOLDER,
|
|
),
|
|
}
|
|
|
|
def visit_call(self, node: nodes.Call) -> None:
|
|
if not isinstance(node.func, nodes.Name):
|
|
return
|
|
|
|
if node.func.name in ["cmake_layout", "bazel_layout", "basic_layout"]:
|
|
for kw in node.keywords:
|
|
if kw.arg == "src_folder":
|
|
if not kw.value or kw.value.as_string().strip("\"'") != "src":
|
|
self.add_message(
|
|
"conan-layout-src-folder-is-src", node=node, line=node.lineno
|
|
)
|
|
break
|
|
else:
|
|
self.add_message("conan-missing-layout-src-folder", node=node, line=node.lineno)
|