What are common conventions for using namespaces in Clojure?

by

  1. I guess it’s ok if you think it helps, but many Clojure projects don’t do so — cf. Compojure (using a top-level compojure ns and various compojure.* ns’s for specific functionality), Ring, Leiningen… Clojure itself uses clojure.* (and clojure.contrib.* for contrib libraries), but that’s a special case, I suppose.

  2. Yes! You absolutely must do so, or else Clojure won’t be able to find your namespaces. Also note that you musn’t use the underscore in namespace names or the hyphen in filenames and wherever you use a hyphen in a namespace name, you must use an underscore in the filename (so that the ns my.cool-project is defined in a file called cool_project.clj in a directory called my).

  3. You need to make sure all your stuff is on the classpath, but it doesn’t matter if it’s in a jar, multiple jars, a mixture of jars and directories on the filesystem… As long as it obeys the correct naming conventions (your point no. 2) you should be fine.

    However, do not compile things ahead-of-time if there’s no particular reason to do so — this may prevent your code from being portable across various versions of Clojure without providing any benefits besides a slightly improved loading time.

    You’ll still need to use AOT compilation sometimes, notably in some Java interop scenarios — the documentation of the relevant functions / macros always mentions that. There are examples of things requiring AOT in clojure.contrib; I’ve never needed it, so I can’t provide much in the way of details.

  4. I’d say you should use jars for functional units of code. E.g. Compojure and Ring get packaged as single jars containing many namespaces which together compose the whole package. Also, clojure.contrib is notably packaged as a single jar with multiple unrelated libraries; but that again may be a special case.

    On the other hand, a single jar containing all of your project’s code together with its dependencies might occasionally be useful for deployment. Check out the Leiningen build tool and its ‘uberjar’ facility if you think that sort of thing may be useful to you.

More Related Contents:

  1. Django: “projects” vs “apps”
  2. How to organize large R programs?
  3. Remove namespace prefix while JAXB marshalling
  4. What is namespace pollution?
  5. Swift’s standard library and name collision
  6. Namespacing with IIFE in ES6?
  7. How to make JAXB unmarshaller to ignore prefixes?
  8. “using namespace” in c++ headers [duplicate]
  9. Using std Namespace
  10. How to use jQuery for XML parsing with namespaces
  11. Python ElementTree module: How to ignore the namespace of XML files to locate matching element when using the method “find”, “findall”
  12. Difference between and ? [duplicate]
  13. printf with std::string?
  14. What are inline namespaces for?
  15. There is no Action mapped for namespace [/] and action name [login] associated with context path [/Struts2Test]
  16. type object ‘datetime.datetime’ has no attribute ‘datetime’
  17. Is it bad practice to use a built-in function name as an attribute or method identifier?
  18. Can PHP namespaces contain variables?
  19. Why an unnamed namespace is a “superior” alternative to static? [duplicate]
  20. Are there any Java method ordering conventions? [closed]
  21. Namespace in PHP CodeIgniter Framework
  22. How can I “unuse” a namespace?
  23. Mapping a function on the values of a map in Clojure
  24. PHP namespaces and “use”
  25. Override a function that is imported in a namespace
  26. Python: deleting a class attribute in a subclass
  27. Organising my Python project
  28. Android “tools” namespace in layout xml documentation
  29. Creating a specific XML document using namespaces in C#
  30. Getting “Can’t find the drive. The drive called ‘IIS’ does not exist.”

Leave a Comment