alysbrooks-public » project-checkup

Location: alysbrooks-public/project-checkup/src/project_checkup/core.clj - annotation

Show More
Commit Description:
Update documentation.
Commit Description:
Update documentation.
References:
r24:e20a271a783f default
File last commit:
r16:aa7d72e858bb 0.1.4 default
Show/Diff file:
Action:
src/project_checkup/core.clj
149 lines | 5.4 KiB | text/x-clojure | ClojureLexer
History | Source | Raw | Download
alys
Initial working version.
 r0 #!/usr/bin/env lumo
(ns project-checkup.core
(:gen-class)
(:require [clojure.java.shell :as shell]
alys
Small style fixes.
 r14 [clojure.string :as string]))
alys
Initial working version.
 r0
alys
Small style fixes.
 r14 (defn get-extension [path]
alys
Add property-based testing (and fix a bug).
 r8 "Extracts the extension of a path.
alys
Small style fixes.
 r14 Returns the extension with the period, e.g., '.txt' because that's the format
alys
Add property-based testing (and fix a bug).
 r8 people are used to seeing extensions in."
(re-find #"\.[a-zA-Z0-9]+$" path))
alys
Initial working version.
 r0
alys
Small style fixes.
 r14 (defn gather-untracked
alys
Add git support.
 r10 [vcs-systems]
"Gather untracked files in Git or Mercurial."
(reduce into [
(if (contains? vcs-systems ".hg")
(string/split (:out (shell/sh "chg" "st" "-u" "-n")) #"\n"))
(if (contains? vcs-systems ".git")
alys
Small style fixes.
 r14 (string/split (:out (shell/sh "git" "ls-files" "--others"
alys
Add git support.
 r10 "--exclude-standard")) #"\n"))]
)
)
alys
Initial working version.
 r0 (defn gather-project-info
alys
Add git support.
 r10 "Creates a dictionary of project information."
alys
Initial working version.
 r0 []
alys
Small style fixes.
 r14 (let [all-files (map str (file-seq (clojure.java.io/file ".")))
alys
Various improvements and refactorings.
 r4 ; files (string/split (:out (shell/sh "hg" "st" "-m" "-a" "-r" "-d" "-c" "-n" )) #"\n")
alys
Add git support.
 r10
files (map #(clojure.string/replace % #"./(.*)" "$1") all-files )
alys
Tidy output.
 r13 ; file-set (set files)
alys
Add git support.
 r10 ;note that using some here means that if both are present, hg is
;ignored:
vcs-systems (set (vector (some #{".git" ".hg"} files))) ]
alys
Small style fixes.
 r14 {:files files
alys
Initial working version.
 r0 :extensions (frequencies (map get-extension files ))
alys
Cleanup.
 r6 :path (System/getProperty "user.dir")
alys
Small style fixes.
 r14 :untracked-files (gather-untracked vcs-systems)
:readme (if-let [filename (some #{"README.md" "README.txt" "README.mkd"} files)] (slurp filename) "")
alys
Cleanup.
 r6 }) )
alys
Initial working version.
 r0
(defn color [color string]
(let [color-sequence (case color
:green "\u001B[32m"
:yellow "\u001B[33m"
:blue "\u001B[34m"
alys
Various improvements and refactorings.
 r4 :red "\u001B[31m"
:cyan "\u001B[36m"
:magenta "\u001B[35m"
alys
Initial working version.
 r0 )
reset "\u001B[m" ]
(str color-sequence string reset)) )
(defn check-vcs [project]
(let [{files :files } project]
alys
Various improvements and refactorings.
 r4 (boolean (some #{".git" ".hg"} files)) ))
alys
Initial working version.
 r0
(defn check-readme [project]
(let [{files :files } project]
alys
Add tests (and bug fix as a result of a test).
 r7 (boolean (some #{"README.md" "README.txt" "README.mkd" "README"} files)) ))
alys
Initial working version.
 r0
(defn check-untracked [project]
(let [{untracked :untracked-files } project]
(= (count untracked) 0)) )
(defn check-taskpaper [project]
alys
Various improvements and refactorings.
 r4 (let [{extensions :extensions files :files } project]
(or (>= (get ".taskpaper" extensions 0) 1)
alys
Small style fixes.
 r14 (some #{"TODO" "TODO.txt" } files))))
alys
Various improvements and refactorings.
 r4
(defn check-readme-placeholders [project]
alys
Add tests (and bug fix as a result of a test).
 r7 (= (count (re-find #"(FIXME|TODO)" (:readme project) )) 0))
alys
Various improvements and refactorings.
 r4
alys
Initial working version.
 r0
alys
Add license check.
 r15 (defn check-license [project]
(let [{files :files } project]
alys
Update version.
 r16 (boolean (some #{"LICENSE" "LICENSE.txt" "LICENSE.md" "LICENSE.mkd"} files))))
alys
Add license check.
 r15
alys
Tidy output.
 r13 (def checks [{:name "Project is checked into revision control"
alys
Initial working version.
 r0 :description ""
:function check-vcs
alys
Small style fixes.
 r14 :level :error
alys
Initial working version.
 r0 :follow-up "Initialize a repository." }
{:name "Always True"
:function #(or true %)
:level :error
:follow-up "This is a bug." }
alys
Tidy output.
 r13 {:name "All files are tracked or ignored"
alys
Initial working version.
 r0 :description ""
:function check-untracked
:level :warning
alys
Add git support.
 r10 :follow-up "Commit or ignore files from 'hg st -u' or 'git ls-files --others --exclude-standard'." }
alys
Tidy output.
 r13 {:name "Project has a todo file"
alys
Initial working version.
 r0 :function check-taskpaper
:description ""
:level :suggestion
alys
Small style fixes.
 r14 :follow-up "Add a todo file using Taskpaper." }
alys
Add license check.
 r15 {:name "Project has a README"
alys
Initial working version.
 r0 :function check-readme
:description "Readme exists"
:level :suggestion
alys
Various improvements and refactorings.
 r4 :follow-up "Add a README." }
{:name "README has no placeholders"
:function check-readme-placeholders
:description "No placeholders in README"
:level :error
:follow-up "Address placeholders or convert them to tasks."
alys
Add license check.
 r15 }
{ :name "Project has a license"
:function check-license
:description "Project has a LICENSE file."
:level :warning ;going with warning because a project might not have a license before release.
:follow-up "Add a license to LICENSE. Consider using https://choosealicense.com/ if you need guidance. " }])
alys
Initial working version.
 r0
(defn perform-check [check project]
(let [{check-name :name function :function follow-up :follow-up
level :level } check
result (function project)
false-color (case level
:suggestion :blue
:warning :yellow
:error :red
alys
Small style fixes.
 r14 :red)
alys
Tidy output.
 r13 prefix (case level
alys
Add license check.
 r15 :suggestion "Suggested "
:warning "Recommended "
:error "Required "
alys
Small style fixes.
 r14 "Follow-up" )]
alys
Initial working version.
 r0 {:name check-name
:result result
alys
Small style fixes.
 r14 :output (if result
(color :green (str "✔" check-name "…passed!"))
(str (color false-color (str "❌" check-name "…failed!")) "\n\t" prefix " Follow up: " follow-up))}))
alys
Initial working version.
 r0
(defn -main
alys
Various improvements and refactorings.
 r4 "Run checks."
alys
Initial working version.
 r0 [& args]
alys
Small style fixes.
 r14 (try
(let [project-info (gather-project-info)]
(doseq [check checks]
(println (:output (perform-check check project-info )))))
(catch Exception ex
(.printStackTrace ex)
(str "caught exception: " (.getMessage ex)))
alys
Add license check.
 r15 (finally (shutdown-agents))))