1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
|
#!/usr/bin/env python3
# SPDX-FileCopyrightText: 2023 Jonathan Poelen <jonathan.poelen@gmail.com>
# SPDX-License-Identifier: MIT
from pathlib import Path
from collections import defaultdict
from typing import TextIO
import re
import sys
exclude_line = {
' - non-standard\n',
' - experimental\n',
' - deprecated\n',
'page-type: css-combinator\n',
'page-type: css-selector\n',
'page-type: css-module\n',
'page-type: landing-page\n',
'page-type: guide\n',
}
page_type_accepted = {
'page-type: css-type\n',
'page-type: css-function\n',
'page-type: css-property\n',
'page-type: css-keyword\n',
'page-type: css-shorthand-property\n',
'page-type: css-pseudo-element\n',
'page-type: css-pseudo-class\n',
'page-type: css-at-rule-descriptor\n',
'page-type: css-at-rule\n',
'page-type: css-media-feature\n',
'page-type: svg-attribute\n',
}
exclude_title = {
'<alpha-value>',
'<angle>',
'<angle-percentage>',
'<basic-shape>',
'<calc-constant>',
'<calc-sum>',
'<color-interpolation-method>',
'<color>',
'<custom-ident>',
'<dashed-ident>',
'<display-listitem>',
'<display-inside>',
'<dimension>',
'<easing-function>'
'<filter-function>',
'<flex>',
'<frequency-percentage>',
'<frequency>',
'<gradient>',
'<hex-color>',
'<hue>',
'<hue-interpolation-method>',
'<ident>',
'<image>',
'<integer>',
'<length>',
'<length-percentage>',
'<number>',
'<percentage>',
'<position>',
'<ratio>',
'<resolution>',
'<string>',
'<time-percentage>',
'<time>',
'<transform-function>',
'"!important"',
}
properties_ignore_value = (
'counter-increment',
'counter-reset',
'counter-set',
'text-rendering',
'page',
)
units: list[str] = []
colors: set[str] = set()
system_colors: set[str] = set()
deprecated_system_colors: set[str] = set()
values: set[str] = set()
properties: set[str] = set()
svg_values: set[str] = set()
svg_properties: set[str] = set()
functions: set[str] = set()
pseudo_classes: set[str] = set()
pseudo_elements: set[str] = set()
experimental_pseudo_classes: set[str] = set()
experimental_pseudo_elements: set[str] = set()
at_rules: set[str] = set()
media_features: set[str] = set()
media_feature_values: set[str] = set()
_update_version_extractor = re.compile(r' version="(\d+)" ')
def update_version(s: str) -> str:
return _update_version_extractor.sub(lambda m: f' version="{int(m[1])+1}" ', s, count=1)
_md_value_extractor = re.compile(r'(?<=[^\w][ /])`([-\w][-\w\d]+(?:<[^>]+>[?+*])?)`')
_html_value_extractor = re.compile(r'<code>([-\w][-\w\d]+)</code>')
_is_md_value = re.compile(r'^\s*- `')
_is_html_table_desc = re.compile(r'^\s+<td><code>')
def css_parse_values(f: TextIO, prop: str, values: set[str]) -> None:
line:str = ''
# Format:
# ## Syntax or ### Syntax
#
# ```css
# (optional)
# ```
# ## Values or ### Values or not...
#
# - `ident` or html table <td><code>....</code></td>
#
# ## SVG only ... (optional)
# ## other title
for line in f:
if line.endswith('## Syntax\n') or line.endswith('## Values\n') or '## SVG only' in line:
for line in f:
if _is_md_value.match(line):
if 'deprecated' not in line:
values.update(_md_value_extractor.findall(line))
elif line.startswith('#'):
if not (line.endswith('## Values\n') or '## SVG only' in line
or (prop == 'display'
and (line.endswith('## Grouped values\n')
or line.endswith('## Outside\n')
or line.endswith('## Inside\n')
or line.endswith('## List Item\n')
or line.endswith('## Internal\n')
or line.endswith('## Box\n')
or line.endswith('## Precomposed\n')
))
):
return
elif line == '```css\n':
for line in f:
if line.startswith('```\n'):
break
elif _is_html_table_desc.match(line):
values.update(_html_value_extractor.findall(line))
def css_parse_named_colors(f: TextIO) -> set[str]:
return set(re.findall('\n <td>(?:\n )?<code>([a-z]+)</code>', f.read()))
def css_parse_units(f: TextIO) -> list[str]:
return re.findall(r'`([^`]+)`', ''.join(re.findall(r'\n\| (`[^|]+)', f.read())))
_svg_values_extractor = re.compile(r'<th scope="row">Value</th>\n\s*<td>(.*?)</td>', re.DOTALL)
_svg_value_extractor = re.compile(r'<code>([-\w\d]+)</code>')
def css_parse_svg_attribute(f: TextIO, prop: str, properties: set[str], values: set[str]) -> None:
contents = f.read()
if 'can be used as a CSS property' in contents:
properties.add(prop)
m = _svg_values_extractor.search(contents)
if m:
values.update(_svg_value_extractor.findall(m[1]))
_experimental_selector_extractor = re.compile(r'\n- {{CSSxRef([^}]+)}} {{Experimental_Inline}}')
_selector_extractor = re.compile(r'":+([-\w\d]+)[()]*"')
def css_parse_pseudo_classes_or_elements(f: TextIO) -> tuple[
set[str], # experimental
list[str]
]:
s = f.read()
experimental_str = ''.join(_experimental_selector_extractor.findall(s))
return (set(_selector_extractor.findall(experimental_str)), _selector_extractor.findall(s))
if len(sys.argv) < 5:
print(f'''{Path(sys.argv[0]).name} content-main-directory syntax/css.xml sass-site-directory syntax/scss.xml
content-main-directory is https://github.com/mdn/content/ (https://github.com/mdn/content/archive/refs/heads/main.zip)
sass-site-directory is https://github.com/sass/sass-site/tree/main (https://github.com/sass/sass-site/archive/refs/heads/main.zip)
''', file=sys.stderr)
exit(1)
css_dir = Path(sys.argv[1])
css_filename = Path(sys.argv[2])
scss_dir = Path(sys.argv[3])
scss_filename = Path(sys.argv[4])
tmp_pseudo_classes = (set(), ())
tmp_pseudo_elements = (set(), ())
for pattern in (
'files/en-us/web/svg/attribute/**/',
'files/en-us/web/css/**/',
):
for md in css_dir.glob(pattern):
with open(md/'index.md', encoding='utf8') as f:
if f.readline() != '---\n':
continue
title = f.readline()[7:-1]
if title in exclude_title:
continue
if title.startswith('"'):
title = title[1:-1]
page_type = ''
for line in f:
if line in exclude_line:
page_type = ''
break
if line.startswith('page-type: '):
if line not in page_type_accepted:
raise Exception(f'Unknown {line[:-1]}')
page_type = line[11:-1]
if line == '---\n':
break
if page_type == 'css-property' or page_type == 'css-at-rule-descriptor':
properties.add(title)
if not title.endswith('-name') and title not in properties_ignore_value:
css_parse_values(f, title, values)
elif page_type == 'css-shorthand-property':
properties.add(title)
elif page_type == 'css-pseudo-class':
pseudo_classes.add(title[1:].removesuffix('()'))
elif page_type == 'css-pseudo-element':
pseudo_elements.add(title[2:].removesuffix('()'))
elif page_type == 'css-type':
if title == '<named-color>':
colors = css_parse_named_colors(f)
if title == '<system-color>':
css_parse_values(f, '', system_colors)
deprecated_system_colors = set(re.findall('\n- `([^`]+)` {{deprecated_inline}}', f.read()))
else:
css_parse_values(f, '', values)
elif page_type == 'css-function':
functions.add(title[:-2])
elif page_type == 'css-at-rule':
at_rules.add(title)
elif page_type == 'css-media-feature':
media_features.add(title)
css_parse_values(f, title, media_feature_values)
elif page_type == 'css-keyword':
values.add(title)
elif title == 'CSS values and units':
units = css_parse_units(f)
elif title == 'Pseudo-classes':
tmp_pseudo_classes = css_parse_pseudo_classes_or_elements(f)
elif title == 'Pseudo-elements':
tmp_pseudo_elements = css_parse_pseudo_classes_or_elements(f)
elif page_type == 'svg-attribute':
css_parse_svg_attribute(f, title, svg_properties, svg_values)
elif title == 'CSS value functions':
functions.update(re.findall(r'\n- {{CSSxRef\("[^"]+", "([-\w\d]+)\(\)"\)}}\n', f.read()))
experimental_pseudo_classes = tmp_pseudo_classes[0]
experimental_pseudo_classes -= pseudo_classes
pseudo_classes.update(tmp_pseudo_classes[1])
experimental_pseudo_elements = tmp_pseudo_elements[0]
experimental_pseudo_elements -= pseudo_elements
pseudo_elements.update(tmp_pseudo_elements[1])
global_values = {
'auto',
'inherit',
'initial',
'revert',
'revert-layer',
'unset',
}
values -= global_values
svg_values -= global_values
pseudo_classes -= experimental_pseudo_classes
pseudo_elements -= experimental_pseudo_elements
# add values of functions
values.update((
# repeat()
'auto-fill',
'auto-fit',
))
# move some keyword colors in values
for special_color in ('transparent', 'currentcolor'):
values.add(special_color)
colors.discard(special_color)
# fix not specified value in mdn file
if 'user-invalid' in experimental_pseudo_classes:
pseudo_classes.discard('user-valid')
experimental_pseudo_classes.add('user-valid')
media_features.update((
'min-width',
'max-width',
'min-height',
'max-height',
))
# fix errors in mdn file
for e in ('has', 'host-context'):
pseudo_classes.add(e)
experimental_pseudo_classes.discard(e)
# @font-format functions
functions.update((
'format',
'local',
'tech',
))
# def show(name, values):
# print(f'{name} ({len(values)}):')
# print('\n'.join(sorted(values)), end='\n\n')
#
# show('properties', properties)
# show('svg properties', svg_properties)
# show('values', values)
# show('svg values', svg_values)
# show('global values', global_values)
# show('functions', functions)
# show('pseudo-classes', pseudo_classes)
# show('pseudo-elements', pseudo_elements)
# show('experimental pseudo-classes', experimental_pseudo_classes)
# show('experimental pseudo-elements', experimental_pseudo_elements)
# show('at-rules', at_rules)
# show('media-features', media_features)
# show('media-features values', media_feature_values)
# show('colors', colors)
# show('system colors', system_colors)
# show('deprecated system colors', deprecated_system_colors)
# show('units', units)
# print('units reg:', '|'.join(units))
#
# Update CSS
#
sep = '\n '
css_replacements = {
prop: f'</item>{sep}<item>'.join(sorted(seq))
for prop, seq in (
('properties', properties),
('values', values),
('value keywords', global_values),
('functions', functions),
('pseudo-classes', pseudo_classes),
('pseudo-elements', pseudo_elements),
('media features', media_features)
)
}
for prop, seq in (('properties', svg_properties - properties), ('values', svg_values - values)):
if seq:
items = f'</item>{sep}<item>'.join(sorted(seq))
css_replacements[prop] += f'</item>\n{sep}<!-- SVG only -->\n{sep}<item>{items}'
rep1 = f'</item>{sep}<item>'.join(sorted(colors))
rep2 = f'</item>{sep}<item>'.join(sorted(system_colors))
css_replacements['colors'] = f'{rep1}</item>{sep}{sep}<!-- System colors -->{sep}<item>{rep2}'
item_extractor = re.compile('<item>([^-<][^<]*)')
current_at_rules = set()
def _css_update_and_extract_items(m) -> str:
seq = css_replacements.get(m[1])
if seq:
end = ' ' if m[3] == '</list>' else sep
return f'<list name="{m[1]}">{sep}<item>{seq}</item>\n{end}{m[3]}'
current_at_rules.update(item_extractor.findall(m[2]))
return m[0]
css_content = css_filename.read_text()
original_css_content = css_content
names = f"{'|'.join(css_replacements)}|at-rules(?: definitions)?"
css_content = re.sub(rf'<list name="({names})">(.*?)(</list>|<!-- manual list -->)',
_css_update_and_extract_items, css_content, flags=re.DOTALL)
_regexpr_unit_prefix = r'(<RegExpr attribute="Unit".*?String="\(%\|\()'
regexpr_unit_extractor = re.compile(fr'{_regexpr_unit_prefix}([^)]+)')
css_content = regexpr_unit_extractor.sub('\\1' + "|".join(units), css_content, 1)
if original_css_content != css_content:
css_content = update_version(css_content)
css_filename.write_text(css_content)
def show_at_rule_difference(language: str, old_at_rules: set[str], new_at_rules: set[str]) -> None:
at_rule_added = new_at_rules - old_at_rules
at_rule_removed = old_at_rules - new_at_rules
nl = '\n '
if at_rule_added or at_rule_removed:
print(f"""\x1b[31m{language} At-rules requires a manual update
New ({len(at_rule_added)}):\x1b[0m
{nl.join(at_rule_added)}
\x1b[31mRemoved ({len(at_rule_removed)}):\x1b[0m
{nl.join(at_rule_removed)}""")
show_at_rule_difference('CSS', current_at_rules, at_rules)
#
# Extract SCSS data
#
scss_functions:list[str] = []
scss_at_rules:set[str] = {'@content', '@return'}
_function_list_extractor = re.compile(r'{% function (.*?) %}')
_function_extractor = re.compile(r"'([-._a-zA-Z0-9]+)\(")
_at_rule_extractor = re.compile(r'@[-a-z0-9]+')
for md in sorted(scss_dir.glob('source/documentation/modules/**/*.md')):
func_list = _function_list_extractor.findall(md.read_text())
func_items = set(_function_extractor.findall(''.join(func_list)))
scss_functions.append(f'\n{sep}<!-- {md.stem} -->')
scss_functions.extend(f'{sep}<item>{func}</item>' for func in sorted(func_items - functions))
for md in scss_dir.glob('source/documentation/at-rules/**/*.md'):
with open(md) as f:
f.readline()
scss_at_rules.update(_at_rule_extractor.findall(f.readline()))
subproperties = set(
'-'.join(splitted[i:n])
for prop in properties
for splitted in (prop.rsplit('-', prop.count('-') - 1) # '-aaa-bbb' -> ['-aaa', 'bbb']
if prop.startswith('-')
else prop.split('-'), ) # 'aaa-bbb' -> ['aaa', 'bbb']
for i in range(len(splitted))
for n in range(i+1, len(splitted)+1)
)
#
# Update SCSS
#
scss_current_at_rules = set()
def _scss_update_and_extract_items(m) -> str:
name = m[1]
if name == 'functions':
return f"""<list name="functions">
<include>functions##CSS</include>
<!-- https://sass-lang.com/documentation/modules/ -->{f''.join(scss_functions)}
</list>"""
if name == 'at-rules':
scss_current_at_rules.update(_at_rule_extractor.findall(m[2]))
return m[0]
# sub-properties
items = f'</item>{sep}<item>'.join(sorted(subproperties - properties))
return f'<list name="{name}">{sep}<item>{items}</item>\n </list>'
scss_content = scss_filename.read_text()
original_scss_content = scss_content
scss_content = re.sub(r'<list name="(sub-properties|functions|at-rules)">(.*?)</list>',
_scss_update_and_extract_items, scss_content, count=3, flags=re.DOTALL)
scss_content = re.sub(r'<!ENTITY pseudoclasses "[^"]*">',
f'<!ENTITY pseudoclasses "{"|".join(sorted(pseudo_classes))}">',
scss_content, count=1)
scss_content = regexpr_unit_extractor.sub('\\1' + "|".join(units), scss_content, 1)
if original_scss_content != scss_content:
scss_content = update_version(scss_content)
scss_filename.write_text(scss_content)
show_at_rule_difference('SCSS', scss_current_at_rules, scss_at_rules)
|