ament_cmake_flake8 ignores value of AMENT_LINT_AUTO_FILE_EXCLUDE

[RFRIEDM-Trimble]

When I use ament_lint_auto and want to exclude certain files, only a subset of the linters obey that variable AMENT_LINT_AUTO_FILE_EXCLUDE.

This issue is specific to ament_cmake_flake8. If you take a look at #386, you can see exclude logic was never added to it.

[aprotyas]

@RFRIEDM-Trimble when I was writing #386 I only updated the CMake hooks that actually had file exclusion provisions in place. It looks like ament_cmake_flake8 just doesn't support file exclusion yet - i.e. there's no EXCLUDE argument to the CMake function ament_flake8.

Do you mind adding that support? Check out some of the other packages for how it's done, it should be relatively trivial and I can review the PR you submit for it.

General exclusion can be achieved like so:

ament_lint/ament_cmake_cpplint/cmake/ament_cpplint.cmake

Lines 49 to 51 in d17e975

	if(ARG_EXCLUDE)
	list(APPEND cmd "--exclude" "${ARG_EXCLUDE}")
	endif()

Exclusion through the AMENT_LINT_AUTO_FILE_EXCLUDE interface can be achieved like so:

ament_lint/ament_cmake_cpplint/cmake/ament_cmake_cpplint_lint_hook.cmake

Lines 29 to 39 in d17e975

	set(_all_exclude "")
	if(DEFINED ament_cmake_cpplint_ADDITIONAL_EXCLUDE)
	list(APPEND _all_exclude ${ament_cmake_cpplint_ADDITIONAL_EXCLUDE})
	endif()
	if(DEFINED AMENT_LINT_AUTO_FILE_EXCLUDE)
	list(APPEND _all_exclude ${AMENT_LINT_AUTO_FILE_EXCLUDE})
	endif()
	message(STATUS "Configured cpplint exclude dirs and/or files: ${_all_exclude}")
	ament_cpplint(EXCLUDE ${_all_exclude})

[RFRIEDM-Trimble]

@RFRIEDM-Trimble when I was writing #386 I only updated the CMake hooks that actually had file exclusion provisions in place. It looks like ament_cmake_flake8 just doesn't support file exclusion yet - i.e. there's no EXCLUDE argument to the CMake function ament_flake8.

Do you mind adding that support? Check out some of the other packages for how it's done, it should be relatively trivial and I can review the PR you submit for it.

General exclusion can be achieved like so:

ament_lint/ament_cmake_cpplint/cmake/ament_cpplint.cmake

Lines 49 to 51 in d17e975

	if(ARG_EXCLUDE)
	list(APPEND cmd "--exclude" "${ARG_EXCLUDE}")
	endif()

Exclusion through the AMENT_LINT_AUTO_FILE_EXCLUDE interface can be achieved like so:

ament_lint/ament_cmake_cpplint/cmake/ament_cmake_cpplint_lint_hook.cmake

Lines 29 to 39 in d17e975

	set(_all_exclude "")
	if(DEFINED ament_cmake_cpplint_ADDITIONAL_EXCLUDE)
	list(APPEND _all_exclude ${ament_cmake_cpplint_ADDITIONAL_EXCLUDE})
	endif()
	if(DEFINED AMENT_LINT_AUTO_FILE_EXCLUDE)
	list(APPEND _all_exclude ${AMENT_LINT_AUTO_FILE_EXCLUDE})
	endif()
	message(STATUS "Configured cpplint exclude dirs and/or files: ${_all_exclude}")
	ament_cpplint(EXCLUDE ${_all_exclude})

Awesome, good to know I wasn't missing anything major; seems pretty minor. Yep, I'm happy to contribute a change. Do you think it's a good idea to clarify for the ament_lint_auto package as part of contributing, all linters should support the argument, for any future additions?

Feel free to assign this issue to me, I'll get a fix in.

[Ryanf55]

This can be closer since the PR is merged. Well, since it's a bugfix, can we backport it to humble? On humble, the docs disagree with the linter behavior which is why one would assume it would work.

[Benjamin-Tan]

Any chance for this PR (#424) to be backport to humble?

[Ryanf55]

Any chance for this PR (#424) to be backport to humble?

Please consider backporting. It was my intention doing the original work that it would be backported. I've been moving to black so I need to start being able to turn off flake8 on files, and do it humble.