readability-cli 0.10.5__tar.gz → 0.10.6__tar.gz

{readability_cli-0.10.5 → readability_cli-0.10.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: readability-cli
-Version: 0.10.5
+Version: 0.10.6
 Summary: A CLI to lint, format, and type-check code with Google-style defaults, and pull Google style guides in markdown format.
 Project-URL: Homepage, https://github.com/owahltinez/readability
 Project-URL: Repository, https://github.com/owahltinez/readability
@@ -8,7 +8,6 @@ License-File: LICENSE
 Requires-Python: >=3.12
 Requires-Dist: click>=8.3.1
 Provides-Extra: sync
-Requires-Dist: beautifulsoup4>=4.14.3; extra == 'sync'
 Requires-Dist: markdownify>=1.2.2; extra == 'sync'
 Requires-Dist: requests>=2.33.0; extra == 'sync'
 Description-Content-Type: text/markdown

{readability_cli-0.10.5 → readability_cli-0.10.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "readability-cli"
-version = "0.10.5"
+version = "0.10.6"
 description = "A CLI to lint, format, and type-check code with Google-style defaults, and pull Google style guides in markdown format."
 readme = "README.md"
 requires-python = ">=3.12"
@@ -11,7 +11,6 @@ dependencies = [
 # Only `sync` fetches and converts guides; the rest reads bundled copies.
 [project.optional-dependencies]
 sync = [
-    "beautifulsoup4>=4.14.3",
     "markdownify>=1.2.2",
     "requests>=2.33.0",
 ]

{readability_cli-0.10.5 → readability_cli-0.10.6}/readability/guide.py

@@ -5,7 +5,6 @@ from importlib.resources import files
 import logging
 import os
 import types
-import warnings
 
 import click
 
@@ -13,22 +12,19 @@ logger = logging.getLogger("readability")
 
 
 @functools.cache
-def load_sync_deps() -> tuple[
-    types.ModuleType, types.ModuleType, types.ModuleType
-]:
+def load_sync_deps() -> tuple[types.ModuleType, types.ModuleType]:
     """Imports the libraries only the guide refresh needs.
 
     Guides ship pre-converted, so this stack stays out of the default
     install rather than charging every user for `sync`.
 
     Returns:
-        The requests, bs4, and markdownify modules.
+        The requests and markdownify modules.
 
     Raises:
         click.ClickException: If the sync extra is not installed.
     """
     try:
-        import bs4  # noqa: PLC0415
         import markdownify  # noqa: PLC0415
         import requests  # noqa: PLC0415
     except ImportError as e:
@@ -37,8 +33,7 @@ def load_sync_deps() -> tuple[
             "with: pip install 'readability-cli[sync]'"
         ) from e
 
-    warnings.filterwarnings("ignore", category=bs4.XMLParsedAsHTMLWarning)
-    return requests, bs4, markdownify
+    return requests, markdownify
 
 
 def get_guides_dir() -> str:
@@ -60,22 +55,22 @@ LANGUAGE_MAP = {
     "objc": "objcguide.md",
     "objective-c": "objcguide.md",
     "r": "Rguide.md",
-    "csharp": "csharp-style.md",
-    "c#": "csharp-style.md",
+    "csharp": "csharpguide.md",
+    "c#": "csharpguide.md",
     "docguide": "docguide/style.md",
     "markdown": "docguide/style.md",
     "go": "go/guide.md",
     "cpp": "cppguide.html",
     "c++": "cppguide.html",
     "java": "javaguide.html",
-    "js": "jsguide.html",
-    "javascript": "jsguide.html",
+    "js": "jsguide.md",
+    "javascript": "jsguide.md",
     "ts": "tsguide.html",
     "typescript": "tsguide.html",
-    "html": "htmlcssguide.html",
-    "css": "htmlcssguide.html",
-    "json": "jsoncstyleguide.xml",
-    "vim": "vimscriptguide.xml",
+    "html": "htmlcssguide.md",
+    "css": "htmlcssguide.md",
+    "json": "jsoncguide.md",
+    "vim": "vimscriptguide.md",
 }
 
 BASE_URL = "https://google.github.io/styleguide/"
@@ -96,7 +91,7 @@ def get_guide_content(url: str) -> str:
     Raises:
         click.ClickException: If the HTTP request fails.
     """
-    requests, _, _ = load_sync_deps()
+    requests, _ = load_sync_deps()
     logger.info("Fetching style guide from %s", url)
 
     try:
@@ -121,66 +116,12 @@ def convert_to_markdown(content: str, filename: str) -> str:
     Returns:
         The converted markdown content.
     """
-    _, bs4, markdownify = load_sync_deps()
+    _, markdownify = load_sync_deps()
     logger.debug("Converting content for %s", filename)
 
     if filename.endswith(".md"):
         return content
 
-    # Strip XML prologue if present to avoid it leaking into the output
-    if content.lstrip().startswith("<?xml"):
-        content = content.split("?>", 1)[-1].lstrip()
-
-    # The Vim script and JSON guides are only published as XML
-    if filename.endswith(".xml"):
-        soup = bs4.BeautifulSoup(content, "html.parser")
-
-        guide = soup.find("guide")
-        if guide:
-            title = guide.get("title")
-            if isinstance(title, str) and title:
-                h1 = soup.new_tag("h1")
-                h1.string = title
-                guide.insert(0, h1)
-
-        for category in soup.find_all("category"):
-            title = category.get("title")
-            if isinstance(title, str) and title:
-                h2 = soup.new_tag("h2")
-                h2.string = title
-                category.insert(0, h2)
-
-        for sp in soup.find_all("stylepoint"):
-            title = sp.get("title")
-            if isinstance(title, str) and title:
-                h3 = soup.new_tag("h3")
-                h3.string = title
-                sp.insert(0, h3)
-
-        for summary in soup.find_all("summary"):
-            summary.name = "p"
-            content_str = summary.decode_contents()
-            summary.clear()
-            strong = soup.new_tag("strong")
-            strong.append(bs4.BeautifulSoup(content_str, "html.parser"))
-            summary.append(strong)
-
-        for snippet in soup.find_all(["code_snippet", "bad_code_snippet"]):
-            is_bad = snippet.name == "bad_code_snippet"
-            snippet.name = "pre"
-            code = soup.new_tag("code")
-            code.string = snippet.get_text()
-            snippet.clear()
-            if is_bad:
-                p = soup.new_tag("p")
-                strong = soup.new_tag("strong")
-                strong.string = "BAD:"
-                p.append(strong)
-                snippet.append(p)
-            snippet.append(code)
-
-        return markdownify.markdownify(str(soup), **MARKDOWNIFY_OPTIONS)
-
     if filename.endswith(".html"):
         return markdownify.markdownify(content, **MARKDOWNIFY_OPTIONS)
 

{readability_cli-0.10.5 → readability_cli-0.10.6}/readability/guides/Rguide.md

@@ -11,6 +11,15 @@ were developed in collaboration with the internal R user community. The rest of
 this document explains Google's primary differences with the Tidyverse guide,
 and why these differences exist.
 
+Google uses the [styler](https://github.com/r-lib/styler) package on every
+checked in file to ensure code consistency and help reviewers focus on more
+important issues.
+
+<!-- mdformat off -->
+* TOC
+{:toc}
+<!-- mdformat on -->
+
 ## Syntax
 
 ### Naming conventions
@@ -18,8 +27,9 @@ and why these differences exist.
 Google prefers identifying functions with `BigCamelCase` to clearly distinguish
 them from other objects.
 
-```
-# Good
+<div class='goodcode'></div>
+
+```r
 DoNothing <- function() {
   return(invisible(NULL))
 }
@@ -28,8 +38,9 @@ DoNothing <- function() {
 The names of private functions should begin with a dot. This helps communicate
 both the origin of the function and its intended use.
 
-```
-# Good
+<div class='goodcode'></div>
+
+```r
 .DoNothingPrivately <- function() {
   return(invisible(NULL))
 }
@@ -48,8 +59,9 @@ The possibilities for creating errors when using `attach()` are numerous.
 
 We do not support using right-hand assignment.
 
-```
-# Bad
+<div class='badcode'></div>
+
+```r
 iris %>%
   dplyr::summarize(max_petal = max(Petal.Width)) -> results
 ```
@@ -64,13 +76,17 @@ lines).
 Do not rely on R's implicit return feature. It is better to be clear about your
 intent to `return()` an object.
 
-```
-# Good
+<div class='goodcode'></div>
+
+```r
 AddValues <- function(x, y) {
   return(x + y)
 }
+```
 
-# Bad
+<div class='badcode'></div>
+
+```r
 AddValues <- function(x, y) {
   x + y
 }
@@ -80,8 +96,9 @@ AddValues <- function(x, y) {
 
 Users should explicitly qualify namespaces for all external functions.
 
-```
-# Good
+<div class='goodcode'></div>
+
+```r
 purrr::map()
 ```
 
@@ -95,8 +112,8 @@ understand dependencies in your code. There are some exceptions to this rule.
 *   Infix functions (`%name%`) always need to be imported.
 *   Certain `rlang` pronouns, notably `.data`, need to be imported.
 *   Functions from default R packages, including `datasets`, `utils`,
-   `grDevices`, `graphics`, `stats` and `methods`. If needed, you can `@import`
-   the full package.
+    `grDevices`, `graphics`, `stats` and `methods`. If needed, you can `@import`
+    the full package.
 
 When importing functions, place the `@importFrom` tag in the Roxygen header
 above the function where the external dependency is used.
@@ -107,3 +124,9 @@ above the function where the external dependency is used.
 
 All packages should have a package documentation file, in a
 `packagename-package.R` file.
+
+## Errors
+
+### Use of bullets
+
+We prefer ASCII style bullets (`*`) to unicode when producing error messages.