typed.clj.checker — org.typedclojure/typed.clj.checker 1.2.1

cf clj macro

(cf form)

(cf form expected)

Takes a form and an optional expected type and returns a human-readable inferred type for that form. Throws an exception if type checking fails.

Do not use cf inside a typed namespace. cf is intended to be used at the REPL or within a unit test. Note that testing for truthiness is not sufficient to unit test a call to cf, as nil and false are valid type syntax.

cf preserves annotations from previous calls to check-ns or cf, and keeps any new ones collected during a cf. This is useful for debugging and experimentation. cf may be less strict than check-ns with type checker warnings.

eg. (cf 1) ;=> Long

(cf #(inc %) [Number -> Number])
;=> [Number -> Number]

check-form* clj

(check-form* form)

(check-form* form expected)

(check-form* form expected type-provided? & {:as opt})

Function that takes a form and optional expected type syntax and type checks the form. If expected is provided, type-provided? must be true.

Takes same options as check-form-info, except 2nd argument is :expected, 3rd argument is :type-provided?, and subsequent keys in opt will be merged over them.

check-form-info clj

(check-form-info form & {:as opt})

Function that type checks a form and returns a map of results from type checking the form.

Options

• :expected Type syntax representing the expected type for this form type-provided? option must be true to utilise the type.
• :type-provided? If true, use the expected type to check the form.
• :file-mapping If true, return map provides entry :file-mapping, a hash-map of (Map '{:line Int :column Int :file Str} Str).
• :checked-ast Returns the entire AST for the given form as the :checked-ast entry, annotated with the static types inferred after checking. If a fatal error occurs, mapped to nil.
• :beta-limit A natural integer which denotes the maximum number of beta reductions the type system can perform on a single top-level form (post Gilardi-scenario).
• :check-config Configuration map for the type checker. (See corresponding option for check-ns)

Default return map

• :ret TCResult inferred for the current form
• :out-form The macroexpanded result of type-checking, if successful.
• :result The evaluated result of :out-form, if any.
• :ex If an exception was thrown during evaluation, this key will be present with the exception as the value. DEPRECATED
• :delayed-errors A sequence of delayed errors (ex-info instances)
• :profile Use Timbre to profile the type checker. Timbre must be added as a dependency. Must use the "slim" JAR.

check-ns clj

(check-ns)

(check-ns ns-or-syms & {:as opt})

Type check a namespace/s (a symbol or Namespace, or collection). If not provided default to current namespace. Returns a true value if type checking is successful, otherwise throws an Exception.

Do not use check-ns within a checked namespace. It is intended to be used at the REPL or within a unit test. Suggested idiom for clojure.test: (is (check-ns 'your.ns))

Keyword arguments:

• :trace If true, print some basic tracing of the type checker Default: nil
• :check-config Configuration map for the type checker.
  • :check-ns-dep If :recheck, always check dependencies. If :never, ns dependencies are ignored. #{:recheck :never} Default: :recheck
  • :unannotated-def If :unchecked, unannotated defs are ignored and their type is not recorded. If :infer, unannotated defs are inferred by their root binding and the type is recorded in the type environment. #{:unchecked :infer} Also applies to defmethods on unannotated defmultis. Default: :infer
  • :unannotated-var If :unchecked, unannotated vars are given an unsound annotation that is used to statically infer its type based on usages/definition (see infer-unannotated-vars). If :any, usages of unannotated vars are given type Any (sound). If :error, unannotated vars are a type error (sound). #{:unchecked :any :error} Default: :error
  • :unannotated-arg (Not Yet Implemented) If :unchecked, unannotated fn arguments are given an unsound annotation that is used to statically infer its argument types based on definition. If :any, unannotated fn arguments are give type Any (sound). #{:unchecked :any} Default: :any
  • :check-form-eval Configures when to evaluate a form relative to type checking it. If :never, don't evaluate individual forms as part of type checking. Avoids side effects during expansion and analysis. If :before, evaluate entire individual forms before type checking, ignoring the Gilardi scenario. Avoids side effects during expansion and analysis. If :after, evaluate individual forms after type checking, respecting the Gilardi scenario. Default: :after
  • :check-ns-load If :require-before-check, require all checked namespaces before checking. If :never, don't load files before checking. Default: :never

Removed:

• :profile If true, use Timbre to profile the type checker. Timbre must be added as a dependency. Must use the "slim" JAR. Default: nil

If providing keyword arguments, the namespace to check must be provided as the first argument.

Bind clojure.core.typed.util-vars/verbose-types to true to print fully qualified types. Bind clojure.core.typed.util-vars/verbose-forms to print full forms in error messages.

eg. (check-ns 'myns.typed) ;=> :ok

; implicitly check current namespace
(check-ns)
;=> :ok

check-ns-info clj

(check-ns-info)

(check-ns-info ns-or-syms & {:as opt})

Same as check-ns, but returns a map of results from type checking the namespace.

Options

• :type-provided? If true, use the expected type to check the form
• :profile Use Timbre to profile the type checker. Timbre must be added as a dependency. Must use the "slim" JAR.
• :file-mapping If true, return map provides entry :file-mapping, a hash-map of (Map '{:line Int :column Int :file Str} Str).
• :check-deps If true, recursively type check namespace dependencies. Default: true

Default return map

• :delayed-errors A sequence of delayed errors (ex-info instances)

check-ns2 clj

(check-ns2)

(check-ns2 ns-or-syms & {:as opt})

check-ns3 clj

(check-ns3)

(check-ns3 ns-or-syms & {:as opt})

check-ns4 clj

(check-ns4)

(check-ns4 ns-or-syms & {:as opt})

default-check-config clj

(default-check-config)