Ask Your Question
3

Lint target?

asked 2013-08-28 05:30:26 -0500

I've created a sensor driver package, and I've added a linter target to it, but it's pretty manual:

FILE(GLOB LINT_SRCS src/*.cpp include/${PROJECT_NAME}/*.h)
add_custom_target(${PROJECT_NAME}_cpplint
  COMMAND cpplint --filter=-whitespace/line_length ${LINT_SRCS})

Moreover, the resulting target is "um6_cpplint", whereas the ideal thing would be to have a generic run_lint target which works across every package in a workspace, much like run_tests and all do.

I'm picturing that there could be a roslint package which one would you could add to a package's find_package call. Having done so, it would expose a new macro like add_lint_target(); this could call through to cpplint or pylint (or whatever), with the appropriate configuration for ROS style standards.

Down the road, such a package might also include a package linter, which could warn about incomplete package.xml or gotchas present in CMakeLists, complain about things being in the wrong places, lack of install() macros, etc.

Anyhow, does this seem like something which would be useful? Do any pieces of it exist already?

edit retag flag offensive close merge delete

Comments

Why not make the linting part of your automated tests?

William gravatar image William  ( 2013-08-28 07:27:15 -0500 )edit

It is part of the travis tests already; part of why it would be nice to have a cross-package target would be so that the test script could just be to "catkin_make all run_tests run_lint", rather than needing to include a package-specific target.

mikepurvis gravatar image mikepurvis  ( 2013-08-28 07:49:50 -0500 )edit

No I mean why not define the lint process in one of your tests, such that `make run_tests` invokes cppcheck (or w/e) and checks the result.

William gravatar image William  ( 2013-08-28 07:53:49 -0500 )edit
William gravatar image William  ( 2013-08-28 07:54:21 -0500 )edit

Gotcha. That's helpful to see an example of another package doing something similar.

mikepurvis gravatar image mikepurvis  ( 2013-08-28 10:05:55 -0500 )edit

1 Answer

Sort by ยป oldest newest most voted
0

answered 2013-08-28 05:38:43 -0500

joq gravatar image

Seems reasonable to me.

I'd suggest starting a discussion on the ros-sig-buildsystem mailing list to work out the details.

edit flag offensive delete link more

Comments

For future viewers: https://github.com/ros/roslint

mikepurvis gravatar image mikepurvis  ( 2013-09-20 07:43:12 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

Stats

Asked: 2013-08-28 05:30:26 -0500

Seen: 466 times

Last updated: Aug 28 '13