yogsototh/marginalia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a new option to exclude source files from being processed by Marginalia.

Browse source 
The new option is available at the command line with "-e" or "--exclude". It can also be part of the project.clj file via the ":exclude" keyword.

I was requiring this feature because I often have local testing files which I don't want to be included in the documentation.

The new option is quite simple: it simply filter out the files that have been identified by the option out of the "sources" var before it is being used by multidoc! or uberdoc!
This commit is contained in:
Frederick Giasson 2014-12-18 09:35:33 -05:00
parent a21cd992c4
commit c60d731066
2 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -43,6 +43,7 @@ Marginalia accepts options as described below:
* -c --css Additional css resources `<resource1>;<resource2>;...` (if not given will be taken from `project.clj`)
* -j --js Additional javascript resources `<jsfile1>;<jsfile2>;...` (if not given will be taken from `project.clj`)
* -m --multi Generate each namespace documentation as a separate file
* -e --exclude Exclude source file(s) from the document generation process `<file1>;<file2>;...` (if not given will be taken from `project.clj`)
### Maven
@ -119,6 +120,7 @@ Marginalia is...
- [MerelyAPseudonym](https://github.com/MerelyAPseudonym)
- [Ivan](https://github.com/ivantm)
- [benjamin bader](https://github.com/benjamin-bader)
- [Frederick Giasson](https://github.com/fgiasson)
If I've missed your name then please ping me.

23
src/marginalia/core.clj
View file

@ -238,6 +238,17 @@
[(if (= group artifact) artifact (str group "/" artifact))
version])))
(defn source-excluded?
"Check if a source file is excluded from the generated documentation"
[source opts]
(if-not (empty?
(filter #(if (re-find (re-pattern %) source)
true
false)
(-> opts :marginalia :exclude)))
true
false))
(defn run-marginalia
"Default generation: given a collection of filepaths in a project, find the .clj
files at these paths and, if Clojure source files are found:
@ -249,7 +260,7 @@
If no source files are found, complain with a usage message."
[args & [project]]
(let [[{:keys [dir file name version desc deps css js multi leiningen]} files help]
(let [[{:keys [dir file name version desc deps css js multi leiningen exclude]} files help]
(cli args
["-d" "--dir" "Directory into which the documentation will be written" :default "./docs"]
["-f" "--file" "File into which the documentation will be written" :default "uberdoc.html"]
@ -263,7 +274,9 @@
["-j" "--js" "Additional javascript resources <resource1>;<resource2>;...
If not given will be taken from project.clj"]
["-m" "--multi" "Generate each namespace documentation as a separate file" :flag true]
["-l" "--leiningen" "Generate the documentation for a Leiningen project file."])
["-l" "--leiningen" "Generate the documentation for a Leiningen project file."]
["-e" "--exclude" "Exclude source file(s) from the document generation process <resource1>;<resource2>;...
If not given will be taken from project.clj"])
sources (distinct (format-sources (seq files)))
sources (if leiningen (cons leiningen sources) sources)]
(if-not sources
@ -278,6 +291,7 @@
marg-opts (merge-with choose
{:css (when css (.split css ";"))
:javascript (when js (.split js ";"))
:exclude (when exclude (.split exclude ";"))
:leiningen leiningen}
(:marginalia project-clj))
opts (merge-with choose
@ -287,7 +301,10 @@
:dependencies (split-deps deps)
:multi multi
:marginalia marg-opts}
project-clj)]
project-clj)
sources (->> sources
(filter #(not (source-excluded? % opts)))
(into []))]
(println "Generating Marginalia documentation for the following source files:")
(doseq [s sources]
(println " " s))