cljs_options.clj

(ns figwheel.main.schema.cljs-options
  (:require
   [spell-spec.alpha :as spell]
   [clojure.spec.alpha :as s]
   [figwheel.main.schema.core :refer [def-spec-meta non-blank-string? directory-exists?]
    :as schema]
   [clojure.string :as string]))

;; * Specification for ClojureScript
;; ** Top level util specs

(s/def ::string-or-symbol (s/or
                           :symbol ::schema/unquoted-symbol
                           :string non-blank-string?))

(s/def ::string-or-named  (s/or
                           :symbol ::schema/unquoted-symbol
                           :string non-blank-string?
                           :keyword keyword?))

;; ** CLJS Compiler Options
;; *** Commonly used Compiler Options
;; **** TODO Look at the use of clojure.spec/+

;; The clojure.spec/+ is used in favor of clojure.spec/* below.  The
;; assumption is that we want to look at the indivudiual use cases and
;; decide if an empty expression actually makes sense.

;; This conflates the use case of options compliance and creating a
;; stricter set of options to inform users of possible missuse.

;; I think it's better to have a tighter expression and force folks to
;; remove/comment out no-op configs, to bring awareness to them.
;; Commented out configs are more obvious than no-op ones.

(s/def ::output-to non-blank-string?)

(def-spec-meta ::output-to
  :doc
  "After your ClojureScript has been compiled to JavaScript, this
specifies the name of the JavaScript output file.  The contents of
this file will differ based on the :optimizations setting.

If :optimizations is set to :none then this file will merely contain
the code needed to load Google Closure the and rest of the compiled
namespaces (which are separate files).

If :optimizations is set to :simple, :whitespace, or :advanced this
output file will contain all the compiled code.

  :output-to \"resources/public/js/main.js\"")

(s/def ::output-dir non-blank-string?)

(def-spec-meta ::output-dir
  :doc
  "Sets the output directory for output files generated during
compilation.

Defaults to  \"out\".

  :output-dir \"resources/public/js/out\"")

(s/def ::optimizations #{:none :whitespace :simple :advanced})

(def-spec-meta ::optimizations
  :doc
  "The optimization level. May be :none, :whitespace, :simple, or
:advanced. Only :none and :simple are supported for bootstrapped
ClojureScript.

  :none is the recommended setting for development

  :advanced is the recommended setting for production, unless
        something prevents it (incompatible external library, bug,
        etc.).

For a detailed explanation of the different optimization modes see
https://developers.google.com/closure/compiler/docs/compilation_levels

When the :main option is not used, :none requires manual code loading
and hence a separate HTML from the other options.

Defaults to :none. Note: lein cljsbuild 1.0.5 will supply :whitespace.

  :optimizations :none")

;; TODO should exist!!
(s/def ::main                      ::string-or-symbol)
(def-spec-meta ::main
  :doc
  "Specifies an entry point namespace. When combined with optimization
level :none, :main will cause the compiler to emit a single JavaScript
file that will import goog/base.js, the JavaScript file for the
namespace, and emit the required goog.require statement. This permits
leaving HTML markup identical between dev and production.

Also see :asset-path.

  :main \"example.core\"")

(s/def ::asset-path                string?)
(def-spec-meta ::asset-path
  :doc
  "When using :main it is often necessary to control where the entry
point script attempts to load scripts from due to the configuration of
the web server. :asset-path is a relative URL path not a file system
path. For example, if your output directory is :ouput-dir
\"resources/public/js/compiled/out\" but your webserver is serving files
from \"resources/public\" then you want the entry point script to load
scripts from \"js/compiled/out\".

  :asset-path \"js/compiled/out\"")

(s/def ::source-map                (some-fn boolean? non-blank-string?))
(def-spec-meta ::source-map
  :doc
  "See https://github.com/clojure/clojurescript/wiki/Source-maps. Under
optimizations :none the valid values are true and false, with the
default being true. Under all other optimization settings must specify
a path to where the source map will be written.

Under :simple, :whitespace, or :advanced
  :source-map \"path/to/source/map.js.map\"")

(s/def ::preloads                  (s/every ::schema/unquoted-symbol :min-count 1 :into [] :kind sequential?))
(def-spec-meta ::preloads
  :doc
  "Developing ClojureScript commonly requires development time only
side effects such as enabling printing, logging, spec instrumentation,
and connecting REPLs. :preloads permits loading such side effect
boilerplate right after cljs.core. For example you can make a
development namespace for enabling printing in browsers:

  (ns foo.dev)

  (enable-console-print!)

Now you can configure your development build to load this side effect
prior to your main namespace with the following compiler options:

  {:preloads [foo.dev]
   :main \"foo.core\"
   :output-dir \"out\"}

The :preloads config value must be a sequence of symbols that map to
existing namespaces discoverable on the classpath.")

(s/def ::verbose                   boolean?)
(def-spec-meta ::verbose
  :doc
  "Emit details and measurements from compiler activity.

  :verbose true")

(s/def ::pretty-print              boolean?)
(def-spec-meta ::pretty-print
  :doc
  "Determines whether the JavaScript output will be tabulated in a
human-readable manner. Defaults to true.

  :pretty-print false")

(s/def ::target                    #{:nodejs :webworker})
(def-spec-meta ::target
  :doc
  "If targeting nodejs add this line. Takes no other options at the
moment. The default (no :target specified) implies browsers are being
targeted. Have a look here for more information on how to run your
code in nodejs.

  :target :nodejs")

(s/def ::infer-externs boolean?)
(def-spec-meta ::infer-externs
  :doc
  "Experimental externs inference.

  :infer-externs true

When you set :infer-externs true you will get a new file in
your :output-dir named inferred_externs.js. When you do an advanced
build, this externs file will be used.

You must add type hints to your code as such:

  (set! *warn-on-infer* true)
  (defn foo [^js/React.Component c]
    (.render c))

Please see:
https://gist.github.com/swannodette/4fc9ccc13f62c66456daf19c47692799")

(s/def ::foreign-libs (s/every
                       (spell/keys
                        :req-un [::file]
                        :opt-un [::file-min
                                 ::provides
                                 ::requires
                                 ::module-type
                                 ::preprocess
                                 ::global-exports])
                       :into []
                       :kind sequential?))
(def-spec-meta ::foreign-libs
  :doc
  "Adds dependencies on foreign libraries. Be sure that the url returns a
HTTP Code 200

Defaults to the empty vector []

  :foreign-libs [{ :file \"http://example.com/remote.js\"
                   :provides  [\"my.example\"]}]

Each element in the :foreign-libs vector should be a map, where the
keys have these semantics:

  :file Indicates the URL to the library

  :file-min (Optional) Indicates the URL to the minified variant of
            the library.

  :provides A synthetic namespace that is associated with the library.
            This is typically a vector with a single string, but it
            has the capability of specifying multiple namespaces
            (typically used only by Google Closure libraries).

  :requires (Optional) A vector explicitly identifying dependencies
            (:provides values from other foreign libs); used to form a
            topological sort honoring dependencies.

  :module-type (Optional) indicates that the foreign lib uses a given
               module system. Can be one of :commonjs, :amd, :es6.
               Note that if supplied, :requires is not used (as it is
               implicitly determined).

  :preprocess (Optional) Used to preprocess / transform code in other
              dialects (JSX, etc.). A defmethod for
              cljs.clojure/js-transforms must be provided that matches
              the supplied value in order to effect the desired code
              transformation.

  :global-exports (Optional) used to map provided namespaces to
                  globally exported values. If present the foreign
                  library can be used idiomatically when required,
                  i.e. support for :refer, :rename, :as, etc.")

(s/def ::file        non-blank-string?)
(s/def ::provides    (s/every non-blank-string? :min-count 1 :into [] :kind sequential?))
(s/def ::file-min    non-blank-string?)
(s/def ::requires    (s/every non-blank-string? :min-count 1 :into [] :kind sequential?))
(s/def ::module-type #{:commonjs :amd :es6})
(s/def ::preprocess  ::string-or-named)
(s/def ::global-exports (s/map-of ::string-or-named ::string-or-named))

(s/def ::externs     (s/every non-blank-string? :min-count 1 :into [] :kind sequential?))
(def-spec-meta ::externs
  :doc
  "Configure externs files for external libraries.

For this option, and those below, you can find a very good explanation at:
http://lukevanderhart.com/2011/09/30/using-javascript-and-clojurescript.html

Defaults to the empty vector [].

  :externs [\"jquery-externs.js\"]")

(s/def ::modules (s/map-of
                  keyword?
                  (spell/keys
                   :opt-un [::entries
                            :cljs.options-schema.modules/output-to
                            ::depends-on])))
(def-spec-meta ::modules
  :doc
  "A new option for emitting Google Closure Modules. Closure Modules
supports splitting up an optimized build into N different modules. If
:modules is supplied it replaces the single :output-to. A module needs
a name, an individual :output-to file path, :entries a set of
namespaces, and :depends-on a set of modules on which the module
depends. Modules are only supported with :simple and :advanced
optimizations. An example follows:

  {:optimizations :advanced
   :source-map true
   :output-dir \"resources/public/js\"
   :modules {
     :common
       {:output-to \"resources/public/js/common.js\"
        :entries #{\"com.foo.common\"}}
     :landing
       {:output-to \"resources/public/js/landing.js\"
        :entries #{\"com.foo.landing\"}
        :depends-on #{:common}}
     :editor
       {:output-to \"resources/public/js/editor.js\"
        :entries #{\"com.foo.editor\"}
        :depends-on #{:common}}}}


Any namespaces not in an :entries set will be moved into the default
module :cljs-base. However thanks to cross module code motion, Google
Closure can move functions and methods into the modules where they are
actually used. This process is somewhat conservative so if you know
that you want to keep some code together do this via :entries.

The :cljs-base module defaults to being written out to :output-dir
with the name \"cljs_base.js\". This may be overridden by specifying a
:cljs-base module describing only :output-to.

Take careful note that a namespace may only appear once across all
module :entries.

:modules fully supports :foreign-libs. :foreign-libs are always put
into dependency order before any Google Closure compiled source.

Source maps are fully supported, an individual one will be created for
each module. Just supply :source-map true (see example) as there is no
single source map to name.")


;; ** TODO name collision don't want docs to collide
;; this is the only name collision in this


(s/def :cljs.options-schema.modules/output-dir    non-blank-string?)
(s/def ::entries       (s/every ::string-or-symbol :min-count 1 :into [] :kind  (some-fn sequential? set?)))
(s/def ::depends-on    (s/every ::string-or-named :min-count 1 :into [] :kind (some-fn sequential? set?)))

(s/def ::source-map-path string?)
(def-spec-meta ::source-map-path
  :doc
  "Set the path to source files references in source maps to avoid
further web server configuration.

  :source-map-path \"public/js\"")

(s/def ::source-map-asset-path string?)
(def-spec-meta ::source-map-asset-path
  :doc
  "Provides fine grained control over the sourceMappingURL comment that
is appended to generated JavaScript files when source mapping is enabled.
further web server configuration.

  :source-map-asset-path \"http://foo.com/public/js/out\"")

(s/def ::source-map-timestamp       boolean?)
(def-spec-meta ::source-map-timestamp
  :doc
  "Add cache busting timestamps to source map urls. This is helpful for
keeping source maps up to date when live reloading code.

  :source-map-timestamp true")

(s/def ::cache-analysis             boolean?)
(def-spec-meta ::cache-analysis
  :doc
  "Experimental. Cache compiler analysis to disk. This enables faster
cold build and REPL start up times.

For REPLs, defaults to true. Otherwise, defaults to true if and only
if :optimizations is :none.

  :cache-analysis true")

(s/def ::recompile-dependents       boolean?)
(def-spec-meta ::recompile-dependents
  :doc
  "For correctness the ClojureScript compiler now always recompiles
dependent namespaces when a parent namespace changes. This prevents
corrupted builds and swallowed warnings. However this can impact
compile times depending on the structure of the application. This
option defaults to true.

  :recompile-dependents false")

(s/def ::static-fns                 boolean?)
(def-spec-meta ::static-fns
  :doc
  "Employs static dispatch to specific function arities in emitted
JavaScript, as opposed to making use of the call construct. Defaults
to false except under advanced optimizations. Useful to have set to
false at REPL development to facilitate function redefinition, and
useful to set to true for release for performance.

This setting does not apply to the standard library, which is always
compiled with :static-fns implicitly set to true.

  :static-fns true")

(s/def ::load-tests              boolean?)
(def-spec-meta ::load-tests
  :doc
  "This flag will cause deftest from cljs.test to be ignored if false.

Useful for production if deftest has been used in the production classpath.

Default is true. Has the same effect as binding cljs.analyzer/*load-tests*.

  :load-tests true")

(s/def ::elide-asserts              boolean?)
(def-spec-meta ::elide-asserts
  :doc
  "This flag will cause all (assert x) calls to be removed during
compilation, including implicit asserts associated with :pre and :post
conditions. Useful for production. Default is always false even in
advanced compilation. Does NOT specify goog.asserts.ENABLE_ASSERTS,
which is different and used by the Closure library.

Note that it is currently not possible to dynamically set *assert* to
false at runtime; this compiler flag must explicitly be used to effect
the elision.

  :elide-asserts true")

(s/def ::pseudo-names               boolean?)
(def-spec-meta ::pseudo-names
  :doc
  "With :advanced mode optimizations, determines whether readable names
are emitted. This can be useful when debugging issues in the optimized
JavaScript and can aid in finding missing externs. Defaults to false.

  :pseudo-names true")

(s/def ::print-input-delimiter      boolean?)
(def-spec-meta ::print-input-delimiter
  :doc
  "Determines whether comments will be output in the JavaScript that can
be used to determine the original source of the compiled code.

Defaults to false.

  :print-input-delimiter false")

(s/def ::output-wrapper             boolean?)
(def-spec-meta ::output-wrapper
  :doc
  "Wrap the JavaScript output in (function(){...};)() to avoid clobbering
globals. Defaults to false.

  :output-wrapper false")

(s/def ::libs  (s/every string? :min-count 1 :into [] :kind sequential?))
(def-spec-meta ::libs
  :doc
  "Adds dependencies on external js libraries, i.e. Google
Closure-compatible javascript files with correct goog.provides() and
goog.requires() calls. Note that files in these directories will be
watched and a rebuild will occur if they are modified.

Paths or filenames can be given. Relative paths are relative to the
current working directory (usually project root).

Defaults to the empty vector []

  :libs [\"closure/library/third_party/closure\"
         \"src/js\"
         \"src/org/example/example.js\"]")

(s/def ::preamble  (s/every non-blank-string? :min-count 1 :into [] :kind sequential?))
(def-spec-meta ::preamble
  :doc
  "Prepends the contents of the given files to each output file. Only
valid with optimizations other than :none.

Defaults to the empty vector []

  :preamble [\"license.js\"]")

(s/def ::hashbang                   boolean?)
(def-spec-meta ::hashbang
  :doc
  "When using :target :nodejs the compiler will emit a shebang as the
first line of the compiled source, making it executable. When your
intention is to build a node.js module, instead of executable, use
this option to remove the shebang.

  :hashbang false")

(s/def ::compiler-stats             boolean?)
(def-spec-meta ::compiler-stats
  :doc
  "Report basic timing measurements on compiler activity.

Defaults to false.

  :compiler-stats true")

(s/def ::closure-language-in-out-opts
  #{:ecmascript-next    :es-next
    :ecmascript-2017    :es-2017
    :ecmascript-2016    :es-2016
    :ecmascript-2015    :es-2015
    :ecmascript6        :es6
    :ecmascript6-strict :es6-strict
    :ecmascript6-typed  :es6-typed
    :ecmascript5        :es5
    :ecmascript5-strict :es5-strict
    :ecmascript3        :es3
    :no-transpile})

(s/def ::language-in         ::closure-language-in-out-opts)
(def-spec-meta ::language-in
  :doc
  "Configure the input and output languages for the closure library. May be:

* :ecmascript-next identical to :es-next
* :ecmascript-2017 identical to :es-2017
* :ecmascript-2016 identical to :es-2016
* :ecmascript-2015 identical to :es-2015
* :ecmascript6 :es6
* :ecmascript6-strict :es6-strict
* :ecmascript6-typed identical to :es6-typed
* :ecmascript5 identical to :es5
* :ecmascript5-strict identical to :es5-strict
* :ecmascript3 identical to :es3
* :no-transpile

Defaults to :ecmascript5

  :language-in  :ecmascript3")

(s/def ::language-out        ::closure-language-in-out-opts)
(def-spec-meta ::language-out
  :doc
  "Configure the input and output languages for the closure library. May be:

* :ecmascript-next identical to :es-next
* :ecmascript-2017 identical to :es-2017
* :ecmascript-2016 identical to :es-2016
* :ecmascript-2015 identical to :es-2015
* :ecmascript6 :es6
* :ecmascript6-strict :es6-strict
* :ecmascript6-typed identical to :es6-typed
* :ecmascript5 identical to :es5
* :ecmascript5-strict identical to :es5-strict
* :ecmascript3 identical to :es3
* :no-transpile

Defaults to :no-transpile

  :language-out  :ecmascript3")

(s/def ::closure-defines (s/map-of
                          ::string-or-symbol
                          (some-fn number?
                                   string?
                                   boolean?)))
(def-spec-meta ::closure-defines
  :doc
  "Set the values of Closure libraries' variables annotated with @define
or with the cljs.core/goog-define helper macro. A common usage is
setting goog.DEBUG to false:

  :closure-defines {\"goog.DEBUG\" false}

or

  :closure-defines {'goog.DEBUG false}

Note when using Lein the quote is unnecessary due to implicit quoting.

For :optimization :none, a :main option must be specified for defines
to work, and only goog-define defines are affected. :closure-defines
currently does not have any effect with :optimization :whitespace.")

(s/def ::npm-deps (s/or :map   (s/map-of ::string-or-named string?)
                        :bool boolean?))
(def-spec-meta ::npm-deps
  :doc
  "Declare NPM dependencies. A map of NPM package names to the desired
versions or the Boolean value false. If false then any existing
node_modules directory will not be indexed nor used. See also
:install-deps.

  :npm-deps {:left-pad \"1.1.3\" }")

(s/def ::install-deps boolean?)
(def-spec-meta ::install-deps
  :doc
  "When set to true, the Clojurescript compiler will handle downloading
the Javascript dependencies defined in the :npm-deps section of the config.

  :install-deps true")

(s/def ::closure-extra-annotations
  (s/every non-blank-string? :min-count 1 :into [] :kind sequential?))
(def-spec-meta ::closure-extra-annotations
  :doc
  "Define extra JSDoc annotations that a closure library might use so
that they don't trigger compiler warnings.

  :closure-extra-annotations #{\"api\"}")

(s/def ::anon-fn-naming-policy #{:off :unmapped :mapped})
(def-spec-meta ::anon-fn-naming-policy
  :doc
  "Strategies for how the Google Closure compiler does naming of
anonymous functions that occur as r-values in assignments and variable
declarations. Defaults to :off.

  :anon-fn-naming-policy :unmapped

The following values are supported:

  :off Don't give anonymous functions names.

  :unmapped Generates names that are based on the left-hand side of
            the assignment. Runs after variable and property renaming,
            so that the generated names will be short and obfuscated.

  :mapped Generates short unique names and provides a mapping from
          them back to a more meaningful name that's based on the
          left-hand side of the assignment.")

(s/def ::optimize-constants         boolean?)
(def-spec-meta ::optimize-constants
  :doc
  "When set to true, constants, such as keywords and symbols, will only
be created once and will be written to a separate file called
constants_table.js. The compiler will emit a reference to the constant
as defined in the constants table instead of creating a new object for
it. This option is mainly intended to be used for a release build
since it can increase performance due to decreased allocation.
Defaults to true under :advanced optimizations otherwise to false.

  :optimize-constants true")

(s/def ::parallel-build             boolean?)
(def-spec-meta ::parallel-build
  :doc
  "When set to true, compile source in parallel, utilizing multiple cores.

:parallel-build true")

;; XXX TODO
#_(s/def ::devcards boolean?)
#_(def-spec-meta :doc
    `"Whether to include devcard 'defcard' definitions in the output of the compile.")

(s/def ::watch-fn fn?)
(def-spec-meta ::watch-fn
  :doc
  "Is a function that will be called after a successful build.

Only available for cljs.build.api/watch

  :watch-fn (fn [] (println \"Updated build\"))")

(s/def ::process-shim boolean?)
(def-spec-meta ::process-shim
  :doc
  "Defaults to true. Automatically provide a shim for Node.js process.env
containing a single Google Closure define, NODE_ENV with \"development\"
as the default value. In production NODE_ENV will be set to \"production\".
If set to false all of the stated behavior is disabled.

  :process-shim false")

(s/def ::dump-core                  boolean?)
(s/def ::emit-constants             boolean?)
(s/def ::warning-handlers  ;; symbol, string, or fn?
  (s/every ::s/any :min-count 1 :into [] :kind sequential?))
(s/def ::source-map-inline          boolean?)
(s/def ::ups-libs
  (s/every non-blank-string? :min-count 1 :into [] :kind sequential?))
(s/def ::ups-externs
  (s/every non-blank-string? :min-count 1 :into [] :kind sequential?))
(s/def ::ups-foreign-libs
  (s/every ::foreign-libs :min-count 1 :into [] :kind sequential?))
(s/def ::closure-output-charset     non-blank-string?)
(s/def ::external-config            (s/map-of keyword? map?))

(s/def ::fn-invoke-direct boolean?)
(def-spec-meta ::fn-invoke-direct
  :doc
  "Requires :static-fns true. This option emits slightly different
code that can speed up your code around 10-30%. Higher order
function  that don’t implement the IFn protocol are normally called
with f.call(null, arg0, arg1 …​).

With this option enabled the compiler calls them with a faster
f(arg0, arg1 …​ instead.)

  :fn-invoke-direct true")

(s/def ::rewrite-polyfills boolean?)
(def-spec-meta ::rewrite-polyfills
  :doc
  "If set to true, the google closure compiler will add polyfills (for example
when you use native javascript Promise). This requires :language-in to be set
to :es6 or higher or it will silently be ignored!

  :language-in :es6
  :rewrite-polyfills true")

(s/def ::aot-cache boolean?)
(def-spec-meta ::aot-cache
  :doc
  "A boolean value to disable or enable global caching of compiled assets.

  :aot-cache false")

(s/def ::checked-arrays (s/or :keyval #{:warn :error}
                              :false   false?
                              :nil    nil?))
(def-spec-meta ::checked-arrays
  :doc
  "If set to :warn or :error, checks inferred types and runtime values passed
to aget and aset. Inferred type mismatches will result in the
:invalid-array-access warning being triggered. Logs when incorrect values
are passed if set to :warn, throws if set to :error. May be set to a
false-y value to disable this feature.

This setting does not apply if :optimizations is set to :advanced.

  :checked-arrays :warn")

;; ** ClojureScript Compiler Warnings

(s/def ::warnings
  (s/or
   :bool boolean?
   :warnings-map-options
   (s/keys
    :opt-un
    [::dynamic
     ::extending-base-js-type
     ::extend-type-invalid-method-shape
     ::fn-var
     ::fn-arity
     ::fn-deprecated
     ::invalid-protocol-symbol
     ::invoke-ctor
     ::invalid-arithmetic
     ::invalid-array-access
     ::infer-warning
     ::js-shadowed-by-local
     ::multiple-variadic-overloads
     ::munged-namespace
     ::ns-var-clash
     ::overload-arity
     ::preamble-missing
     ::protocol-deprecated
     ::protocol-invalid-method
     ::protocol-duped-method
     ::protocol-multiple-impls
     ::protocol-with-variadic-method
     ::protocol-impl-with-variadic-method
     ::protocol-impl-recur-with-target
     ::redef
     ::redef-in-file
     ::single-segment-namespace
     ::unprovided
     ::undeclared-var
     ::undeclared-ns
     ::undeclared-ns-form
     ::undeclared-protocol-symbol
     ::unsupported-js-module-type
     ::unsupported-preprocess-value
     ::variadic-max-arity])))

(def-spec-meta ::warnings
  :doc
  "This flag will turn on/off compiler warnings for references to
undeclared vars, wrong function call arities, etc. Can be a boolean
for enabling/disabling common warnings, or a map of specific warning
keys with associated booleans. Defaults to true.

  :warnings true

;; OR

  :warnings {:fn-deprecated false} ;; suppress this warning

The following warnings are supported:

  :preamble-missing, missing preamble
  :unprovided, required namespace not provided
  :undeclared-var, undeclared var
  :undeclared-ns, var references non-existent namespace
  :undeclared-ns-form, namespace reference in ns form that does not exist
  :redef, var redefinition
  :dynamic, dynamic binding of non-dynamic var
  :fn-var, var previously bound to fn changed to different type
  :fn-arity, invalid invoke arity
  :fn-deprecated, deprecated function usage
  :protocol-deprecated, deprecated protocol usage
  :undeclared-protocol-symbol, undeclared protocol referred
  :invalid-protocol-symbol, invalid protocol symbol
  :multiple-variadic-overloads, multiple variadic arities
  :variadic-max-arity, arity greater than variadic arity
  :overload-arity, duplicate arities
  :extending-base-js-type, JavaScript base type extension
  :invoke-ctor, type constructor invoked as function
  :invalid-arithmetic, invalid arithmetic
  :protocol-invalid-method, protocol method does not match declaration
  :protocol-duped-method, duplicate protocol method implementation
  :protocol-multiple-impls, protocol implemented multiple times
  :protocol-with-variadic-method, protocol declares variadic signature
  :protocol-impl-with-variadic-method, protocol impl employs variadic signature
  :protocol-impl-recur-with-target, target passed in recur to protocol method head
  :single-segment-namespace, single segment namespace
  :munged-namespace, namespace name contains a reserved JavaScript keyword
  :ns-var-clash, namespace clashes with var
  :extend-type-invalid-method-shape, method arities must be grouped together
  :unsupported-js-module-type, unsupported JavaScript module type
  :unsupported-preprocess-value, unsupported foreign lib preprocess value
  :js-shadowed-by-local, name shadowed by a local
  :infer-warning, warnings related to externs inference")

;; *** TODO differnet ns??

(s/def ::dynamic boolean?)
(s/def ::extending-base-js-type boolean?)
(s/def ::extend-type-invalid-method-shape boolean?)
(s/def ::fn-var boolean?)
(s/def ::fn-arity boolean?)
(s/def ::fn-deprecated boolean?)
(s/def ::invalid-protocol-symbol boolean?)
(s/def ::invoke-ctor boolean?)
(s/def ::invalid-arithmetic boolean?)
(s/def ::invalid-array-access boolean?)
(s/def ::infer-warning boolean?)
(s/def ::js-shadowed-by-local boolean?)
(s/def ::multiple-variadic-overloads boolean?)
(s/def ::munged-namespace boolean?)
(s/def ::ns-var-clash boolean?)
(s/def ::overload-arity boolean?)
(s/def ::preamble-missing boolean?)
(s/def ::protocol-deprecated boolean?)
(s/def ::protocol-invalid-method boolean?)
(s/def ::protocol-duped-method boolean?)
(s/def ::protocol-multiple-impls boolean?)
(s/def ::protocol-with-variadic-method boolean?)
(s/def ::protocol-impl-with-variadic-method boolean?)
(s/def ::protocol-impl-recur-with-target boolean?)
(s/def ::redef boolean?)
(s/def ::redef-in-file boolean?)
(s/def ::single-segment-namespace boolean?)
(s/def ::unprovided boolean?)
(s/def ::undeclared-var boolean?)
(s/def ::undeclared-ns boolean?)
(s/def ::undeclared-ns-form boolean?)
(s/def ::undeclared-protocol-symbol boolean?)
(s/def ::unsupported-js-module-type boolean?)
(s/def ::unsupported-preprocess-value boolean?)
(s/def ::variadic-max-arity boolean?)

;; ** Closure Compiler Warnings

(s/def ::closure-warnings
  (s/keys
   :opt-un
   [::access-controls
    ::ambiguous-function-decl
    ::analyzer-checks
    ::check-eventful-object-disposal
    ::check-regexp
    ::check-types
    ::check-useless-code
    ::check-variables
    ::closure-dep-method-usage-checks
    ::common-js-module-load
    ::conformance-violations
    ::const
    ::constant-property
    ::debugger-statement-present
    ::deprecated
    ::deprecated-annotations
    ::duplicate-message
    ::duplicate-vars
    ::es3
    ::es5-strict
    ::externs-validation
    ::extra-require
    ::fileoverview-jsdoc
    ::function-params
    ::global-this
    ::inferred-const-checks
    ::internet-explorer-checks
    ::invalid-casts
    ::j2cl-checks
    ::late-provide
    ::lint-checks
    ::message-descriptions
    ::misplaced-type-annotation
    ::missing-getcssname
    ::missing-override
    ::missing-polyfill
    ::missing-properties
    ::missing-provide
    ::missing-require
    ::missing-return
    ::non-standard-jsdoc
    ::report-unknown-types
    ::strict-missing-require
    ::strict-module-dep-check
    ::strict-requires
    ::suspicious-code
    ::tweaks
    ::type-invalidation
    ::undefined-names
    ::undefined-variables
    ::underscore
    ::unknown-defines
    ::unused-local-variable
    ::unused-private-property
    ::use-of-goog-base
    ::violated-module-dep
    ::visiblity]))

(def-spec-meta ::closure-warnings
  :doc
  "Configure warnings generated by the Closure compiler. A map from
Closure warning to configuration value, only :error, :warning and :off
are supported.

  :closure-warnings {:externs-validation :off}

The following Closure warning options are exposed to ClojureScript:

  :access-controls
  :ambiguous-function-decl
  :analyzer-checks
  :check-eventful-object-disposal
  :check-regexp
  :check-types
  :check-useless-code
  :check-variables
  :closure-dep-method-usage-checks
  :common-js-module-load
  :conformance-violations
  :const
  :constant-property
  :debugger-statement-present
  :deprecated
  :deprecated-annotations
  :duplicate-message
  :duplicate-vars
  :es3
  :es5-strict
  :externs-validation
  :extra-require
  :fileoverview-jsdoc
  :function-params
  :global-this
  :inferred-const-checks
  :internet-explorer-checks
  :invalid-casts
  :j2cl-checks
  :late-provide
  :lint-checks
  :message-descriptions
  :misplaced-type-annotation
  :missing-getcssname
  :missing-override
  :missing-polyfill
  :missing-properties
  :missing-provide
  :missing-require
  :missing-return
  :non-standard-jsdoc
  :report-unknown-types
  :strict-missing-require
  :strict-module-dep-check
  :strict-requires
  :suspicious-code
  :tweaks
  :type-invalidation
  :undefined-names
  :undefined-variables
  :underscore
  :unknown-defines
  :unused-local-variable
  :unused-private-property
  :use-of-goog-base
  :violated-module-dep
  :visiblity

See the Closure Compiler Warning wiki for detailed descriptions.")

(s/def ::warning-value #{:error :warning :off})

;; *** TODO differnet ns??
(s/def  ::access-controls ::warning-value)
(s/def  ::ambiguous-function-decl ::warning-value)
(s/def  ::analyzer-checks ::warning-value)
(s/def  ::check-eventful-object-disposal ::warning-value)
(s/def  ::check-regexp ::warning-value)
(s/def  ::check-types ::warning-value)
(s/def  ::check-useless-code ::warning-value)
(s/def  ::check-variables ::warning-value)
(s/def  ::closure-dep-method-usage-checks ::warning-value)
(s/def  ::common-js-module-load ::warning-value)
(s/def  ::conformance-violations ::warning-value)
(s/def  ::const ::warning-value)
(s/def  ::constant-property ::warning-value)
(s/def  ::debugger-statement-present ::warning-value)
(s/def  ::deprecated ::warning-value)
(s/def  ::deprecated-annotations ::warning-value)
(s/def  ::duplicate-message ::warning-value)
(s/def  ::duplicate-vars ::warning-value)
(s/def  ::es3 ::warning-value)
(s/def  ::es5-strict ::warning-value)
(s/def  ::externs-validation ::warning-value)
(s/def  ::extra-require ::warning-value)
(s/def  ::fileoverview-jsdoc ::warning-value)
(s/def  ::function-params ::warning-value)
(s/def  ::global-this ::warning-value)
(s/def  ::inferred-const-checks ::warning-value)
(s/def  ::internet-explorer-checks ::warning-value)
(s/def  ::invalid-casts ::warning-value)
(s/def  ::j2cl-checks ::warning-value)
(s/def  ::late-provide ::warning-value)
(s/def  ::lint-checks ::warning-value)
(s/def  ::message-descriptions ::warning-value)
(s/def  ::misplaced-type-annotation ::warning-value)
(s/def  ::missing-getcssname ::warning-value)
(s/def  ::missing-override ::warning-value)
(s/def  ::missing-polyfill ::warning-value)
(s/def  ::missing-properties ::warning-value)
(s/def  ::missing-provide ::warning-value)
(s/def  ::missing-require ::warning-value)
(s/def  ::missing-return ::warning-value)
(s/def  ::non-standard-jsdoc ::warning-value)
(s/def  ::report-unknown-types ::warning-value)
(s/def  ::strict-missing-require ::warning-value)
(s/def  ::strict-module-dep-check ::warning-value)
(s/def  ::strict-requires ::warning-value)
(s/def  ::suspicious-code ::warning-value)
(s/def  ::tweaks ::warning-value)
(s/def  ::type-invalidation ::warning-value)
(s/def  ::undefined-names ::warning-value)
(s/def  ::undefined-variables ::warning-value)
(s/def  ::underscore ::warning-value)
(s/def  ::unknown-defines ::warning-value)
(s/def  ::unused-local-variable ::warning-value)
(s/def  ::unused-private-property ::warning-value)
(s/def  ::use-of-goog-base ::warning-value)
(s/def  ::violated-module-dep ::warning-value)
(s/def  ::visiblity ::warning-value)

;; ** The Top level Options Map for the cljs/build fn
(s/def ::cljs-options
  (spell/keys
   :opt-un
   [::main
    ::preloads
    ::asset-path
    ::output-to
    ::output-dir
    ::closure-warnings
    ::optimizations
    ::source-map
    ::verbose
    ::pretty-print
    ::target
    ::infer-externs
    ::foreign-libs
    ::externs
    ::modules
    ::source-map-path
    ::source-map-asset-path
    ::source-map-timestamp
    ::cache-analysis
    ::recompile-dependents
    ::static-fns
    ::load-tests
    ::elide-asserts
    ::pseudo-names
    ::print-input-delimiter
    ::output-wrapper
    ::libs
    ::preamble
    ::hashbang
    ::compiler-stats
    ::language-in
    ::language-out
    ::npm-deps
    ::install-deps
    ::closure-defines
    ::closure-extra-annotations
    ::anon-fn-naming-policy
    ::optimize-constants
    ::parallel-build
    ::devcards
    ::dump-core
    ::emit-constants
    ::warning-handlers
    ::source-map-inline
    ::ups-libs
    ::ups-externs
    ::ups-foreign-libs
    ::closure-output-charset
    ::external-config
    ::watch-fn
    ::process-shim
    ::warnings
    ::fn-invoke-direct
    ::rewrite-polyfills
    ::checked-arrays
    ::aot-cache

    ;; these need to be specified
    ::closure-variable-map-out
    ::closure-generate-exports
    ::closure-module-roots
    ::rename-prefix
    ::closure-property-map-in
    ::ignore-js-module-exts
    ::closure-property-map-out
    ::stable-names
    ::watch-error-fn
    ::browser-repl
    ::opts-cache
    ::watch
    ::cache-analysis-format
    ::rename-prefix-namespace
    ::closure-variable-map-in
    ::use-only-custom-externs]))