add custom line numbers

README.md

@@ -68,18 +68,20 @@ arrays gets those arrays joined together.
 
 ### Documentation
 
-#### `algorithm(inset: 0.2em, indent: 0.5em, vstroke: 0pt + luma(200), line-numbers: true, ..bits)`
+#### `algorithm(inset: 0.2em, indent: 0.5em, vstroke: 0pt + luma(200), line-numbers: true, line-numbers-format: x => [#x:], ..bits)`
 
 This is the main function of the package. It takes a list of arrays and
 returns a typesetting of the algorithm. You can modify the inset
 between lines with the `inset` parameter.
+If you want to customize line numbers, you can pass a function, that takes a number and returns **content**, to the `line-numbers-format` parameter instead of a default value.
 
 ```typst
 #algorithm(
   inset: 1em, // more spacing between lines
   indent: 0.5em, // indentation for the algorithm
   vstroke: 0pt + luma(200), // vertical stroke for indentation guide
   line-numbers: true, // show line numbers
+  line-numbers-format: x => [#x:], // change the line numbers format
   { // provide an array
     import algorithmic: * // import all names in the array
     Assign[$x$][$y$]
@@ -96,7 +98,7 @@ between lines with the `inset` parameter.
 ```
 ![image of the algorithm with three lines of code assigning x to y, y to x, and z to x + y. The inset is set to 1em, the indent to 0.5em](https://raw.githubusercontent.com/typst-community/typst-algorithmic/refs/tags/v1.0.6/tests/algorithm/ref/1.png)
 
-#### `algorithm-figure(title, supplement: "Algorithm", inset: 0.2em, indent: 0.5em, vstroke: 0pt + luma(200), line-numbers: true, ..bits)`
+#### `algorithm-figure(title, supplement: "Algorithm", inset: 0.2em, indent: 0.5em, vstroke: 0pt + luma(200), line-numbers: true, line-numbers-format: x => [#x:], ..bits)`
 
 The `algorithm-figure` function is a wrapper around `algorithm` that returns a
 figure element of the algorithm. It takes the same parameters as

algorithmic.typ

@@ -62,6 +62,7 @@
   indent: 0.5em,
   vstroke: 0pt + luma(200),
   line-numbers: true,
+  line-numbers-format: x => [#x:],
   horizontal-offset: 1.63640em,
   ..bits,
 ) = {
@@ -86,7 +87,9 @@
   }
 
   while line-number <= content.len() {
-    if line-numbers { grid-bits.push([#line-number:]) }
+    if line-numbers {
+      grid-bits.push(line-numbers-format(line-number))
+    }
     grid-bits = grid-bits + indent-content.at(line-number - 1)
     grid-bits.push(grid.cell(
       content.at(line-number - 1).line-content,
@@ -110,6 +113,7 @@
   indent: 0.5em,
   vstroke: 0pt + luma(200),
   line-numbers: true,
+  line-numbers-format: x => [#x:],
   horizontal-offset: 1.63640em,
   ..bits,
 ) = {
@@ -122,6 +126,7 @@
       inset: inset,
       vstroke: vstroke,
       line-numbers: line-numbers,
+      line-numbers-format: line-numbers-format,
       horizontal-offset: horizontal-offset,
       ..bits,
     ),

tests/line-numbers-format/.gitignore

@@ -0,0 +1,4 @@
+# generated by tytanic, do not edit
+
+diff/**
+out/**

tests/line-numbers-format/test.typ

@@ -0,0 +1,13 @@
+#import "../../algorithmic.typ"
+#import algorithmic: *
+#set page(margin: .1cm, width: 2cm, height: auto)
+
+#algorithm(
+  line-numbers-format: num => str(num) + "|",
+  {
+    import algorithmic: *
+    for i in range(1, 5) {
+      Assign($y$, str(i))
+    }
+  },
+)