3pp-mirror/public-apis
1
0
Fork 0
mirror of https://github.com/public-apis/public-apis.git synced 2025-05-15 10:06:48 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add Section Header check to CI

Browse source
This commit is contained in:
davemachado 2018-03-11 22:04:14 -04:00
parent ce27245e03
commit eb49420728
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
build/validate_format.py
View file

@ -18,6 +18,9 @@ index_cors = 4
index_link = 5 index_link = 5
errors = [] errors = []
title_links = []
anchor_re = re.compile('###\s(.+)')
section_title_re = re.compile('\*\s\[(.*)\]')
def add_error(line_num, message): def add_error(line_num, message):
@ -107,11 +110,16 @@ def check_format(filename):
num_in_category = min_entries_per_section + 1 num_in_category = min_entries_per_section + 1
category = "" category = ""
category_line = 0 category_line = 0
anchor_re = re.compile('###\s\S+')
for line_num, line in enumerate(lines): for line_num, line in enumerate(lines):
if section_title_re.match(line):
title_links.append(section_title_re.match(line).group(1))
# check each section for the minimum number of entries # check each section for the minimum number of entries
if line.startswith(anchor): if line.startswith(anchor):
if not anchor_re.match(line): match = anchor_re.match(line)
if match:
if match.group(1) not in title_links:
add_error(line_num, "section header ({}) not added as a title link".format(match.group(1)))
else:
add_error(line_num, "section header is not formatted correctly") add_error(line_num, "section header is not formatted correctly")
if num_in_category < min_entries_per_section: if num_in_category < min_entries_per_section:
add_error(category_line, "{} section does not have the minimum {} entries (only has {})".format( add_error(category_line, "{} section does not have the minimum {} entries (only has {})".format(