Fix #10: source link template

Author: borkdude

API.md

@@ -21,11 +21,12 @@ API namespace for quickdoc.
 Generate API docs. Options:
   * `:github/repo` -  a link like `https://github.com/borkdude/quickdoc`
   * `:git/branch` - branch name for source links, default to `"main"`
+  * `:source-uri` - source link template. Supports `{row}`, `{end-row}`, `{col}`, `{end-col}`, `{filename}`, `{branch}`.
   * `:outfile` - file where API docs are written, or falsey if you don't need a file. Defaults to `"API.md"`
   * `:source-paths` - sources that are scanned for vars. Defaults to `["src"]`.
   * `:toc` - generate table of contents. Defaults to `true`.
   * `:var-links` - generate links to vars within the same namespace. Defauls to `true`.
   * `:overrides` - overrides in the form `{namespace {:no-doc true var {:no-doc true :doc ...}}}`.
 
   Returns a map containing the generated markdown string under the key `:markdown`.
-<br><sub>[source](https://github.com/borkdude/quickdoc/blob/main/src/quickdoc/api.cljc#L9-L66)</sub>
+<br><sub>[source](https://github.com/borkdude/quickdoc/blob/main/src/quickdoc/api.cljc#L9-L76)</sub>

bb.edn

@@ -1,6 +1,11 @@
-{:pods {clj-kondo/clj-kondo {:version "2022.02.09"}}
+{:pods {clj-kondo/clj-kondo {:version "2022.05.31"}}
  :paths ["src"]
  :tasks {quickdoc {:requires ([quickdoc.api :as api])
                    :task (api/quickdoc {:git/branch "main"
                                         :github/repo "https://github.com/borkdude/quickdoc"
-                                        :toc true})}}}
+                                        :toc true})}
+         test {:requires ([quickdoc.api :as api])
+               :task (api/quickdoc {:git/branch "main"
+                                    :source-uri "https://dev.azure.com/company/_git/project?path={filename}&version=GBmain&_a=contents&line={row}&lineEnd={end-row}&lineStartColumn={col}&lineEndColumn={end-col}&lineStyle=plain"
+                                    :toc true
+                                    :outfile "API2.md"})}}}

src/quickdoc/api.cljc

@@ -10,6 +10,7 @@
   "Generate API docs. Options:
   * `:github/repo` -  a link like `https://github.com/borkdude/quickdoc`
   * `:git/branch` - branch name for source links, default to `\"main\"`
+  * `:source-uri` - source link template. Supports `{row}`, `{end-row}`, `{col}`, `{end-col}`, `{filename}`, `{branch}`.
   * `:outfile` - file where API docs are written, or falsey if you don't need a file. Defaults to `\"API.md\"`
   * `:source-paths` - sources that are scanned for vars. Defaults to `[\"src\"]`.
   * `:toc` - generate table of contents. Defaults to `true`.

src/quickdoc/impl.clj

@@ -25,14 +25,25 @@
     (let [first-sentence (-> (str/split first-line #"\. ") first)]
       (mini-markdown (subs first-sentence 0 (min (count first-sentence) 80))))))
 
-(defn var-source [var {:keys [github/repo git/branch]}]
-  (format
-   "<sub>[source](%s/blob/%s/%s#L%s-L%s)</sub>"
-   repo
-   branch
-   (:filename var)
-   (:row var)
-   (:end-row var)))
+(defn var-source [var {:keys [github/repo git/branch
+                              source-uri]}]
+  (cond repo
+        (format
+         "<sub>[source](%s/blob/%s/%s#L%s-L%s)</sub>"
+         repo
+         branch
+         (:filename var)
+         (:row var)
+         (:end-row var))
+        source-uri
+        (->
+         source-uri
+         (str/replace "{filename}" (:filename var))
+         (str/replace "{branch}" branch)
+         (str/replace "{row}" (str (:row var)))
+         (str/replace "{col}" (str (:col var)))
+         (str/replace "{end-row}" (str (:end-row var)))
+         (str/replace "{end-col}" (str (:end-col var))))))
 
 (defn print-var [var _source {:keys [collapse-vars] :as opts}]
   (when (var-filter var)