add checks

Author: bollwyvl

.vale.ini

@@ -0,0 +1,13 @@
+MinAlertLevel = suggestion
+Packages = aoo-mozilla-en-dict-us
+StylesPath = scripts/vale
+Vocab = urljsf
+IgnoredClasses = w, n, o, kt, s2
+
+[*.{md,py}]
+BasedOnStyles = aoo-mozilla-en-dict-us
+Vale.Spelling = NO
+
+[*.html]
+BasedOnStyles = aoo-mozilla-en-dict-us
+Vale.Spelling = NO

README.md

@@ -14,9 +14,9 @@
 
 **Visitors** to a `urljsf`-built page see:
 
-- one or more interative HTML forms...
+- one or more interactive HTML forms...
   - defined by and validated against a JSON [Schema][json-schema], optionally with...
-  - deep customizble [user interface][ui-schema]
+  - deep customizable [user interface][ui-schema]
   - pre-filled data
   - custom validation checks
 

docs/use/schema.rst

@@ -2,7 +2,7 @@ JSON Schema
 ===========
 
 A ``urljsf`` form definition should conform to the overall JSON schema, and may
-include additional, nested schema and documents, representd inline or referenced
+include additional, nested schema and documents, represented inline or referenced
 by URL.
 
 The `Draft 7` schema is used due to its wide implementation but, most specifically,

pixi.lock

@@ -16,6 +16,7 @@ run ALL tasks that would lead to a release""", depends-on = [
   "test",
   "docs",
   "atest",
+  "check",
   "report",
 ], cmd = "echo 🚢"}
 fix = {description = """
@@ -68,6 +69,13 @@ atest = {description = """
 run ALL acceptance tests""", depends-on = ["atest-robot", "atest-nyc"], cmd = "echo 🤖"}
 docs = {description = """
 build all documentation""", depends-on = ["docs-sphinx"], cmd = "echo 🖨️"}
+check = {description = """
+perform ALL pre-release checks""", depends-on = [
+  "check-links",
+  "check-vale",
+  "check-wheel",
+  "check-twine",
+], cmd = "echo 🤓"}
 
 # fragments ####################################################################
 prettier-- = '''yarn prettier
@@ -408,6 +416,44 @@ depends-on = ["atest-robot"]
 inputs = ["js/package.json", "build/reports/atest/istanbul/*.cov.json"]
 outputs = ["build/reports/nyc"]
 
+# check ########################################################################
+[feature.tasks-check.tasks.check-links]
+description = "... check github hyperlinks in documentation"
+cmd = """rm -rf build/reports/check-links
+  && mkdir -p build/reports/check-links
+  && cd build/reports/check-links
+  && touch pytest.ini
+  && pytest
+    -vv
+    -c pytest.ini
+    -p no:warnings
+    --rootdir=.
+    --check-links
+    --check-anchors
+    --check-links-ignore '^https?://'
+    -k "not (404 or coverage or lite or mypy or Untitled)"
+    ../../../build/docs/**/*.html"""
+depends-on = ["docs-sphinx"]
+inputs = ["docs/**/*.html"]
+
+[feature.tasks-check.tasks.check-vale]
+description = "... check spelling in documentation"
+cmd = "python scripts/vale/check.py"
+depends-on = ["docs-sphinx"]
+inputs = ["build/docs", "scripts/vale"]
+
+[feature.tasks-check.tasks.check-wheel]
+description = "... check the built wheel"
+cmd = "check-wheel-contents dist/*.whl"
+depends-on = ["dist-pypi"]
+inputs = ["dist/*.whl"]
+
+[feature.tasks-check.tasks.check-twine]
+description = "... check the built distributions for PyPI"
+cmd = "twine check --strict dist/*.whl dist/*.tar.gz"
+depends-on = ["dist-pypi"]
+inputs = ["dist/"]
+
 # watch ########################################################################
 [feature.tasks-dev.tasks.watch]
 description = "watch ALL the things"
@@ -480,9 +526,11 @@ lint = [
   "tasks-lint",
 ]
 docs = ["deps-pip", "deps-docs", "deps-run", "deps-py-max", "deps-build", "tasks-docs"]
+check = ["deps-check", "tasks-check"]
 dev = [
   "deps-atest",
   "deps-build",
+  "deps-check",
   "deps-docs",
   "deps-lint",
   "deps-pip",
@@ -562,6 +610,14 @@ tornado = "*"
 firefox = "128.*"
 geckodriver = "*"
 
+[feature.deps-check.dependencies]
+check-wheel-contents = "*"
+pytest-check-links = "*"
+pytest-html = "*"
+twine = "*"
+vale = "*"
+vale-spelling-aoo-mozilla-en-dict-us = "*"
+
 # tools ########################################################################
 [tool.sphinx]
 author = "{{ ppt.project.authors[0].name }}"
@@ -614,7 +670,6 @@ pygments_light_style = "github-light-colorblind"
 [tool.sphinx.jsonschema_options]
 lift_description = true
 auto_reference = true
-auto_target = true
 lift_definitions = true
 
 ## urljsf

pixi.toml

@@ -47,6 +47,10 @@ Source = "https://github.com/deathbeds/urljsf"
 [tool.flit.sdist]
 include = ["LICENSE"]
 
+# check-wheel-contents #########################################################
+[tool.check-wheel-contents]
+ignore = ["W002"]
+
 # coverage #####################################################################
 [tool.coverage.run]
 disable_warnings = [
@@ -125,6 +129,15 @@ isort.known-first-party = ["urljsf"]
   "UP006",
   "UP035",
 ]
-"scripts/*.py" = ["S603", "T201", "INP001", "ANN401", "S404", "S607", "PLW0108"]
+"scripts/*.py" = [
+  "S603",
+  "T201",
+  "INP001",
+  "ANN401",
+  "S404",
+  "S607",
+  "PLW0108",
+  "RUF017",
+]
 "**/source.py" = ["PLC0415"]
 "atest/**/*.py" = ["INP001", "PLR6301", "T201"]

pyproject.toml

@@ -0,0 +1,120 @@
+"""Prose checks for ``urljsf``."""
+# Copyright (C) urljsf contributors.
+# Distributed under the terms of the Modified BSD License.
+
+from __future__ import annotations
+
+import json
+import subprocess
+import sys
+from pathlib import Path
+from typing import Any
+
+import mistune
+
+HERE = Path(__file__)
+DOCS = HERE.parent.parent
+ROOT = DOCS.parent
+BUILD = ROOT / "build"
+DOCS_BUILD = BUILD / "docs"
+REPORTS = BUILD / "reports"
+VALE_REPORT = REPORTS / "vale.html"
+SRC = ROOT / "src"
+
+ALL_PY = [*SRC.rglob("*.py"), *DOCS.rglob("*.py")]
+ALL_HTML = [*DOCS_BUILD.rglob("*.html")]
+
+CHECK_PATHS = {
+    *sorted(p for p in [*ALL_PY, *ALL_HTML] if "checkpoint" not in str(p)),
+}
+
+VALE_ARGS: list[str | Path] = [
+    "vale",
+    *sorted(CHECK_PATHS),
+    "--output=JSON",
+]
+
+TValeResults = dict[str, list[dict[str, Any]]]
+
+
+def report(raw: TValeResults) -> list[str]:
+    """Filter and report vale findings."""
+    raw = {k: v for k, v in raw.items() if "ipynb_checkpoints" not in k}
+    if not raw:
+        return []
+    lines: list[str] = []
+    widths = [
+        ":" + ("-" * (1 + max(len(r) for r in raw))),
+        (5 * "-") + ":",
+        (7 * "-") + ":",
+        ":" + ("-" * (1 + max(len(line["Match"]) for line in sum(raw.values(), [])))),
+    ]
+
+    def line(*c: str) -> str:
+        return "|".join([
+            "",
+            *[
+                f" {c[i]} ".ljust(len(w))
+                if w.startswith(":")
+                else f" {c[i]} ".rjust(len(w))
+                for i, w in enumerate(widths)
+            ],
+            "",
+        ])
+
+    lines += [
+        line("file", "line", "column", "message"),
+        "|".join(["", *widths, ""]),
+    ]
+
+    for path, findings in raw.items():
+        for found in findings:
+            lines += [line(path, found["Line"], found["Span"][0], found["Match"])]
+
+    md = "\n".join(lines)
+
+    print(md)
+    return lines
+
+
+def write_html(md_lines: list[str]) -> None:
+    """Write out an HTML report."""
+    VALE_REPORT.parent.mkdir(parents=True, exist_ok=True)
+    html = [
+        "<style>",
+        "* {font-family: sans-serif}",
+        "td, th {padding: 0.25em 0.5em;}",
+        "</style>",
+        mistune.html("\n".join(md_lines)),
+    ]
+    VALE_REPORT.write_text("\n".join(html), encoding="utf-8")
+
+
+def main() -> int:
+    """Run the checks."""
+    str_args = [
+        a if isinstance(a, str) else f"{a.relative_to(ROOT)}" for a in VALE_ARGS
+    ]
+    print(">>>", " \\\n\t".join(str_args), flush=True)
+    proc = subprocess.Popen(
+        str_args,
+        encoding="utf-8",
+        cwd=str(ROOT),
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+    out = proc.communicate()[0]
+    raw: TValeResults = json.loads(out)
+    rc = proc.returncode
+    report_lines: list[str] = []
+    if raw:
+        report_lines = report(raw)
+        rc = len(report_lines)
+    summary = f"# {len(raw)} vale issues in {len(CHECK_PATHS)} files"
+    write_html([summary, "", *report_lines])
+    print("\n", summary)
+    return rc
+
+
+if __name__ == "__main__":
+    sys.exit(main())

scripts/vale/check.py

@@ -0,0 +1,90 @@
+__.+__
+_.+_
+--?.+
+.+…
+(all|any|one)Of
+[A-Z]+[\d]+
+[a-zA-Z\d_.]+\(
+\{[A-Z]+\}
+`.*`
+acceptCharset
+addButton
+additionalProperties
+aspirational
+autoComplete
+autocompletion
+behaviour
+Changelog
+className
+cli
+CLI
+CORS
+customizable
+customizations
+deserialized
+docutils
+DOM
+download_filename
+e\.g\.
+enctype
+endmacro
+enum
+extraErrorsBlockSubmit
+focusOnFirstError
+form_data
+form(Context|Data)
+Git(Lab|Hub)
+globals
+i\.e\.
+idPrefix
+idSeparator
+IFrame
+inexhaustive
+JavaScript/HTML
+jinja
+js
+JSON
+jupyak
+light/dark
+linter
+live(Omit|Validate)
+min(Items|Length)
+natively
+no_bootstrap
+non-
+nunjucks
+omitExtraData
+parse/serialize
+patternProperties
+pragma
+prefill
+programmatically
+PyData
+PyPI
+pythonic
+re\)render
+readOnly
+repo/branch
+representer
+RJSF
+Roadmap
+scrollable
+showErrorList
+src
+stylesheet
+submit_button
+tagName
+theming
+TODO
+TOML
+ui
+UI
+ui:.+
+UIOptions
+uniqueItems
+url
+urljsf
+whitespace
+xkcd
+XKCD
+YAML

scripts/vale/config/vocabularies/urljsf/accept.txt

@@ -12,8 +12,8 @@ class InvalidInputError(UrljsfError, ValueError):
 
 
 class InvalidDefinitionError(UrljsfError, ValueError):
-    """No valid defintion."""
+    """No valid definition."""
 
 
 class BadImportError(UrljsfError, ValueError):
-    """An unxpected import."""
+    """An unexpected import."""