Skip to content

Commit

Permalink
ci: Added code linters
Browse files Browse the repository at this point in the history
  • Loading branch information
SaptarshiSarkar12 committed Oct 23, 2023
1 parent 36960de commit 5a0a366
Show file tree
Hide file tree
Showing 5 changed files with 213 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/linters/.hadolint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
failure-threshold: warning
ignored:
- DL3000
- DL3029
33 changes: 33 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
default: true
MD001: true # Header levels should only increment by one level at a time
MD003:
style: consistent # Header style
MD004:
style: consistent # Unordered list style
MD005: true # Inconsistent indentation for list items at the same level
MD022: true # Headers should be surrounded by blank lines
MD023: true # Headers must start at the beginning of the line
MD024: true # Multiple headers with the same content
MD026:
punctuation: ".,;:!" # Trailing punctuation in header
MD027: true # Multiple spaces after blockquote symbol
MD028: true # Blank line inside blockquote
MD029: true # Ordered list item prefix
MD036:
punctuation: ".,;:!?。,;:!?" # Emphasis used instead of a header
MD037: true # Spaces inside emphasis markers
MD038: true # Spaces inside code span elements
MD039: true # Spaces inside link text
MD040: true # Fenced code blocks should have a language specified
MD042: true # No empty links
MD044: true # Proper names should have the correct capitalization
MD045: true # Images should have an alternate text (alt text)
MD046:
style: fenced # Code block style
MD048:
style: backtick # Code block fence style
MD049:
style: consistent # Emphasis style should be consistent
MD050:
style: consistent # Strong style should be consistent
MD051: true # Link Fragments should be valid
118 changes: 118 additions & 0 deletions .github/linters/sun_checks.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
<module name="NewlineAtEndOfFile"/>
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>
<module name="FileTabCharacter"/>
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
</module>
<!-- Checks for Naming Conventions -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<!-- Checks for Import statements -->
<module name="IllegalImport"/>
<module name="RedundantImport"/>
<module name="UnusedImports"/>

<module name="TreeWalker">
<module name="ImportOrder">
<property name="sortImportsInGroupAlphabetically" value="true"/>
<property name="separateLineBetweenGroups" value="true"/>
<property name="separateStaticAndRegularImports" value="true"/>
<property name="ordered" value="true"/>
<property name="groups" value="java,javax,javafx,org,com"/>
</module>
<module name="EmptyBlock">
<property name="tokens" value="LITERAL_DEFAULT"/>
</module>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="ignored"/>
</module>
<module name="LeftCurly">
<property name="option" value="nlow"/>
</module>
<module name="NeedBraces"/>
<module name="RightCurly"/>
<module name="FinalClass"/>
<module name="InnerTypeLast"/>
<module name="DeclarationOrder"/>
<module name="MissingSwitchDefault"/>
<module name="DefaultComesLast"/>
<module name="EmptyStatement"/>
<module name="FallThrough"/>
<module name="HiddenField"/>
<module name="InnerAssignment"/>
<module name="ModifiedControlVariable"/>
<module name="MultipleVariableDeclarations"/>
<module name="NestedForDepth"/>
<module name="NestedIfDepth">
<property name="max" value="3"/>
</module>
<module name="NestedTryDepth"/>
<module name="NoArrayTrailingComma"/>
<module name="NoEnumTrailingComma"/>
<module name="OneStatementPerLine"/>
<module name="OverloadMethodsDeclarationOrder"/>
<module name="RequireThis"/>
<module name="ParameterAssignment"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="StringLiteralEquality"/>
<module name="UnnecessarySemicolonAfterTypeMemberDeclaration"/>
<module name="UnusedLocalVariable"/>
<module name="ArrayTypeStyle"/>
<module name="CommentsIndentation"/>
<module name="Indentation">
<property name="forceStrictCondition" value="false"/>
</module>
<module name="NoCodeInFile"/>
<module name="OuterTypeFilename"/>
<module name="UpperEll"/>
<module name="ModifierOrder"/>
<module name="AbbreviationAsWordInName"/>
<module name="CatchParameterName"/>
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="ParameterName"/>
<module name="PatternVariableName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<module name="EmptyForInitializerPad"/>
<module name="EmptyForIteratorPad"/>
<module name="EmptyLineSeparator">
<property name="allowMultipleEmptyLines" value="false"/>
</module>
<module name="MethodParamPad"/>
<module name="NoLineWrap"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="NoWhitespaceBeforeCaseDefaultColon"/>
<module name="OperatorWrap">
<property name="option" value="eol"/>
</module>
<module name="ParenPad"/>
<module name="SeparatorWrap"/>
<module name="SingleSpaceSeparator"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>
</module>
</module>
26 changes: 26 additions & 0 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Lint Code Base

on:
push:
pull_request:

jobs:
build:
name: Lint Code Base
runs-on: ubuntu-latest
permissions:
contents: read
packages: read
statuses: write
steps:
- name: Checkout Code
uses: actions/checkout@v4
with:
# Full git history is needed to get a proper
# list of changed files within `super-linter`
fetch-depth: 0
- name: Lint Code Base
uses: super-linter/super-linter@v5
env:
DEFAULT_BRANCH: master
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
32 changes: 32 additions & 0 deletions .idea/jsonSchemas.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 comment on commit 5a0a366

@vercel
Copy link

@vercel vercel bot commented on 5a0a366 Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.