pygments-shell-console 0.1__tar.gz → 0.2.1__tar.gz

pygments_shell_console-0.2.1/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.3
+Name: pygments-shell-console
+Version: 0.2.1
+Requires-Dist: pygments
+Description-Content-Type: text/markdown
+
+# Pygments Shell Console
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+[![PyPi](https://img.shields.io/badge/pypi-3775A9?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/pygments-shell-console/)
+
+This Pygments plugin adds new lexers for `shellconsole` output.
+
+The lexers are:
+- `ShellConsoleLexer`: Based in [`ShellSessionBaseLexer`](https://github.com/pygments/pygments/blob/master/pygments/lexers/shell.py#L151C7-L151C28),
+    extends its behavior to recognize the prompt elements and highlight them.
+
+    Also, it adds support for highlighting the following commands output:
+    - Uses `DiffLexer` to highlight `diff` and `git diff` output.
+    - `GitStatusLexer`: Adds support for highlighting `git status` output.
+    - `GitShowLexer`: Adds support for highlighting `git show` output.
+    - `GitLogLexer`: Adds support for highlighting `git log` output.
+    - `GitPrettyLogLexer`: Adds support for highlighting `git log` output, following the format:
+        ```
+        log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim white)- %an%C(reset)%C(bold yellow)%d%C(reset)'
+        ```
+
+Examples of the result can be found [here](https://joapuiib.github.io/mkdocs-material-joapuiib/features/code_blocks/#shell-block).

pygments_shell_console-0.2.1/README.md

@@ -0,0 +1,21 @@
+# Pygments Shell Console
+![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
+[![PyPi](https://img.shields.io/badge/pypi-3775A9?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/pygments-shell-console/)
+
+This Pygments plugin adds new lexers for `shellconsole` output.
+
+The lexers are:
+- `ShellConsoleLexer`: Based in [`ShellSessionBaseLexer`](https://github.com/pygments/pygments/blob/master/pygments/lexers/shell.py#L151C7-L151C28),
+    extends its behavior to recognize the prompt elements and highlight them.
+
+    Also, it adds support for highlighting the following commands output:
+    - Uses `DiffLexer` to highlight `diff` and `git diff` output.
+    - `GitStatusLexer`: Adds support for highlighting `git status` output.
+    - `GitShowLexer`: Adds support for highlighting `git show` output.
+    - `GitLogLexer`: Adds support for highlighting `git log` output.
+    - `GitPrettyLogLexer`: Adds support for highlighting `git log` output, following the format:
+        ```
+        log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim white)- %an%C(reset)%C(bold yellow)%d%C(reset)'
+        ```
+
+Examples of the result can be found [here](https://joapuiib.github.io/mkdocs-material-joapuiib/features/code_blocks/#shell-block).

{pygments_shell_console-0.1 → pygments_shell_console-0.2.1}/examples/status.example

@@ -1,5 +1,6 @@
 joapuiib@FP:~/01_introduccio (main) $ echo
 joapuiib@FP:~/01_introduccio (main) $ git status
+hint: Hint
 On branch main
 
 Changes to be committed:

{pygments_shell_console-0.1 → pygments_shell_console-0.2.1}/git_lexer.py

@@ -10,7 +10,13 @@ from pygments.token import STANDARD_TYPES
 
 import re
 
-__all__ = ['GitLexer']
+__all__ = [
+    'GitLexer',
+    'GitStatusLexer',
+    'GitPrettyLogLexer',
+    'GitLogLexer',
+    'GitShowLexer',
+]
 
 STANDARD_TYPES.update({
     Token.Git: 'git',
@@ -19,6 +25,7 @@ STANDARD_TYPES.update({
     Token.Git.CommitDate: 'git-cd',
     Token.Git.CommitMessage: 'git-cm',
     Token.Git.CommitAuthor: 'git-ca',
+    Token.Git.Hint: 'git-hint',
     Token.Git.Refs: 'git-r',
     Token.Git.Untracked: 'git-untr',
     Token.Git.Modified: 'git-mod',
@@ -32,12 +39,23 @@ STANDARD_TYPES.update({
     Token.Git.Refs.Branch: 'git-b',
 })
 
-class GitPrettyLogLexer(Lexer):
+class GitLexer(RegexLexer):
     name = "Git"
     aliases = ["git"]
     filenames = ['*.git']
     version_added = '1.0'
 
+    tokens = {
+        'root': [
+            (r'\n', Whitespace),
+            (r'^hint:(.*?)\n', Token.Git.Hint),
+            (r'^.*$\n', Generic.Output),
+            (r'[^\n]+', Generic.Output),
+        ]
+
+    }
+
+class GitPrettyLogLexer(Lexer):
     _branch_line_rgx = r'([\|\\\/ ]*)'
     _logrgx_groups = [
       _branch_line_rgx,     # 1. Branch line
@@ -111,7 +129,7 @@ class GitStatusLexer(RegexLexer):
             (r'\s*Untracked files:\n', Generic.Output, 'untracked'),
             (r'\s*Changes not staged for commit:\n', Generic.Output, 'modified'),
             (r'\s*Changes to be committed:\n', Generic.Output, 'staged'),
-            (r'^.*\n', Generic.Output),
+            (r'^.*\n', using(GitLexer)),
         ],
         'untracked': [
             (r'^\s*\n', Whitespace, '#pop'),
@@ -147,7 +165,7 @@ class GitLogLexer(RegexLexer):
         'root': [
             (r'^\n', Whitespace),
             (r'^(commit [0-9a-f]+)', Token.Git.Show.Header, 'header'),
-            (r'^.*\n', Generic.Output),
+            (r'^.*\n', using(GitLexer)),
         ],
         'header': [
             (r' +', Whitespace),
@@ -172,3 +190,16 @@ class GitShowLexer(GitLogLexer):
             (r'^.*\n', using(DiffLexer)),
         ],
     }
+
+class GitBranchLexer(RegexLexer):
+    tokens = {
+        'root': [
+            (r'^\n', Whitespace),
+            (r'^(\* )(.*?)(\n)', bygroups(
+                using(GitLexer),
+                Token.Git.Refs.Branch,
+                Whitespace,
+            )),
+            (r'^.*\n', using(GitLexer)),
+        ],
+    }

{pygments_shell_console-0.1 → pygments_shell_console-0.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pygments-shell-console" # change this to a package name for your plugin
-version = "0.1"
+version = "0.2.1"
 dependencies = ["pygments"]
 readme = "README.md"
 

{pygments_shell_console-0.1 → pygments_shell_console-0.2.1}/shellconsole_lexer.py

@@ -8,7 +8,8 @@ from pygments.token import Token, Punctuation, Whitespace, \
 from pygments.lexers.diff import DiffLexer
 from pygments.lexers.shell import BashLexer
 from pygments.lexers.diff import DiffLexer
-from git_lexer import GitLogLexer, GitPrettyLogLexer, GitStatusLexer, GitShowLexer
+from git_lexer import GitLexer, GitLogLexer, GitPrettyLogLexer, \
+    GitStatusLexer, GitShowLexer, GitBranchLexer
 from pygments.token import STANDARD_TYPES
 
 import re
@@ -75,10 +76,12 @@ class ShellConsoleLexer(Lexer):
     def get_tokens_unprocessed(self, text):
         innerlexer = self._innerLexerCls(**self.options)
         difflexer = DiffLexer()
+        gitlexer = GitLexer()
         git_log_lexer = GitLogLexer()
         git_pretty_log_lexer = GitPrettyLogLexer()
         gitstatuslexer = GitStatusLexer()
         gitshowlexer = GitShowLexer()
+        gitbranchlexer = GitBranchLexer()
 
         pos = 0
         # Bash command
@@ -163,6 +166,10 @@ class ShellConsoleLexer(Lexer):
                     custom_lexer = gitstatuslexer
                 elif curcode.startswith('git show'):
                     custom_lexer = gitshowlexer
+                elif curcode.startswith('git branch'):
+                    custom_lexer = gitbranchlexer
+                elif curcode.startswith('git'):
+                    custom_lexer = gitlexer
 
                 output += line
 

{pygments_shell_console-0.1 → pygments_shell_console-0.2.1}/shellconsole_style.py

@@ -18,6 +18,7 @@ class ShellConsoleStyle(Style):
         Token.Git.CommitDate: "#008000",
         Token.Git.CommitMessage: "#FFFFFF",
         Token.Git.CommitAuthor: "#aaaaaa",
+        Token.Git.Hint: "#aaaa00",
 
         Token.Git.Refs: "#00ffff",
         Token.Git.Refs.Tag: "#ffff00",

pygments_shell_console-0.2.1/test/test_git.py

@@ -0,0 +1,73 @@
+import pytest
+from pygments.token import Token
+from shellconsole_lexer import ShellConsoleLexer
+from git_lexer import GitStatusLexer
+
+def test_git_command_with_hint():
+    lexer = ShellConsoleLexer()
+    text = (
+        "user@host:~/directory (main) $ git branch -d desc\n"
+        "error: the branch 'desc' is not fully merged.\n"
+        "hint: If you are sure you want to delete it, run 'git branch -D desc'.\n"
+        "hint: Disable this message with \"git config advice.forceDeleteBranch false\".\n"
+    )
+
+    tokens = list(lexer.get_tokens(text))
+
+    assert tokens == [
+        # Prompt
+        (Token.Generic.Prompt.UserHost, "user@host"),
+        (Token.Generic.Prompt, ":"),
+        (Token.Generic.Prompt.Directory, "~/directory"),
+        (Token.Text.Whitespace, " "),
+        (Token.Generic.Prompt.GitBranch, "(main)"),
+        (Token.Text.Whitespace, " "),
+        (Token.Generic.Prompt, "$"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "git"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "branch"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "-d"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "desc"),
+        (Token.Text.Whitespace, "\n"),
+        # Output
+        (Token.Generic.Output, "error: the branch 'desc' is not fully merged.\n"),
+        (Token.Git.Hint, "hint: If you are sure you want to delete it, run 'git branch -D desc'.\n"),
+        (Token.Git.Hint, "hint: Disable this message with \"git config advice.forceDeleteBranch false\".\n"),
+    ]
+
+def test_git_command_with_empty_hint():
+    lexer = ShellConsoleLexer()
+    text = (
+        "user@host:~/directory $ git init\n"
+        "hint: Using 'master' as the name for the initial branch. This default branch name\n"
+        "hint: is subject to change. To configure the initial branch name to use in all\n"
+        "hint: of your new repositories, which will suppress this warning, call:\n"
+        "hint:\n"
+        "hint:   git config --global init.defaultBranch <name>\n"
+
+    )
+
+    tokens = list(lexer.get_tokens(text))
+
+    assert tokens == [
+        # Prompt
+        (Token.Generic.Prompt.UserHost, "user@host"),
+        (Token.Generic.Prompt, ":"),
+        (Token.Generic.Prompt.Directory, "~/directory"),
+        (Token.Text.Whitespace, " "),
+        (Token.Generic.Prompt, "$"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "git"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "init"),
+        (Token.Text.Whitespace, "\n"),
+        # Output
+        (Token.Git.Hint, "hint: Using 'master' as the name for the initial branch. This default branch name\n"),
+        (Token.Git.Hint, "hint: is subject to change. To configure the initial branch name to use in all\n"),
+        (Token.Git.Hint, "hint: of your new repositories, which will suppress this warning, call:\n"),
+        (Token.Git.Hint, "hint:\n"),
+        (Token.Git.Hint, "hint:   git config --global init.defaultBranch <name>\n"),
+    ]

pygments_shell_console-0.2.1/test/test_git_branch.py

@@ -0,0 +1,35 @@
+import pytest
+from pygments.token import Token
+from shellconsole_lexer import ShellConsoleLexer
+from git_lexer import GitStatusLexer
+
+def test_git_branch():
+    lexer = ShellConsoleLexer()
+    text = (
+        "user@host:~/directory (main) $ git branch\n"
+        "* main\n"
+        "  desc\n"
+    )
+
+    tokens = list(lexer.get_tokens(text))
+
+    assert tokens == [
+        # Prompt
+        (Token.Generic.Prompt.UserHost, "user@host"),
+        (Token.Generic.Prompt, ":"),
+        (Token.Generic.Prompt.Directory, "~/directory"),
+        (Token.Text.Whitespace, " "),
+        (Token.Generic.Prompt.GitBranch, "(main)"),
+        (Token.Text.Whitespace, " "),
+        (Token.Generic.Prompt, "$"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "git"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "branch"),
+        (Token.Text.Whitespace, "\n"),
+        # Output
+        (Token.Generic.Output, "* "),
+        (Token.Git.Refs.Branch, "main"),
+        (Token.Text.Whitespace, "\n"),
+        (Token.Generic.Output, "  desc\n"),
+    ]

{pygments_shell_console-0.1 → pygments_shell_console-0.2.1}/test/test_git_status.py

@@ -175,4 +175,30 @@ def test_git_status_after_empty_command():
         (Token.Generic.Output, "no changes added to commit (use \"git add\" and/or \"git commit -a\")\n"),
     ]
 
+def test_git_status_whit_hint():
+    lexer = ShellConsoleLexer()
+    text = (
+        "user@host:~/directory (main) $ git status\n"
+        "hint: You've added another git status command\n"
+        "On branch main\n"
+    )
+
+    tokens = list(lexer.get_tokens(text))
 
+    assert tokens == [
+        # Prompt
+        (Token.Generic.Prompt.UserHost, "user@host"),
+        (Token.Generic.Prompt, ":"),
+        (Token.Generic.Prompt.Directory, "~/directory"),
+        (Token.Text.Whitespace, " "),
+        (Token.Generic.Prompt.GitBranch, "(main)"),
+        (Token.Text.Whitespace, " "),
+        (Token.Generic.Prompt, "$"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "git"),
+        (Token.Text.Whitespace, " "),
+        (Token.Text, "status"),
+        (Token.Text.Whitespace, "\n"),
+        (Token.Git.Hint, "hint: You've added another git status command\n"),
+        (Token.Generic.Output, "On branch main\n"),
+    ]

pygments_shell_console-0.1/PKG-INFO

@@ -1,15 +0,0 @@
-Metadata-Version: 2.3
-Name: pygments-shell-console
-Version: 0.1
-Requires-Dist: pygments
-Description-Content-Type: text/markdown
-
-# Pygments Shell Console
-
-This Pygments plugin adds new lexers for shell console output. The lexers are:
-- `ShellConsoleLexer`: Based in [`ShellSessionBaseLexer`](https://github.com/pygments/pygments/blob/master/pygments/lexers/shell.py#L151C7-L151C28),
-    extends its behavior to recognize the prompt elements and use `DiffLexer` and `GitLexer` for highlighting.
-- `GitLexer`: Adds support for highlighting git log output, following the format:
-    ```
-    log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim white)- %an%C(reset)%C(bold yellow)%d%C(reset)'
-    ```

pygments_shell_console-0.1/README.md

@@ -1,9 +0,0 @@
-# Pygments Shell Console
-
-This Pygments plugin adds new lexers for shell console output. The lexers are:
-- `ShellConsoleLexer`: Based in [`ShellSessionBaseLexer`](https://github.com/pygments/pygments/blob/master/pygments/lexers/shell.py#L151C7-L151C28),
-    extends its behavior to recognize the prompt elements and use `DiffLexer` and `GitLexer` for highlighting.
-- `GitLexer`: Adds support for highlighting git log output, following the format:
-    ```
-    log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim white)- %an%C(reset)%C(bold yellow)%d%C(reset)'
-    ```