proto-lens-setup

Version 0.4.0.5 revision 0 uploaded 2021-10-09T19:26:59.000Z by gnezdo.

Package meta

Synopsis

Cabal support for codegen with proto-lens.

Description

This package provides Cabal support for the proto-lens package. It automatically generates Haskell source files from protocol buffer files (.proto).

To generate Haskell modules for a Cabal package, import Data.ProtoLens.Setup from the Setup.hs file. For example:

import Data.ProtoLens.Setup
-- Here, "src" is the directory where .proto source files may be found
main = defaultMainGeneratingProtos "src"

Then, edit the .cabal file of your project to:

• Specify build-type: Custom, and add a custom-setup clause that depends on proto-lens-setup.

• List the .proto files in extra-source-files. Note that the field belongs at the top level of the .cabal file, rather than once per library/executable/etc.

• List the generated modules (e.g. Proto.Foo.Bar) in exposed-modules or other-modules of the rule(s) that use them (e.g. the library or executables). Additionally, add proto-lens-runtime to the build-depends of those rules.

For example, in foo-bar-proto.cabal:

build-type: Custom
extra-source-files: src/foo/bar.proto
...
custom-setup
  setup-depends: base, Cabal, proto-lens-setup

library
    exposed-modules: Proto.Foo.Bar, Proto.Foo.Bar_Fields
    autogen-modules: Proto.Foo.Bar, Proto.Foo.Bar_Fields
    build-depends: proto-lens-runtime, ...

Author

Judah Jacobson

Bug reports

https://github.com/google/proto-lens/issues

Category

n/a

Copyright

Google Inc.

Homepage

https://github.com/google/proto-lens#readme

Maintainer

proto-lens@googlegroups.com

Package URL

n/a

Stability

n/a

Components

• lib:proto-lens-setup