Skip to content

Add linter configuration #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmohns merged 3 commits into from
Nov 2, 2023
Merged

Add linter configuration #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c43d68
Add linter configuration
dmohns Nov 2, 2023
ddd0009
Fix CI
dmohns Nov 2, 2023
e89ad7f
Fix whitespaces in `README`
dmohns Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .ecrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"Exclude": [
".git"
]
}
6 changes: 6 additions & 0 deletions .editorconfig
View file
Open in desktop
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
42 changes: 42 additions & 0 deletions .github/workflows/check-generic.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 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:
- name: Checkout
uses: actions/checkout@v4
- name: Install editorconfig-checker
run: pipx install "editorconfig-checker"
- name: Run editorconfig-checker
run: ec .

markdownlint:
name: Run markdownlint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run markdownlint-cli2
uses: DavidAnson/markdownlint-cli2-action@v13

yamllint:
name: Run yamllint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run yamllint
run: yamllint .
30 changes: 30 additions & 0 deletions .github/workflows/check.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Check

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

jobs:
ruff:
name: Lint ruff
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install ruff
run: pipx install ruff
- name: Run editorconfig-checker
run: ruff check .

black:
name: Lint Black
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run Black
uses: psf/black@stable
6 changes: 3 additions & 3 deletions .github/workflows/ci-cd.yml → .github/workflows/release-pypi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on: push
jobs:
pypi-publish:
name: Upload release to PyPI
if: startsWith(github.ref, 'refs/tags/v') # On tagged release only
if: startsWith(github.ref, 'refs/tags/v') # On tagged release only
runs-on: ubuntu-latest
environment:
name: release
Expand All @@ -16,8 +16,8 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.x"
python-version: 3.x
- name: Generate package distribution
run: python3 setup.py sdist
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
uses: pypa/gh-action-pypi-publish@release/v1
12 changes: 12 additions & 0 deletions .markdownlint-cli2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Disable some built-in rules
config:
line-length: false
no-inline-html: false
first-line-h1: false
code-block-style: false # conflicts with MkDocs Admontions: https://squidfunk.github.io/mkdocs-material/reference/admonitions/
code-fence-style:
style: backtick

# Define glob expressions to use (only valid at root)
globs:
- "**/*.md"
13 changes: 13 additions & 0 deletions .yamllint
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
extends: default

rules:
document-start: disable
indentation:
spaces: 2
line-length: disable
quoted-strings:
quote-type: double
required: only-when-needed
allow-quoted-quotes: true
truthy:
check-keys: false
146 changes: 75 additions & 71 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.