From 58608b1208ec40d99388636517db4b02f6cc701d Mon Sep 17 00:00:00 2001 From: "Anders H. Rebner" <anderhre@stud.ntnu.no> Date: Sat, 29 Feb 2020 21:32:51 +0100 Subject: [PATCH] Oppdaterte README (linting) --- README.md | 2 +- scripts/CodeQualityCheck.sh | 14 ++++++++------ soitool/modules/__init__.py | 2 +- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cb0053a..5abde24 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ deactivate ## Linting -Sjekk av kodekvalitet gjøres med scriptet "CodeQualityCheck" i script-mappa, og er skrevet i Powershell(.ps1) og Bash(.sh). Scriptet kjører Pylint og Flake8 med tilhørende konfigurasjonsfiler, Pydocstyle med numpy-konvensjon og Bandit på python-filer. +Sjekk av kodekvalitet gjøres med scriptet "CodeQualityCheck" i script-mappa, og er skrevet i Powershell(.ps1) og Bash(.sh). Scriptet kjører Pylint og Flake8 med tilhørende konfigurasjonsfiler, Pydocstyle med numpy-konvensjon og Bandit på Python-filer. Scriptet godtar kommandolinjeargumenter: .py-fil(er), mappe(r ) eller en blanding av disse. Uten argumenter vil scriptet sjekke alle .py-filer. diff --git a/scripts/CodeQualityCheck.sh b/scripts/CodeQualityCheck.sh index 0e3bbdb..899f9a4 100644 --- a/scripts/CodeQualityCheck.sh +++ b/scripts/CodeQualityCheck.sh @@ -3,7 +3,9 @@ if [[ $# -eq 0 ]]; then echo "\nChecking all .py-files" else args=$@ + for file in "${args[@]}"; do + if [[ $file =~ ^[A-Za-z0-9_/]+.py ]] && ! [[ $file =~ .pyc ]]; then files+=( "$file" ) else @@ -12,14 +14,14 @@ else done fi -for fileName in $files; do - printf "============================$(basename -- $fileName)============================\n" +for file in $files; do + printf "========================$(basename -- $file)========================\n" printf "\n===PYLINT===\n" - pylint --rcfile=./scripts/.pylintrc $fileName + pylint --rcfile=./scripts/.pylintrc $file printf "===FLAKE8===\n" - flake8 --config ./scripts/.flake8 $fileName + flake8 --config ./scripts/.flake8 $file printf "\n===BANDIT===\n" - bandit $fileName + bandit $file printf "\n===PYDOCSTYLE===\n" - pydocstyle --convention=numpy $fileName + pydocstyle --convention=numpy $file done diff --git a/soitool/modules/__init__.py b/soitool/modules/__init__.py index 8b64afe..2927ebf 100644 --- a/soitool/modules/__init__.py +++ b/soitool/modules/__init__.py @@ -1 +1 @@ -"""Interface for moduler og moduler.""" +"""All modules and moduleBase (interface).""" -- GitLab