Merge pull request #38 from taezaz/move-haskell-tag-aliases-into-new-extension

Move <haskell/> and <hask/> aliases for syntax highlighting into a new extension - remove related logic from LocalSettings.php

Author: hgolden

etc/mediawiki/LocalSettings.php

@@ -246,37 +246,6 @@
 wfLoadExtension( 'SpamBlacklist' );
 wfLoadExtension( 'TitleBlacklist' );
 wfLoadExtension( 'CollapsibleVector' );
-
-# CODE BELOW IS SPECIFIC TO HAWIKI.
-# It should be moved to its own extension.
-#
-# Make <haskell> a synonym for <source lang='haskell'>.
-#
-# The following is pretty hackish, but otherwise we'd have to edit the
-# extension code.
-function haskellKeywordHook( $text, $args = array(), $parser ) {
-  $args["lang"] = "haskell";
-  return SyntaxHighlight_GeSHi::parserHook( $text, $args, $parser );
-}
-
-function haskKeywordHook( $text, $args = array(), $parser ) {
-  $args['lang'] = 'haskell';
-  $args['enclose'] = 'none';
-  $out = SyntaxHighlight_GeSHi::parserHook( $text, $args, $parser );
-  return '<span class="inline-code">' . $out . '</span>';
-}
-
-function addHaskellKeywordHook() {
-  global $wgParser;
-  $wgParser->setHook( 'haskell', 'haskellKeywordHook' );
-  $wgParser->setHook( 'hask', 'haskKeywordHook' );
-  return true;
-}
-
-if ( defined( 'MW_SUPPORTS_PARSERFIRSTCALLINIT' ) ) {
-	$wgHooks['ParserFirstCallInit'][] = 'addHaskellKeywordHook';
-} else {
-	$wgExtensionFunctions[] = 'addHaskellKeywordHook';
-}
+wfLoadExtension( 'SyntaxHighlight_GeSHi_HaskellAlias' )
 
 unset( $wgFooterIcons['poweredby'] );

usr/share/mediawiki/extensions/SyntaxHighlight_GeSHi_HaskellAlias/README.md

@@ -0,0 +1,13 @@
+# Syntax highlighting tag alias for Haskell
+
+This extension adds ability to use `<haskell></haskell>` and `<hask></hask>` to highlight blocks of Haskell code.
+The functionality of this extension relies on SyntaxHighlight_GeSHi module.
+
+## Running the tests
+
+The extension contains standard Mediawiki parser tests placed in tests/parser/parserTests.txt directory.
+
+To execute them, run this command in the root directory of your Mediawiki installation:
+```
+php tests/parser/parserTests.php --file={your_extensions_directory_path}/SyntaxHighlight_GeSHi_HaskellAlias/tests/parser/parserTests.txt
+```

usr/share/mediawiki/extensions/SyntaxHighlight_GeSHi_HaskellAlias/extension.json

@@ -0,0 +1,21 @@
+{
+  "name": "SyntaxHighlight_GeSHi_HaskellAlias",
+  "author": "Tomas Račys",
+  "url": "https://github.com/haskell/haskell-wiki-configuration",
+  "description": "This extension adds support for <haskell/> and <hask/> tags to enable Haskell code syntax highlighting",
+  "version": "1.0",
+  "license-name": "GPL-2.0-or-later",
+  "type": "parserhook",
+  "requires": {
+    "MediaWiki": ">= 1.31"
+  },
+  "AutoloadClasses": {
+    "SyntaxHighlightHaskellAliasHooks": "includes/SyntaxHighlightHaskellAlias.php"
+  },
+  "Hooks": {
+    "ParserFirstCallInit": [
+      "SyntaxHighlightHaskellAliasHooks::onParserFirstCallInit"
+    ]
+  },
+  "manifest_version": 1
+}

usr/share/mediawiki/extensions/SyntaxHighlight_GeSHi_HaskellAlias/includes/SyntaxHighlightHaskellAlias.php

@@ -0,0 +1,25 @@
+<?php
+
+class SyntaxHighlightHaskellAliasHooks
+{
+    public static function onParserFirstCallInit(Parser &$parser)
+    {
+        $parser->setHook('haskell', [self::class, 'haskellKeywordHook']);
+        $parser->setHook('hask', [self::class, 'haskKeywordHook']);
+    }
+
+    public static function haskellKeywordHook($text, $args = array(), $parser)
+    {
+        $args['lang'] = 'haskell';
+        return SyntaxHighlight_GeSHi::parserHook($text, $args, $parser);
+    }
+
+    public static function haskKeywordHook($text, $args = array(), $parser)
+    {
+        $args['lang'] = 'haskell';
+        $args['enclose'] = 'none';
+        $out = SyntaxHighlight_GeSHi::parserHook($text, $args, $parser);
+        return '<span class="inline-code">' . $out . '</span>';
+    }
+}
+

usr/share/mediawiki/extensions/SyntaxHighlight_GeSHi_HaskellAlias/tests/parser/parserTests.txt

@@ -0,0 +1,35 @@
+!! hooks
+haskell
+hask
+!! endhooks
+
+!! test
+Check that the code that is placed inside <haskell/> element is correctly
+highlighted using Haskell syntax highlighting and is displayed on multiple lines.
+!!input
+<haskell>
+module Main (main) where
+
+main :: IO ()
+main = putStrLn "Hello, World!"
+</haskell>
+!! result
+<div class="mw-highlight mw-content-ltr" dir="ltr"><pre><span></span><span class="kr">module</span> <span class="nn">Main</span> <span class="p">(</span><span class="nf">main</span><span class="p">)</span> <span class="kr">where</span>
+
+<span class="nf">main</span> <span class="ow">::</span> <span class="kt">IO</span> <span class="nb">()</span>
+<span class="nf">main</span> <span class="ow">=</span> <span class="n">putStrLn</span> <span class="s">&quot;Hello, World!&quot;</span>
+</pre></div>
+
+!! end
+
+!! test
+Check that the code that is placed inside <hask/> element is correctly
+highlighted using Haskell syntax highlighting and is displayed on a single line.
+!!input
+<hask>
+repeat n t = take t $ cycle [n]
+</hask>
+!! result
+<p><span class="inline-code"><code class="mw-highlight" dir="ltr"><span class="nf">repeat</span> <span class="n">n</span> <span class="n">t</span> <span class="ow">=</span> <span class="n">take</span> <span class="n">t</span> <span class="o">$</span> <span class="n">cycle</span> <span class="p">[</span><span class="n">n</span><span class="p">]</span></code></span>
+</p>
+!! end