dakrone / lein-bikeshed

A Leiningen plugin designed to tell you your code is bad, and that you should feel bad
176 stars 23 forks source link

Why does bikeshed merge other profiles? #41

Open camsaul opened 5 years ago

camsaul commented 5 years ago

My project.clj looked something like:

(defproject my-project "1.0.0-SNAPSHOT"
  :aliases
  {"bikeshed" ["with-profile" "+bikeshed" "bikeshed"]}

  :bikeshed
   {:plugins [[lein-bikeshed "0.4.1"]]})

and I was super confused when Bikeshed started failing after I added a :source-paths ["test"] to a completely unrelated profile in my project.clj:

(defproject my-project "1.0.0-SNAPSHOT"
  :aliases
  {"bikeshed" ["with-profile" "+bikeshed" "bikeshed"]}

  :bikeshed
  {:plugins [[lein-bikeshed "0.4.1"]]}

  :with-tests-in-source
  {:source-paths ["test"]})

I tried changing adding :source-paths ^:replace ["src"] to the :bikeshed profile but that didn't fix it either:

(defproject my-project "1.0.0-SNAPSHOT"
  :aliases
  {"bikeshed" ["with-profile" "+bikeshed" "bikeshed"]}

  :bikeshed
  {:plugins [[lein-bikeshed "0.4.1"]]
   :source-paths ^:replace ["src"]}

  :with-tests-in-source
  {:source-paths ["test"]})

I ended up having to go thru the lein-bikeshed source to work out what was going on and fixed it by adding --exclude-profiles to the alias.

I have a couple questions:

  1. Is this expected behavior? It seems like it must be, because the --exclude-profiles option exists, but it seems sort of weird and unlike every other Leiningen plugin I can think of.
  2. If it's not expected behavior (or it doesn't make sense anymore) I'm happy to submit a PR to fix it
  3. If it is expected behavior, it would be nice to merge the opts and lein-opts map so you can specify :bikeshed {:exclude-profiles [...]} in project.clj instead of having to pass the exclusions list via a command-line arg. I can PR for this as well.
dakrone commented 5 years ago

To be 100% honest, it's been so long that I no longer remember. I might have merged profiles to pick up other required source on any resource paths, but I'm not certain.

If you think there better behavior, I'd be very happy if you opened a PR for it