Use Terminal lexer for console examples

Author: wouterj

_build/_theme/_exts/symfonycom/sphinx/lexer.py

@@ -0,0 +1,23 @@
+from pygments.lexer import RegexLexer, bygroups, using
+from pygments.token import *
+from pygments.lexers.shell import BashLexer, BatchLexer
+
+class TerminalLexer(RegexLexer):
+    name = 'Terminal'
+    aliases = ['terminal']
+    filenames = []
+
+    tokens = {
+        'root': [
+            ('^\$', Generic.Prompt, 'bash-prompt'),
+            ('^[^\n>]+>', Generic.Prompt, 'dos-prompt'),
+            ('^#.+$', Comment.Single),
+            ('^.+$', Generic.Output),
+        ],
+        'bash-prompt': [
+            ('(.+)$', bygroups(using(BashLexer)), '#pop')
+        ],
+        'dos-prompt': [
+            ('(.+)$', bygroups(using(BatchLexer)), '#pop')
+        ],
+    }

_build/conf.py

@@ -24,6 +24,7 @@
 from pygments.lexers.special import TextLexer
 from pygments.lexers.text import RstLexer
 from pygments.lexers.web import PhpLexer
+from symfonycom.sphinx.lexer import TerminalLexer
 
 # -- General configuration -----------------------------------------------------
 
@@ -108,6 +109,7 @@
 lexers['rst'] = RstLexer()
 lexers['varnish3'] = CLexer()
 lexers['varnish4'] = CLexer()
+lexers['terminal'] = TerminalLexer()
 
 config_block = {
     'markdown': 'Markdown',

assetic/asset_management.rst

@@ -513,7 +513,7 @@ environment is just too slow.
 Instead, each time you use your application in the ``prod`` environment (and therefore,
 each time you deploy), you should run the following command:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ php app/console assetic:dump --env=prod --no-debug
 
@@ -565,7 +565,7 @@ the following change in your ``config_dev.yml`` file:
 Next, since Symfony is no longer generating these assets for you, you'll
 need to dump them manually. To do so, run the following command:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ php app/console assetic:dump
 
@@ -574,7 +574,7 @@ environment. The big disadvantage is that you need to run this each time
 you update an asset. Fortunately, by using the ``assetic:watch`` command,
 assets will be regenerated automatically *as they change*:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ php app/console assetic:watch
 

assetic/php.rst

@@ -28,7 +28,7 @@ associated libraries. Therefore, before enabling the filters used in this articl
 you must install two libraries. Open a command console, browse to your project
 directory and execute the following commands:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ composer require leafo/scssphp
     $ composer require patchwork/jsqueeze

assetic/uglifyjs.rst

@@ -26,13 +26,13 @@ The global installation method makes all your projects use the very same UglifyJ
 version, which simplifies its maintenance. Open your command console and execute
 the following command (you may need to run it as a root user):
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ npm install -g uglify-js
 
 Now you can execute the global ``uglifyjs`` command anywhere on your system:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ uglifyjs --help
 
@@ -43,7 +43,7 @@ It's also possible to install UglifyJS inside your project only, which is useful
 when your project requires a specific UglifyJS version. To do this, install it
 without the ``-g`` option and specify the path where to put the module:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ cd /path/to/your/symfony/project
     $ npm install uglify-js --prefix app/Resources
@@ -55,7 +55,7 @@ an npm `package.json`_ file and specify your dependencies there.
 Now you can execute the ``uglifyjs`` command that lives in the ``node_modules``
 directory:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ "./app/Resources/node_modules/.bin/uglifyjs" --help
 
@@ -113,7 +113,7 @@ your JavaScripts:
     The path where UglifyJS is installed may vary depending on your system.
     To find out where npm stores the ``bin`` folder, execute the following command:
 
-    .. code-block:: bash
+    .. code-block:: terminal
 
         $ npm bin -g
 
@@ -249,7 +249,7 @@ Install, Configure and Use UglifyCSS
 The usage of UglifyCSS works the same way as UglifyJS. First, make sure
 the node package is installed:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     # global installation
     $ npm install -g uglifycss

best_practices/business-logic.rst

@@ -279,7 +279,7 @@ Data Fixtures
 As fixtures support is not enabled by default in Symfony, you should execute
 the following command to install the Doctrine fixtures bundle:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ composer require "doctrine/doctrine-fixtures-bundle"
 
@@ -316,7 +316,7 @@ Assuming you have at least one fixtures class and that the database access
 is configured properly, you can load your fixtures by executing the following
 command:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ php app/console doctrine:fixtures:load
 

best_practices/creating-the-project.rst

@@ -25,7 +25,7 @@ Now that everything is correctly set up, you can create a new project based on
 Symfony. In your command console, browse to a directory where you have permission
 to create files and execute the following commands:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     # Linux, Mac OS X
     $ cd projects/
@@ -145,7 +145,7 @@ that follows these best practices:
     If your Symfony installation doesn't come with a pre-generated AppBundle,
     you can generate it by hand executing this command:
 
-    .. code-block:: bash
+    .. code-block:: terminal
 
         $ php app/console generate:bundle --namespace=AppBundle --dir=src --format=annotation --no-interaction
 

best_practices/introduction.rst

@@ -74,7 +74,7 @@ best practices in mind. This project, called the Symfony Demo application, can
 be obtained through the Symfony Installer. First, `download and install`_ the
 installer and then execute this command to download the demo application:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     # Linux and Mac OS X
     $ symfony demo

best_practices/templates.rst

@@ -69,7 +69,7 @@ the Markdown contents of each post into HTML.
 To do this, first, install the excellent `Parsedown`_ Markdown parser as
 a new dependency of the project:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ composer require erusev/parsedown
 

bundles.rst

@@ -120,7 +120,7 @@ And while it doesn't do anything yet, AcmeTestBundle is now ready to be used.
 And as easy as this is, Symfony also provides a command-line interface for
 generating a basic bundle skeleton:
 
-.. code-block:: bash
+.. code-block:: terminal
 
     $ php app/console generate:bundle --namespace=Acme/TestBundle