Compare commits
3 Commits
2710bc790c
...
321d862a01
Author | SHA1 | Date | |
---|---|---|---|
321d862a01 | |||
2e9e681a92 | |||
c3703ebc87 |
@ -3,7 +3,7 @@
|
||||
---
|
||||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v3.2.0
|
||||
rev: v4.3.0
|
||||
hooks:
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
@ -13,3 +13,7 @@ repos:
|
||||
rev: 'v6.1.0' # Use the sha / tag you want to point at
|
||||
hooks:
|
||||
- id: rstcheck
|
||||
- repo: https://git.opytex.org/lafrite/clean-rst
|
||||
rev: v0.1.2
|
||||
hooks:
|
||||
- id: clean-rst
|
||||
|
@ -1,146 +0,0 @@
|
||||
#! /usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
# vim:fenc=utf-8
|
||||
#
|
||||
# Copyright © 2017 lafrite <lafrite@Poivre>
|
||||
#
|
||||
# Distributed under terms of the MIT license.
|
||||
|
||||
"""
|
||||
Git hook to ensure validity of all rst files
|
||||
"""
|
||||
|
||||
from git import Repo
|
||||
from pathlib import Path
|
||||
import re
|
||||
import time
|
||||
import restructuredtext_lint
|
||||
import sys
|
||||
|
||||
import logging
|
||||
|
||||
formatter = logging.Formatter('%(name)s :: %(levelname)s :: %(message)s')
|
||||
steam_handler = logging.StreamHandler()
|
||||
#steam_handler = logging.FileHandler('logging.conf')
|
||||
steam_handler.setLevel(logging.DEBUG)
|
||||
steam_handler.setFormatter(formatter)
|
||||
|
||||
# création de l'objet logger qui va nous servir à écrire dans les logs
|
||||
logger = logging.getLogger("precommit")
|
||||
# on met le niveau du logger à DEBUG, comme ça il écrit tout
|
||||
logger.setLevel(logging.WARNING)
|
||||
logger.addHandler(steam_handler)
|
||||
|
||||
# Files selection
|
||||
|
||||
def get_commited_files(repo):
|
||||
hdiff = repo.head.commit.diff()
|
||||
diff = {"A":[], "M":[]}
|
||||
for f in hdiff.iter_change_type("A"):
|
||||
diff["A"].append(f.b_path)
|
||||
for f in hdiff.iter_change_type("M"):
|
||||
diff["M"].append(f.b_path)
|
||||
|
||||
return diff
|
||||
|
||||
def select_by_extension(files, ext="rst"):
|
||||
return [i for i in files if i.split(".")[-1] == ext and 'skeleton' not in i]
|
||||
|
||||
# Rst linter
|
||||
|
||||
def rst_lint(filename):
|
||||
with open(filename, 'r') as f:
|
||||
errors = restructuredtext_lint.lint(f.read())
|
||||
for e in errors:
|
||||
logger.warning(f"{filename} \n{e.full_message}\n")
|
||||
return errors
|
||||
|
||||
|
||||
# Rst parameters normalize
|
||||
|
||||
def normalize_file(filename, normalizers = {}):
|
||||
logger.debug(f"Normalizing {filename}")
|
||||
logger.debug(f"With {normalizers}")
|
||||
new_file = ""
|
||||
modified_lines = []
|
||||
with open(filename, 'r') as f:
|
||||
for l in f.readlines():
|
||||
new_line = run_normalizers(l, normalizers)
|
||||
if new_line != l:
|
||||
modified_lines.append(f"{l}")
|
||||
logger.warning(f"{filename}\n\t{l}\t{new_line}")
|
||||
new_file += new_line
|
||||
|
||||
with open(filename, "w") as f:
|
||||
f.write(new_file)
|
||||
logger.debug(f"{filename} written")
|
||||
|
||||
return modified_lines
|
||||
|
||||
def run_normalizers(line, normalizers):
|
||||
for c in normalizers:
|
||||
obs = re.search(c, line)
|
||||
if obs:
|
||||
logger.debug(f"Find for {c}")
|
||||
return normalizers[c](line)
|
||||
return line
|
||||
|
||||
# Rst function tools
|
||||
|
||||
def update_date(line):
|
||||
date = time.strftime("%Y-%m-%d")
|
||||
logger.debug(f"Update Date to: {date}")
|
||||
return f":date: {date}\n"
|
||||
|
||||
def update_modified(line):
|
||||
modified = time.strftime("%Y-%m-%d")
|
||||
logger.debug(f"Update modified to: {modified}")
|
||||
return f":modified: {modified}\n"
|
||||
|
||||
def normalize_tags(line):
|
||||
logger.debug(f"Normaizing tags")
|
||||
tags = line.split(":")[-1]
|
||||
tags = [i.strip().capitalize() for i in tags.split(",")]
|
||||
tags_str = ", ".join(tags)
|
||||
logger.debug(f"Update tags to: {tags_str}")
|
||||
return f":tags: {tags_str}\n"
|
||||
|
||||
NORMALIZERS_MODIFIED = {
|
||||
":modified:.*": update_modified,
|
||||
":tags:.*": normalize_tags,
|
||||
}
|
||||
|
||||
NORMALIZERS_NEW = {
|
||||
":date:.*": update_date,
|
||||
":modified:.*": update_modified,
|
||||
":tags:.*": normalize_tags,
|
||||
}
|
||||
|
||||
if __name__ == "__main__":
|
||||
r = Repo()
|
||||
diff = get_commited_files(r)
|
||||
|
||||
errors = []
|
||||
modified = []
|
||||
|
||||
# New files
|
||||
for f in select_by_extension(diff["A"], "rst"):
|
||||
errors += rst_lint(f)
|
||||
modified += normalize_file(f, NORMALIZERS_NEW)
|
||||
r.index.add([f])
|
||||
# Modified files
|
||||
for f in select_by_extension(diff["M"], "rst"):
|
||||
errors += rst_lint(f)
|
||||
modified += normalize_file(f, NORMALIZERS_MODIFIED)
|
||||
r.index.add([f])
|
||||
|
||||
if len(errors) > 0:
|
||||
logger.warning("Errors in rst formating, commit aborted")
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
|
||||
# -----------------------------
|
||||
# Reglages pour 'vim'
|
||||
# vim:set autoindent expandtab tabstop=4 shiftwidth=4:
|
||||
# cursor: 16 del
|
@ -63,6 +63,7 @@ mkdir -p $sequence_path
|
||||
|
||||
export name=$name
|
||||
export date=$date
|
||||
export date_short=`date --date="$date 00:00" "+%d %B %Y"`
|
||||
export tribe=$tribe
|
||||
export duration=$duration
|
||||
envsubst < ./tools/skeleton/eval/exercises.tex > $sequence_path/exercises.tex
|
||||
|
@ -100,7 +100,8 @@ mkdir -p $sequence_path
|
||||
export title=$title
|
||||
export title_under=${title//?/#}
|
||||
export author='Benjamin Bertrand'
|
||||
export date=`date --date="$date 00:00" "+%B %Y"`
|
||||
export date=$date
|
||||
export date_short=`date --date="$date 00:00" "+%B %Y"`
|
||||
export tribe=$tribe
|
||||
export tags=$tags
|
||||
export summary=$summary
|
||||
|
@ -4,7 +4,7 @@
|
||||
% Title Page
|
||||
\title{ ${name} \hfill ${subname}}
|
||||
\tribe{${tribe}}
|
||||
\date{${date}}
|
||||
\date{${date_short}}
|
||||
\duree{${duration}}
|
||||
|
||||
\DeclareExerciseCollection[step=1]{banque}
|
||||
|
@ -3,7 +3,7 @@
|
||||
|
||||
\author{${author}}
|
||||
\title{${title} - Cours}
|
||||
\date{${date}}
|
||||
\date{${date_short}}
|
||||
|
||||
\pagestyle{empty}
|
||||
|
||||
|
@ -3,7 +3,7 @@
|
||||
|
||||
\author{${author}}
|
||||
\title{${title} - Exercices}
|
||||
\date{${date}}
|
||||
\date{${date_short}}
|
||||
|
||||
\DeclareExerciseCollection[step=1]{banque}
|
||||
\xsimsetup{collect}
|
||||
|
@ -4,7 +4,7 @@
|
||||
\author{${author}}
|
||||
\title{${title} - Plan de travail}
|
||||
\tribe{${tribe}}
|
||||
\date{${date}}
|
||||
\date{${date_short}}
|
||||
|
||||
\pagestyle{empty}
|
||||
|
||||
|
@ -6,7 +6,7 @@
|
||||
\author{${author}}
|
||||
\title{${title} - Solutions}
|
||||
\tribe{${tribe}}
|
||||
\date{${date}}
|
||||
\date{${date_short}}
|
||||
|
||||
\DeclareExerciseCollection{banque}
|
||||
\xsimsetup{
|
||||
|
Loading…
Reference in New Issue
Block a user