Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Option to ignore files not in git #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Option to ignore files not in git #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@ Checking for arguments colliding with clojure.core functions.

## Options

| Switches | Default | Desc |
| --------------------------- | ------- | --------------------------- |
| -H, --no-help-me, --help-me | false | Show help |
| -v, --no-verbose, --verbose | false | Display missing doc strings |
| -m, --max-line-length | | Max line length |
| Switches | Default | Desc |
| --------------------------- | ------- | ---------------------------------- |
| -H, --no-help-me, --help-me | false | Show help |
| -v, --no-verbose, --verbose | false | Display missing doc strings |
| -m, --max-line-length | | Max line length |
| -c, --only-git-checked | false | Lint files that are checked in git |

## License

Expand Down
94 changes: 65 additions & 29 deletions src/bikeshed/core.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,34 @@
{(str namespace-name) (and (boolean doc)
(not= "" doc))}))

(defn find-all-files [dirs]
(->> (str "find " dirs " -name " filename-regex)
(clojure.java.shell/sh "bash" "-c")
(:out)
(#(clojure.string/split % #"\n"))))

(defn find-git-checked-files []
(-> (clojure.java.shell/sh "git" "ls-files" "--full-name")
(:out)
(clojure.string/split #"\n")))

(defn find-clojure-files [dirs only-git-checked?]
(let [all-files (find-all-files dirs)]
(if only-git-checked?
(let [git-files (set (find-git-checked-files))]
; All files vector contains absolute file paths, git file vector
; contains paths relative to the git root.
(->> (filter (fn [f] (some #(.endsWith f %) git-files)) all-files)
(clojure.string/join " ")))
(clojure.string/join " " all-files))))

(defn long-lines
"Complain about lines longer than <max-line-length> characters.
max-line-length defaults to 80."
[all-dirs & {:keys [max-line-length] :or {max-line-length 80}}]
[all-files & {:keys [max-line-length] :or {max-line-length 80}}]
(printf "\nChecking for lines longer than %s characters.\n" max-line-length)
(let [max-line-length (inc max-line-length)
cmd (str "find " all-dirs " -name "
filename-regex
cmd (str "echo " all-files
" | xargs egrep -H -n '^.{" max-line-length ",}$'")
out (:out (clojure.java.shell/sh "bash" "-c" cmd))
your-code-is-formatted-wrong (not (blank? out))]
Expand All @@ -110,10 +130,9 @@

(defn trailing-whitespace
"Complain about lines with trailing whitespace."
[all-dirs]
[all-files]
(println "\nChecking for lines with trailing whitespace.")
(let [cmd (str "find " all-dirs " -name "
filename-regex " | xargs grep -H -n '[ \t]$'")
(let [cmd (str "echo " all-files " | xargs grep -H -n '[ \t]$'")
out (:out (clojure.java.shell/sh "bash" "-c" cmd))
your-code-is-formatted-wrong (not (blank? out))]
(if your-code-is-formatted-wrong
Expand All @@ -124,10 +143,10 @@

(defn trailing-blank-lines
"Complain about files ending with blank lines."
[all-dirs]
[all-files]
(println "\nChecking for files ending in blank lines.")
(let [cmd (str "find " all-dirs " -name " filename-regex " "
"-exec tail -1 \\{\\} \\; -print "
(let [cmd (str "files=" all-files "; "
"find $files -exec tail -1 \\{\\} \\; -print "
"| egrep -A 1 '^\\s*$' | egrep 'clj|sql'")
out (:out (clojure.java.shell/sh "bash" "-c" cmd))
your-code-is-formatted-wrong (not (blank? out))]
Expand All @@ -139,9 +158,9 @@

(defn bad-roots
"Complain about the use of with-redefs."
[source-dirs]
[source-files]
(println "\nChecking for redefined var roots in source directories.")
(let [cmd (str "find " source-dirs " -name " filename-regex " | "
(let [cmd (str "echo " source-files " | "
"xargs egrep -H -n '(\\(with-redefs)'")
out (:out (clojure.java.shell/sh "bash" "-c" cmd))
lines (line-seq (BufferedReader. (StringReader. out)))]
Expand All @@ -152,14 +171,23 @@
true)
(println "No with-redefs found."))))

(defn find-clojure-sources-in-dirs
[dirs only-git-checked?]
(let [sources (mapcat #(-> % io/file ns-find/find-clojure-sources-in-dir)
dirs)]
(if only-git-checked?
(let [git-files (set (find-git-checked-files))]
(filter (fn [f] (some #(.endsWith (.getPath f) %) git-files)) sources))
sources)))

(defn missing-doc-strings
"Report the percentage of missing doc strings."
[project verbose]
[project verbose only-git-checked?]
(println "\nChecking whether you keep up with your docstrings.")
(try
(let [source-files (mapcat #(-> % io/file
ns-find/find-clojure-sources-in-dir)
(flatten (get-all project :source-paths)))
(let [source-files (find-clojure-sources-in-dirs
(flatten (get-all project :source-paths))
only-git-checked?)
all-namespaces (->> source-files
(map load-namespace)
(remove nil?))
Expand Down Expand Up @@ -219,12 +247,12 @@
(defn- check-all-arguments
"Check if the arguments for functions collide
with function from clojure/core"
[project]
[project only-git-checked?]
(println "\nChecking for arguments colliding with clojure.core functions.")
(let [core-functions (-> 'clojure.core ns-publics keys)
source-files (mapcat #(-> % io/file
ns-find/find-clojure-sources-in-dir)
(flatten (get-all project :source-paths)))
source-files (find-clojure-sources-in-dirs
(flatten (get-all project :source-paths))
only-git-checked?)
all-publics (mapcat read-namespace source-files)]
(->> all-publics
(map (fn [function]
Expand All @@ -245,20 +273,28 @@
code has been bikeshedded and found wanting."
[project & opts]
(let [options (first opts)
source-dirs (clojure.string/join " " (flatten
source-files (find-clojure-files
(clojure.string/join " "
(flatten
(get-all project :source-paths)))
test-dirs (clojure.string/join " " (:test-paths project))
all-dirs (str source-dirs " " test-dirs)
(:only-git-checked? options))
test-files (find-clojure-files
(clojure.string/join " " (:test-paths project))
(:only-git-checked? options))
all-files (str source-files " " test-files)
long-lines (if (nil? (:max-line-length options))
(long-lines all-dirs)
(long-lines all-dirs
(long-lines all-files)
(long-lines all-files
:max-line-length
(:max-line-length options)))
trailing-whitespace (trailing-whitespace all-dirs)
trailing-blank-lines (trailing-blank-lines all-dirs)
bad-roots (bad-roots source-dirs)
bad-methods (missing-doc-strings project (:verbose options))
bad-arguments (check-all-arguments project)]
trailing-whitespace (trailing-whitespace all-files)
trailing-blank-lines (trailing-blank-lines all-files)
bad-roots (bad-roots source-files)
bad-methods (missing-doc-strings project
(:verbose options)
(:only-git-checked? options))
bad-arguments (check-all-arguments project
(:only-git-checked? options))]
(or bad-arguments
long-lines
trailing-whitespace
Expand Down
7 changes: 5 additions & 2 deletions src/leiningen/bikeshed.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,17 @@
:flag true :default false]
["-m" "--max-line-length" "Max line length"
:default nil
:parse-fn #(Integer/parseInt %)])]
:parse-fn #(Integer/parseInt %)]
["-c" "--only-git-checked" "Only lint files that are checked in git"
:flag true :default false])]
'~project
(when (:help-me opts#)
(println banner#)
(System/exit 0))
(if (bikeshed.core/bikeshed
'~project {:max-line-length (:max-line-length opts#)
:verbose (:verbose opts#)})
:verbose (:verbose opts#)
:only-git-checked? (:only-git-checked opts#)})
(System/exit -1)
(System/exit 0)))
'(do
Expand Down