Skip to content

Commit a0cd03c

Browse files
lucasssvazlucasssvaz
authored
feat: Add pre-commit CI and sync formatting settings (esphome#22)
* feat: Add pre-commit CI and sync formatting settings * fix: Ignore LICENSE file * fix: Apply new formatting * fix: Fix spelling and add spell checker
1 parent c6caa1c commit a0cd03c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+4007
-2754
lines changed

‎.clang-format‎

Lines changed: 239 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,246 @@
1-
Language: Cpp
1+
# Clang format version: 18.1.3
2+
---
23
BasedOnStyle: LLVM
3-
44
AccessModifierOffset: -2
5-
AlignConsecutiveMacros: true
6-
AllowAllArgumentsOnNextLine: false
7-
AllowAllParametersOfDeclarationOnNextLine: false
8-
AllowShortIfStatementsOnASingleLine: false
9-
AllowShortLambdasOnASingleLine: Inline
10-
BinPackArguments: false
11-
ColumnLimit: 0
5+
AlignAfterOpenBracket: BlockIndent
6+
AlignArrayOfStructures: None
7+
AlignConsecutiveAssignments:
8+
Enabled: false
9+
AcrossEmptyLines: false
10+
AcrossComments: false
11+
AlignCompound: false
12+
AlignFunctionPointers: false
13+
PadOperators: true
14+
AlignConsecutiveBitFields:
15+
Enabled: true
16+
AcrossEmptyLines: false
17+
AcrossComments: false
18+
AlignCompound: false
19+
AlignFunctionPointers: false
20+
PadOperators: false
21+
AlignConsecutiveDeclarations:
22+
Enabled: false
23+
AcrossEmptyLines: false
24+
AcrossComments: false
25+
AlignCompound: false
26+
AlignFunctionPointers: false
27+
PadOperators: false
28+
AlignConsecutiveMacros:
29+
Enabled: true
30+
AcrossEmptyLines: false
31+
AcrossComments: false
32+
AlignCompound: false
33+
AlignFunctionPointers: false
34+
PadOperators: false
35+
AlignConsecutiveShortCaseStatements:
36+
Enabled: true
37+
AcrossEmptyLines: false
38+
AcrossComments: false
39+
AlignCaseColons: false
40+
AlignEscapedNewlines: Left
41+
AlignOperands: Align
42+
AlignTrailingComments:
43+
Kind: Always
44+
OverEmptyLines: 0
45+
AllowAllArgumentsOnNextLine: true
46+
AllowAllParametersOfDeclarationOnNextLine: true
47+
AllowBreakBeforeNoexceptSpecifier: Never
48+
AllowShortBlocksOnASingleLine: Empty
49+
AllowShortCaseLabelsOnASingleLine: true
50+
AllowShortCompoundRequirementOnASingleLine: true
51+
AllowShortEnumsOnASingleLine: false
52+
AllowShortFunctionsOnASingleLine: Empty
53+
AllowShortIfStatementsOnASingleLine: Never
54+
AllowShortLambdasOnASingleLine: Empty
55+
AllowShortLoopsOnASingleLine: true
56+
AlwaysBreakAfterDefinitionReturnType: None
57+
AlwaysBreakAfterReturnType: None
58+
AlwaysBreakBeforeMultilineStrings: false
59+
AlwaysBreakTemplateDeclarations: MultiLine
60+
AttributeMacros:
61+
- __capability
62+
BinPackArguments: true
63+
BinPackParameters: true
64+
BitFieldColonSpacing: Both
65+
BraceWrapping:
66+
AfterCaseLabel: true
67+
AfterClass: false
68+
AfterControlStatement: Never
69+
AfterEnum: false
70+
AfterFunction: false
71+
AfterNamespace: false
72+
AfterObjCDeclaration: false
73+
AfterStruct: false
74+
AfterUnion: false
75+
AfterExternBlock: false
76+
BeforeCatch: false
77+
BeforeElse: false
78+
BeforeLambdaBody: false
79+
BeforeWhile: false
80+
IndentBraces: false
81+
SplitEmptyFunction: false
82+
SplitEmptyRecord: true
83+
SplitEmptyNamespace: true
84+
BreakAdjacentStringLiterals: true
85+
BreakAfterAttributes: Always
86+
BreakAfterJavaFieldAnnotations: false
87+
BreakArrays: false
88+
BreakBeforeBinaryOperators: NonAssignment
89+
BreakBeforeBraces: Custom
90+
BreakBeforeConceptDeclarations: Always
91+
BreakBeforeInlineASMColon: OnlyMultiline
92+
BreakBeforeTernaryOperators: true
93+
BreakConstructorInitializers: BeforeColon
94+
BreakInheritanceList: BeforeColon
95+
BreakStringLiterals: true
96+
ColumnLimit: 160
97+
CommentPragmas: ""
98+
CompactNamespaces: false
99+
ConstructorInitializerIndentWidth: 2
12100
ContinuationIndentWidth: 2
13-
FixNamespaceComments: false
14-
IndentAccessModifiers: true
101+
Cpp11BracedListStyle: true
102+
DerivePointerAlignment: false
103+
DisableFormat: false
104+
EmptyLineAfterAccessModifier: Never
105+
EmptyLineBeforeAccessModifier: LogicalBlock
106+
ExperimentalAutoDetectBinPacking: false
107+
FixNamespaceComments: true
108+
ForEachMacros:
109+
- foreach
110+
- Q_FOREACH
111+
- BOOST_FOREACH
112+
IfMacros:
113+
- KJ_IF_MAYBE
114+
IncludeBlocks: Preserve
115+
IncludeCategories:
116+
- Regex: ^"(llvm|llvm-c|clang|clang-c)/
117+
Priority: 2
118+
SortPriority: 0
119+
CaseSensitive: false
120+
- Regex: ^(<|"(gtest|gmock|isl|json)/)
121+
Priority: 3
122+
SortPriority: 0
123+
CaseSensitive: false
124+
- Regex: .*
125+
Priority: 1
126+
SortPriority: 0
127+
CaseSensitive: false
128+
IncludeIsMainRegex: ""
129+
IncludeIsMainSourceRegex: ""
130+
IndentAccessModifiers: false
131+
IndentCaseBlocks: false
15132
IndentCaseLabels: true
16-
IndentPPDirectives: BeforeHash
133+
IndentExternBlock: NoIndent
134+
IndentGotoLabels: false
135+
IndentPPDirectives: None
136+
IndentRequiresClause: false
17137
IndentWidth: 2
18-
NamespaceIndentation: All
19-
PointerAlignment: Left
20-
ReferenceAlignment: Left
138+
IndentWrappedFunctionNames: true
139+
InsertBraces: true
140+
InsertNewlineAtEOF: true
141+
InsertTrailingCommas: None
142+
IntegerLiteralSeparator:
143+
Binary: 0
144+
BinaryMinDigits: 0
145+
Decimal: 0
146+
DecimalMinDigits: 0
147+
Hex: 0
148+
HexMinDigits: 0
149+
JavaScriptQuotes: Leave
150+
JavaScriptWrapImports: true
151+
KeepEmptyLinesAtEOF: false
152+
KeepEmptyLinesAtTheStartOfBlocks: true
153+
LambdaBodyIndentation: Signature
154+
Language: Cpp
155+
LineEnding: LF
156+
MacroBlockBegin: ""
157+
MacroBlockEnd: ""
158+
MaxEmptyLinesToKeep: 1
159+
NamespaceIndentation: None
160+
ObjCBinPackProtocolList: Auto
161+
ObjCBlockIndentWidth: 2
162+
ObjCBreakBeforeNestedBlockParam: true
163+
ObjCSpaceAfterProperty: false
164+
ObjCSpaceBeforeProtocolList: true
165+
PPIndentWidth: -1
166+
PackConstructorInitializers: BinPack
167+
PenaltyBreakAssignment: 2
168+
PenaltyBreakBeforeFirstCallParameter: 19
169+
PenaltyBreakComment: 300
170+
PenaltyBreakFirstLessLess: 120
171+
PenaltyBreakOpenParenthesis: 0
172+
PenaltyBreakScopeResolution: 500
173+
PenaltyBreakString: 1000
174+
PenaltyBreakTemplateDeclaration: 10
175+
PenaltyExcessCharacter: 1000000
176+
PenaltyIndentedWhitespace: 0
177+
PenaltyReturnTypeOnItsOwnLine: 60
178+
PointerAlignment: Right
179+
QualifierAlignment: Leave
180+
ReferenceAlignment: Pointer
181+
ReflowComments: false
182+
RemoveBracesLLVM: false
183+
RemoveParentheses: Leave
184+
RemoveSemicolon: false
185+
RequiresClausePosition: OwnLine
186+
RequiresExpressionIndentation: OuterScope
187+
SeparateDefinitionBlocks: Leave
188+
ShortNamespaceLines: 1
189+
SkipMacroDefinitionBody: false
190+
SortIncludes: Never
191+
SortJavaStaticImport: Before
192+
SortUsingDeclarations: LexicographicNumeric
193+
SpaceAfterCStyleCast: false
194+
SpaceAfterLogicalNot: false
195+
SpaceAfterTemplateKeyword: false
196+
SpaceAroundPointerQualifiers: Default
197+
SpaceBeforeAssignmentOperators: true
198+
SpaceBeforeCaseColon: false
199+
SpaceBeforeCpp11BracedList: false
200+
SpaceBeforeCtorInitializerColon: true
201+
SpaceBeforeInheritanceColon: true
202+
SpaceBeforeJsonColon: false
203+
SpaceBeforeParens: ControlStatements
204+
SpaceBeforeParensOptions:
205+
AfterControlStatements: true
206+
AfterForeachMacros: true
207+
AfterFunctionDeclarationName: false
208+
AfterFunctionDefinitionName: false
209+
AfterIfMacros: true
210+
AfterOverloadedOperator: true
211+
AfterPlacementOperator: true
212+
AfterRequiresInClause: false
213+
AfterRequiresInExpression: false
214+
BeforeNonEmptyParentheses: false
215+
SpaceBeforeRangeBasedForLoopColon: true
216+
SpaceBeforeSquareBrackets: false
217+
SpaceInEmptyBlock: false
218+
SpacesBeforeTrailingComments: 2
219+
SpacesInAngles: Never
220+
SpacesInContainerLiterals: false
221+
SpacesInLineCommentPrefix:
222+
Minimum: 1
223+
Maximum: -1
224+
SpacesInParens: Never
225+
SpacesInParensOptions:
226+
InConditionalStatements: false
227+
InCStyleCasts: false
228+
InEmptyParentheses: false
229+
Other: false
230+
SpacesInSquareBrackets: false
231+
Standard: Auto
232+
StatementAttributeLikeMacros:
233+
- Q_EMIT
234+
StatementMacros:
235+
- Q_UNUSED
236+
- QT_REQUIRE_VERSION
21237
TabWidth: 2
22238
UseTab: Never
239+
VerilogBreakBetweenInstancePorts: true
240+
WhitespaceSensitiveMacros:
241+
- BOOST_PP_STRINGIZE
242+
- CF_SWIFT_NAME
243+
- NS_SWIFT_NAME
244+
- PP_STRINGIZE
245+
- STRINGIZE
246+
BracedInitializerIndentWidth: 2

‎.codespellrc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[codespell]
2+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
3+
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
4+
ignore-words-list = ba,licence,varius
5+
skip = ./.git,./.licenses,__pycache__,.clang-format,.codespellrc,.editorconfig,.flake8,.prettierignore,.yamllint.yml,.gitignore
6+
builtin = clear,informal,en-GB_to_en-US
7+
check-filenames =
8+
check-hidden =

‎.editorconfig‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/general/.editorconfig
2+
# See: https://editorconfig.org/
3+
# The formatting style defined in this file is the official standardized style to be used in all Arduino Tooling
4+
# projects and should not be modified.
5+
# Note: indent style for each file type is defined even when it matches the universal config in order to make it clear
6+
# that this type has an official style.
7+
8+
[*]
9+
charset = utf-8
10+
end_of_line = lf
11+
indent_size = 2
12+
indent_style = space
13+
insert_final_newline = true
14+
trim_trailing_whitespace = true
15+
16+
[*.{adoc,asc,asciidoc}]
17+
indent_size = 2
18+
indent_style = space
19+
20+
[*.{bash,sh}]
21+
indent_size = 4
22+
indent_style = space
23+
24+
[*.{c,cc,cp,cpp,cxx,h,hh,hpp,hxx,ii,inl,ino,ixx,pde,tpl,tpp,txx}]
25+
indent_size = 2
26+
indent_style = space
27+
28+
[*.{go,mod}]
29+
indent_style = tab
30+
31+
[*.java]
32+
indent_size = 2
33+
indent_style = space
34+
35+
[*.{js,jsx,json,jsonc,json5,ts,tsx}]
36+
indent_size = 2
37+
indent_style = space
38+
39+
[*.{md,mdx,mkdn,mdown,markdown}]
40+
indent_size = unset
41+
indent_style = space
42+
43+
[*.proto]
44+
indent_size = 2
45+
indent_style = space
46+
47+
[*.py]
48+
indent_size = 4
49+
indent_style = space
50+
51+
[*.svg]
52+
indent_size = 2
53+
indent_style = space
54+
55+
[*.{yaml,yml}]
56+
indent_size = 2
57+
indent_style = space
58+
59+
[{.gitconfig,.gitmodules}]
60+
indent_style = tab

‎.github/workflows/pre-commit-status.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# This needs to be in a separate workflow because it requires higher permissions than the calling workflow
2+
name: Report Pre-commit Check Status
3+
4+
on:
5+
workflow_run:
6+
workflows: [Pre-commit hooks]
7+
types:
8+
- completed
9+
10+
permissions:
11+
statuses: write
12+
13+
jobs:
14+
report-success:
15+
name: Report pre-commit success
16+
if: github.event.workflow_run.conclusion == 'success'
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Report success
20+
uses: actions/github-script@v7
21+
with:
22+
script: |
23+
const owner = '${{ github.repository_owner }}';
24+
const repo = '${{ github.repository }}'.split('/')[1];
25+
const sha = '${{ github.event.workflow_run.head_sha }}';
26+
core.debug(`owner: ${owner}`);
27+
core.debug(`repo: ${repo}`);
28+
core.debug(`sha: ${sha}`);
29+
const { context: name, state } = (await github.rest.repos.createCommitStatus({
30+
context: 'Pre-commit checks',
31+
description: 'Pre-commit checks successful',
32+
owner: owner,
33+
repo: repo,
34+
sha: sha,
35+
state: 'success',
36+
target_url: 'https://github.com/${{ github.repository }}/actions/runs/${{ github.event.workflow_run.id }}'
37+
})).data;
38+
core.info(`${name} is ${state}`);
39+
40+
report-pending:
41+
name: Report pre-commit pending
42+
if: github.event.workflow_run.conclusion != 'success'
43+
runs-on: ubuntu-latest
44+
steps:
45+
- name: Report pending
46+
uses: actions/github-script@v7
47+
with:
48+
script: |
49+
const owner = '${{ github.repository_owner }}';
50+
const repo = '${{ github.repository }}'.split('/')[1];
51+
const sha = '${{ github.event.workflow_run.head_sha }}';
52+
core.debug(`owner: ${owner}`);
53+
core.debug(`repo: ${repo}`);
54+
core.debug(`sha: ${sha}`);
55+
const { context: name, state } = (await github.rest.repos.createCommitStatus({
56+
context: 'Pre-commit checks',
57+
description: 'The pre-commit checks need to be successful before merging',
58+
owner: owner,
59+
repo: repo,
60+
sha: sha,
61+
state: 'pending',
62+
target_url: 'https://github.com/${{ github.repository }}/actions/runs/${{ github.event.workflow_run.id }}'
63+
})).data;
64+
core.info(`${name} is ${state}`);

0 commit comments

Comments
 (0)