39 add option to only show specific lines

README.md

@@ -61,6 +61,7 @@ Example:
 Parameters:
 * `lang`: (Optional) One of the [supported languages]. Only necessary if the language is not detected from the file extension.
 * `line`: (Optional) Show line numbers.
+* `specificLines`: (Optional) Show only specific lines. Can be a single line number or a range separated with a hyphen (-). Multiple line numbers or ranges can be separated by commas.
 
 Examples:
 
@@ -74,6 +75,11 @@ Render PHP file with line numbers:
 {{#embed:https://example.com/fluffy/kittens.php|lang=php|line}}
 ```
 
+Render PHP file with specific lines:
+```
+{{#embed:https://example.com/fluffy/kittens.php|lang=php|specificLines=1-3,8}}
+```
+
 ### Refreshing external content
 
 To refresh all the pages containing one of the parser functions added by this extension, run

extension.json

@@ -74,7 +74,8 @@
 			"es6": true,
 			"scripts": [
 				"prism/prism.js",
-				"bitbucket-edit.js"
+				"bitbucket-edit.js",
+				"code-specific-lines.js"
 			]
 		},
 		"ext.external-content.code-renderer.styles": {

resources/code-renderer.css

@@ -21,11 +21,25 @@ pre[class*="language-"] {
 
 .line-numbers .line-numbers-rows {
 	background-color: #f0f0f0;
-	margin: -1em 0;
+	margin: -1.15em 0;
 	padding: 1em 0;
 	border-right: 1px solid #eaecf0;
 }
 
 .line-numbers-rows > span::before {
 	color: #72777d;
 }
+
+.hide-line {
+    display: none;
+}
+
+.line-numbers-rows .hide-line,
+.line-numbers-rows .hide-line:before {
+	display: block;
+    height: 0px;
+    font-size: 1px;
+    background: #f0f0f0 !important;
+    color: #f0f0f0 !important;
+    text-shadow: none;
+}

resources/code-specific-lines.js

@@ -0,0 +1,47 @@
+Prism.hooks.add( 'complete', function ( env ) {
+    var showLineRanges = env.element.parentElement.getAttribute( 'data-show-lines' );
+
+    if (showLineRanges) {
+        var showLines = [];
+
+        showLineRanges.replace( /\s+/g, '' ).split( ',' ).filter( Boolean ).forEach( function ( currentRange ) {
+            if (currentRange.includes( '-' )) {
+                var range = currentRange.split( '-' );
+
+                if ( range[0] > range[1] ) {
+                    [range[0], range[1]] = [range[1], range[0]];
+                }
+
+                for ( var counter = range[0]; counter <= range[1]; counter++ ) {
+                    showLines.push( Number( counter ) );
+                }
+            }
+            else {
+                showLines.push( Number( currentRange ) );
+            }
+        });
+
+        var tokenList = env.element.querySelector( '.token' ).innerHTML.split( /\n(?!$)/g );
+
+        var lineNumbersActive = Prism.util.isActive(env.element, 'line-numbers');
+
+        if ( lineNumbersActive ) {
+            var lineNumberRows = env.element.querySelectorAll( '.line-numbers-rows span' );
+        }
+
+        tokenList.forEach ( function( value, index ) {
+            if ( showLines.includes ( index + 1 ) ) {
+                tokenList[index] += '\n';
+            }
+            else {
+                tokenList[index] = '<span class="hide-line">' + value + '</span>';
+
+                if ( lineNumbersActive ) {
+                    lineNumberRows[index].classList.add( 'hide-line' );
+                }
+            }
+        });
+
+        env.element.querySelector( '.token' ).innerHTML = tokenList.join( '' );
+    }
+});

src/Domain/ContentRenderer/CodeRenderer.php

@@ -12,6 +12,7 @@ class CodeRenderer implements ContentRenderer {
 	public function __construct(
 		private string $language,
 		private bool $showLineNumbers,
+		private string $showSpecificLines,
 		private bool $showEditButton = false
 	) {
 	}
@@ -56,6 +57,10 @@ private function getWrapperAttributes( string $contentUrl ): array {
 
 		$attributes['class'] = $this->getWrapperClasses();
 
+		if ( !empty( $this->showSpecificLines ) ) {
+			$attributes['data-show-lines'] = $this->showSpecificLines;
+		}
+
 		$attributes['data-toolbar-order'] = 'copy-to-clipboard';
 
 		if ( $this->showEditButton == true ) {

src/Domain/ContentRenderer/RendererConfig.php

@@ -10,6 +10,7 @@ public function __construct(
 		public string $fileExtension,
 		public string $language,
 		public bool $showLineNumbers,
+		public string $showSpecificLines,
 		public bool $showEditButton = false
 	) {
 	}

src/Domain/WikiContentRendererFactory.php

@@ -15,6 +15,7 @@ public function createContentRenderer( RendererConfig $config ): ContentRenderer
 			return new CodeRenderer(
 				language: $config->language,
 				showLineNumbers: $config->showLineNumbers,
+				showSpecificLines: $config->showSpecificLines,
 				showEditButton: $config->showEditButton
 			);
 		}
@@ -27,6 +28,7 @@ public function createContentRenderer( RendererConfig $config ): ContentRenderer
 		return new CodeRenderer(
 			language: $config->fileExtension, // TODO: Use an extension-to-language map, although common extensions already work.
 			showLineNumbers: $config->showLineNumbers,
+			showSpecificLines: $config->showSpecificLines,
 			showEditButton: $config->showEditButton
 
 		);

src/UseCases/Embed/EmbedRequest.php

@@ -10,6 +10,7 @@ public function __construct(
 		public string $fileUrl,
 		public ?string $language,
 		public ?bool $showLineNumbers,
+		public ?string $showSpecificLines,
 		public bool $showEditButton = false
 	) {
 	}

src/UseCases/Embed/EmbedRequestBuilder.php

@@ -14,11 +14,13 @@ public static function argumentsToRequest( array $arguments, bool $showEditButto
 
 		$language = $normalizedArguments['lang'] ?? null;
 		$line = $normalizedArguments['line'] ?? null;
+		$specificLines = $normalizedArguments['specificLines'] ?? null;
 
 		return new EmbedRequest(
 			fileUrl: $arguments[0],
 			language: is_string( $language ) ? $language : null,
 			showLineNumbers: is_bool( $line ) ? $line : null,
+			showSpecificLines: is_string( $specificLines ) ? $specificLines : null,
 			showEditButton: $showEditButton
 		);
 	}

src/UseCases/Embed/EmbedUseCase.php

@@ -79,6 +79,7 @@ private function createRendererConfig( EmbedRequest $request ): RendererConfig {
 			),
 			language: $request->language ?? '',
 			showLineNumbers: $request->showLineNumbers ?? false,
+			showSpecificLines: $request->showSpecificLines ?? '',
 			showEditButton: $request->showEditButton
 		);
 	}

tests/Integration/Domain/CodeRendererTest.php

@@ -15,35 +15,35 @@ class CodeRendererTest extends TestCase {
 	public function testRendersSimplePhpWithoutLineNumbers(): void {
 		$this->assertSame(
 			'<pre class="external-content" data-toolbar-order="copy-to-clipboard"><code class="language-php">print( "Hello world" );</code></pre>',
-			( new CodeRenderer( language: 'php', showLineNumbers: false ) )->render( 'print( "Hello world" );', '' )
+			( new CodeRenderer( language: 'php', showLineNumbers: false, showSpecificLines: '' ) )->render( 'print( "Hello world" );', '' )
 		);
 	}
 
 	public function testRendersSimpleTypescriptWithLineNumbers(): void {
 		$this->assertSame(
 			'<pre class="external-content line-numbers" data-toolbar-order="copy-to-clipboard"><code class="language-typescript">console.log( "Hello world" as string );</code></pre>',
-			( new CodeRenderer( language: 'typescript', showLineNumbers: true ) )->render( 'console.log( "Hello world" as string );', '' )
+			( new CodeRenderer( language: 'typescript', showLineNumbers: true, showSpecificLines: '' ) )->render( 'console.log( "Hello world" as string );', '' )
 		);
 	}
 
 	public function testRendersEscapedHtml(): void {
 		$this->assertSame(
 			'<pre class="external-content" data-toolbar-order="copy-to-clipboard"><code class="language-html">&lt;script>alert( "HAX" );&lt;/script></code></pre>',
-			( new CodeRenderer( language: 'html', showLineNumbers: false ) )->render( '<script>alert( "HAX" );</script>', '' )
+			( new CodeRenderer( language: 'html', showLineNumbers: false, showSpecificLines: '' ) )->render( '<script>alert( "HAX" );</script>', '' )
 		);
 	}
 
 	public function testRendersEscapedHtmlWithWrongLanguage(): void {
 		$this->assertSame(
 			'<pre class="external-content" data-toolbar-order="copy-to-clipboard"><code class="language-javascript">&lt;script>alert( "HAX" );&lt;/script></code></pre>',
-			( new CodeRenderer( language: 'javascript', showLineNumbers: false ) )->render( '<script>alert( "HAX" );</script>', '' )
+			( new CodeRenderer( language: 'javascript', showLineNumbers: false, showSpecificLines: '' ) )->render( '<script>alert( "HAX" );</script>', '' )
 		);
 	}
 
 	public function testRendersEscapedPartialHtml(): void {
 		$this->assertSame(
 			'<pre class="external-content" data-toolbar-order="copy-to-clipboard"><code class="language-html">&lt;/code>&lt;/pre>FOO</code></pre>',
-			( new CodeRenderer( language: 'html', showLineNumbers: false ) )->render( '</code></pre>FOO', '' )
+			( new CodeRenderer( language: 'html', showLineNumbers: false, showSpecificLines: '' ) )->render( '</code></pre>FOO', '' )
 		);
 	}
 

tests/Unit/Domain/WikiContentRendererFactoryTest.php

@@ -20,59 +20,64 @@ public function testMarkdownFileAndConfigWithoutLanguageCreatesMarkdownRenderer(
 				new RendererConfig(
 					fileExtension: 'md',
 					language: '',
-					showLineNumbers: false
+					showLineNumbers: false,
+					showSpecificLines: ''
 				)
 			)
 		);
 	}
 
 	public function testConfigWithoutLanguageCreatesCodeRenderer(): void {
 		$this->assertEquals(
-			new CodeRenderer( language: 'php', showLineNumbers: false ),
+			new CodeRenderer( language: 'php', showLineNumbers: false, showSpecificLines: '' ),
 			( new WikiContentRendererFactory() )->createContentRenderer(
 				new RendererConfig(
 					fileExtension: 'php',
 					language: '',
-					showLineNumbers: false
+					showLineNumbers: false,
+					showSpecificLines: ''
 				)
 			)
 		);
 	}
 
 	public function testConfigWithLanguageCreatesCodeRenderer(): void {
 		$this->assertEquals(
-			new CodeRenderer( language: 'php', showLineNumbers: false ),
+			new CodeRenderer( language: 'php', showLineNumbers: false, showSpecificLines: '' ),
 			( new WikiContentRendererFactory() )->createContentRenderer(
 				new RendererConfig(
 					fileExtension: 'php',
 					language: 'php',
-					showLineNumbers: false
+					showLineNumbers: false,
+					showSpecificLines: ''
 				)
 			)
 		);
 	}
 
 	public function testConfigWithLanguageAndLineNumbersCreatesCodeRenderer(): void {
 		$this->assertEquals(
-			new CodeRenderer( language: 'php', showLineNumbers: true ),
+			new CodeRenderer( language: 'php', showLineNumbers: true, showSpecificLines: '' ),
 			( new WikiContentRendererFactory() )->createContentRenderer(
 				new RendererConfig(
 					fileExtension: 'php',
 					language: 'php',
-					showLineNumbers: true
+					showLineNumbers: true,
+					showSpecificLines: ''
 				)
 			)
 		);
 	}
 
 	public function testConfigWithMarkdownLanguageCreatesCodeRenderer(): void {
 		$this->assertEquals(
-			new CodeRenderer( language: 'md', showLineNumbers: false ),
+			new CodeRenderer( language: 'md', showLineNumbers: false, showSpecificLines: '' ),
 			( new WikiContentRendererFactory() )->createContentRenderer(
 				new RendererConfig(
 					fileExtension: 'md',
 					language: 'md',
-					showLineNumbers: false
+					showLineNumbers: false,
+					showSpecificLines: ''
 				)
 			)
 		);

tests/Unit/UseCases/Embed/EmbedUseCaseTest.php

@@ -69,7 +69,8 @@ private function createRequest( string $fileUrl ): EmbedRequest {
 		return new EmbedRequest(
 			fileUrl: $fileUrl,
 			language: '',
-			showLineNumbers: false
+			showLineNumbers: false,
+			showSpecificLines: ''
 		);
 	}