Skip to content

Commit

Permalink
Add basic linter configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
dmohns committed Nov 12, 2024
1 parent f11a601 commit e772ff7
Show file tree
Hide file tree
Showing 6 changed files with 124 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# EditorConfig is awesome: https://EditorConfig.org

[*]
# Ensure consistent file encoding in UNIX style
charset = utf-8
end_of_line = lf
40 changes: 40 additions & 0 deletions .github/workflows/check-generic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Generic checks to ease collaboration:
# - consistent file encoding in UNIX style
# - whitespaces in all purposes files like markdown, yaml, etc
name: Check Generic

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
editorconfig-checker:
name: Run editorconfig-checker
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Run editorconfig-checker
run: docker run --rm --volume=$PWD:/check mstruebing/editorconfig-checker

markdownlint:
name: Run markdownlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Run markdownlint-cli2
uses: DavidAnson/markdownlint-cli2-action@v16

yamllint:
name: Run yamllint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Run yamllint
run: yamllint .
43 changes: 43 additions & 0 deletions .github/workflows/check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Check Code Quality

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
# lint-eslint:
# name: Lint ESLint
# runs-on: ubuntu-latest

# steps:
# - uses: actions/checkout@v4

# - name: Setup Node.js
# uses: actions/setup-node@v4
# with:
# node-version: ">=18.x"

# - name: Install dependencies
# run: npm install

# - name: Run ESLint
# run: npm run lint

lint-prettier:
name: Lint Prettier
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ">=18.x"

- name: Run Prettier
run: npx prettier . --check
14 changes: 14 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Disable some built-in rules
config:
line-length: false
no-inline-html: false
first-line-h1: false
code-fence-style:
style: backtick

# Define glob expressions to use (only valid at root)
globs:
- "**/*.md"

# Ignore files that are not part of version control
gitignore: true
5 changes: 5 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"semi": false,
"trailingComma": "es5",
"useTabs": false
}
16 changes: 16 additions & 0 deletions .yamllint
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
extends: default

ignore-from-file: .gitignore

rules:
document-start: disable
indentation:
spaces: 2
line-length: disable
quoted-strings:
quote-type: double
required: only-when-needed
allow-quoted-quotes: true
check-keys: true
truthy:
check-keys: false

0 comments on commit e772ff7

Please sign in to comment.