Skip to content

Commit 1ec219d

Browse files
authored
Add lint rule for todo (#11141)
* Add lint rule for todo * Add some exclude rules for the todo bot * Fix slash in todo config string * Fix lint rule exit code * Fix repeated TODO in CHIPOClientCallbacks.cpp * zzz generated uses underscore not dash * Revert python changes due to zap regen
1 parent 313cb4b commit 1ec219d

File tree

10 files changed

+15
-23
lines changed

10 files changed

+15
-23
lines changed

.github/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ todo:
55
autoAssign: true # string|string[]|boolean
66
label: ["todo"] # boolean|string|string[]
77
reopenClosed: true # boolean
8+
exclude: ".*lint\\.yaml|.*/(zzz_generated|zap-generated)/.*" # string

.github/workflows/lint.yml

+5
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,8 @@ jobs:
4141
- name: Check for incorrect error use in VerifyOrExit
4242
run: |
4343
git grep -n "VerifyOrExit(.*, [A-Za-z]*_ERROR" -- './*' ':(exclude).github/workflows/lint.yml' && exit 1 || exit 0
44+
45+
# Comments like '{{! ... }}' should be used in zap files
46+
- name: Do not allow TODO in generated files
47+
run: |
48+
git grep -n 'TODO:' -- ./zzz_generated './*/zap-generated/*' && exit 1 || exit 0

src/app/zap-templates/templates/app/CHIPClientCallbacks-src.zapt

+2-2
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,9 @@ namespace {
118118
}
119119

120120

121-
// TODO: These IM related callbacks contains small or no generated code, should be put into seperate file to reduce the size of template.
122-
// Singleton instance of the callbacks manager
121+
{{! TODO: These IM related callbacks contains small or no generated code, should be put into seperate file to reduce the size of template. }}
123122

123+
// Singleton instance of the callbacks manager
124124
app::CHIPDeviceCallbacksMgr & gCallbacks = app::CHIPDeviceCallbacksMgr::GetInstance();
125125

126126
{{#chip_client_clusters}}

zzz_generated/controller-clusters/zap-generated/CHIPClientCallbacks.cpp

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

zzz_generated/lighting-app/zap-generated/CHIPClientCallbacks.cpp

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

zzz_generated/ota-requestor-app/zap-generated/CHIPClientCallbacks.cpp

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

zzz_generated/pump-app/zap-generated/CHIPClientCallbacks.cpp

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

zzz_generated/pump-controller-app/zap-generated/CHIPClientCallbacks.cpp

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

zzz_generated/thermostat/zap-generated/CHIPClientCallbacks.cpp

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

zzz_generated/tv-app/zap-generated/CHIPClientCallbacks.cpp

+1-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)