https://github.com/muhifauzan/guard-gen

GuardGen provides macro that can be used as guard test to generates type-checks. See main repository at GitLab https://gitlab.com/muhifauzan/guard-gen
https://github.com/muhifauzan/guard-gen

elixir guard-test type-check

Last synced: 10 months ago
JSON representation

GuardGen provides macro that can be used as guard test to generates type-checks. See main repository at GitLab https://gitlab.com/muhifauzan/guard-gen

• Host: GitHub
• URL: https://github.com/muhifauzan/guard-gen
• Owner: muhifauzan
• License: mit
• Created: 2017-07-09T10:03:49.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-07-30T12:47:31.000Z (almost 9 years ago)
• Last Synced: 2025-08-10T18:49:32.603Z (10 months ago)
• Topics: elixir, guard-test, type-check
• Language: Elixir
• Size: 12.7 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • Changelog: CHANGELOG.org
  • Contributing: CONTRIBUTING.org
  • License: LICENSE

Awesome Lists containing this project

README

          
* GuardGen

  [[https://gitlab.com/muhifauzan/guard-gen/commits/master][file:https://gitlab.com/muhifauzan/guard-gen/badges/master/build.svg]] 

  [[https://inch-ci.org/github/muhifauzan/guard-gen?branch=master][file:https://inch-ci.org/github/muhifauzan/guard-gen.svg?branch=master]] 

  [[https://hex.pm/packages/guard_gen][file:https://img.shields.io/hexpm/v/guard_gen.svg?style=flat]] 

  GuardGen provides macro that can be used as guard test to generate type-checks.

* Installation

  Add GuardGen to your list of dependencies in ~mix.exs~:

  #+BEGIN_SRC elixir

    def deps do

      [{:guard_gen, "~> 0.1.0"}]

    end

  #+END_SRC

  Then, update your dependencies.

  #+BEGIN_SRC shell

    $ mix deps.get

  #+END_SRC

* Usage

  GuardGen provides macro that can be used as guard test to generates

  type-checks.

  #+BEGIN_SRC elixir

    defmodule GuardTest do

      import GuardGen

      def test(arg) when is_valid(is_atom: arg) do

        arg

      end

    end

  #+END_SRC

  List of supported type checks are listed in [[file:.guard-gen-test-support.org][here]].

  For full documentation, please consult the [[https://hexdocs.pm/guard_gen/GuardGen.html][online documentation]].

* Change Log

  All changes are found in [[file:CHANGELOG.org][CHANGELOG]]

* License

  Information about license is found in [[file:LICENSE][LICENSE]]

* Contributing

  Guide to contributing is found in [[file:CONTRIBUTING.org][CONTRIBUTING]]