Deprecate Critic view mode (#2796)

* Deprecate Critic view mode

Resolves #2786

* Fix lint

Author: facelessuser

docs/src/markdown/about/changelog.md

@@ -3,6 +3,12 @@ icon: lucide/scroll-text
 ---
 # Changelog
 
+## 10.18
+
+-   **NEW**: Critic: `view` mode has been deprecated. To avoid warnings or future issues, explicitly set `mode` to
+    either `accept` or `reject`. In the future, the new default will be `accept` and the `view` mode will be removed
+    entirely.
+
 ## 10.17.2
 
 -   **FIX**: Blocks: Blocks extensions will now better handle nesting of indented style Admonitions, Details, and Tabbed

docs/src/markdown/extensions/critic.md

@@ -13,6 +13,15 @@ represent edits to a Markdown document.  This extension runs before all other ex
 Critic allows you to automatically accept edits or reject the edits and render the output accordingly. It also allows
 for visually displaying the changes in HTML output ([mileage may vary](#limitations-with-previewing-critic-markup)).
 
+/// warning | Previews Deprecated
+The preview mode has been deprecated, and the default `mode` will be set to `accept` in the future. If you rely on
+Critic, is advised to explicitly set `mode` to either `accept` or `reject` to be protected against any issues related
+to this change in default and removal of the `view` mode in the future.
+
+The `view` mode is being removed simply because support was never that great, and in order to get the quality expected,
+the feature would have to be implemented into the core of Python Markdown, something that is impossible for us to do.
+///
+
 The Critic extension can be included in Python Markdown by using the following:
 
 ```py3

pymdownx/__meta__.py

@@ -193,5 +193,5 @@ def parse_version(ver: str) -> Version:
     return Version(major, minor, micro, release, pre, post, dev)
 
 
-__version_info__ = Version(10, 17, 2, "final")
+__version_info__ = Version(10, 18, 0, "final")
 __version__ = __version_info__._get_canonical()

pymdownx/critic.py

@@ -27,6 +27,7 @@
 from markdown.preprocessors import Preprocessor
 from markdown.postprocessors import Postprocessor
 from markdown.util import STX, ETX
+from .util import warn_deprecated
 import re
 
 SOH = '\u0001'  # start
@@ -294,7 +295,10 @@ def __init__(self, *args, **kwargs):
         """Initialize."""
 
         self.config = {
-            'mode': ['view', "Critic mode to run in ('view', 'accept', or 'reject') - Default: view "],
+            'mode': [
+                'view',
+                "Critic mode to run in: 'view' (deprecated), 'accept' (future default), or 'reject' - Default: view "
+            ],
             'raw_view': [False, "Raw view keeps the output as the raw markup for view mode - Default False"]
         }
 
@@ -308,6 +312,12 @@ def extendMarkdown(self, md):
         post = CriticsPostprocessor(self.critic_stash)
         critic = CriticViewPreprocessor(self.critic_stash)
         critic.config = self.getConfigs()
+        if critic.config['mode'] == 'view':
+            warn_deprecated(
+                "pymdownx.critic has deprecated the 'view' mode and will default the option to 'accept' "
+                "in the future. It is advised to set the 'mode' option explicitly to either 'accept' or "
+                "'reject' to avoid issues when this change takes place."
+            )
         md.preprocessors.register(critic, "critic", 31.1)
         md.postprocessors.register(post, "critic-post", 25)
         md.registerExtensions(["pymdownx._bypassnorm"], {})