{"id":19658522,"url":"https://github.com/cdaringe/gserde","last_synced_at":"2025-02-27T02:41:35.870Z","repository":{"id":218398511,"uuid":"746328892","full_name":"cdaringe/gserde","owner":"cdaringe","description":"gleam codegen for serialization and deserialization","archived":false,"fork":false,"pushed_at":"2024-12-08T07:14:48.000Z","size":47,"stargazers_count":28,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-18T06:08:49.602Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Gleam","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cdaringe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-01-21T18:32:19.000Z","updated_at":"2025-01-25T10:50:50.000Z","dependencies_parsed_at":"2024-02-02T05:31:28.076Z","dependency_job_id":"10a8ad05-f04f-409a-881c-9965fa34c627","html_url":"https://github.com/cdaringe/gserde","commit_stats":null,"previous_names":["cdaringe/gserde"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fgserde","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fgserde/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fgserde/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdaringe%2Fgserde/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cdaringe","download_url":"https://codeload.github.com/cdaringe/gserde/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240967620,"owners_count":19886258,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T15:37:59.584Z","updated_at":"2025-02-27T02:41:35.853Z","avatar_url":"https://github.com/cdaringe.png","language":"Gleam","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gserde\n\n**warning**: alpha quality package with poor code hygiene, including assert/panic/todo\nstatements.\n\n[![Package Version](https://img.shields.io/hexpm/v/gserde)](https://hex.pm/packages/gserde)\n[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gserde/)\n\n```sh\ngleam add gserde\n```\n\n## usage\n\n1. Create custom type with a singular variant constructor. See the example\n   `src/foo.gleam` below.\n2. Run `gleam run -m gserde`.\n3. Observe the generated file `src/foo_json.gleam`.\n4. Use the new `foo_json` module!\n\n```gleam\n// src/foo.gleam\nimport gleam/option.{type Option}\npub type FooJson {\n  Foo(\n    a_bool: Bool,\n    b_int: Int,\n    c_float: Float,\n    d_two_tuple: #(Int, String),\n    e_option_int: Option(Int),\n    f_string_list: List(String),\n  )\n}\n\n// src/foo_json.gleam\n// generated!\nimport gleam/json\nimport gleam/dynamic\nimport internal/foo\n\npub fn to_json(t: foo.FooJson) {\n  json.object([\n    #(\"a_bool\", json.bool(t.a_bool)),\n    #(\"b_int\", json.int(t.b_int)),\n    #(\"c_float\", json.float(t.c_float)),\n    #(\n      \"d_two_tuple\",\n      json.preprocessed_array([\n        json.int(t.d_two_tuple.0),\n        json.string(t.d_two_tuple.1),\n      ]),\n    ),\n    #(\"e_option_int\", json.nullable(t.e_option_int, json.int)),\n    #(\"f_string_list\", json.array(t.f_string_list, json.string)),\n  ])\n}\n\npub fn to_string(t: foo.FooJson) {\n  json.to_string(to_json(t))\n}\n\npub fn get_decoder_foo() {\n  dynamic.decode6(\n    foo.Foo,\n    dynamic.field(\"a_bool\", dynamic.bool),\n    dynamic.field(\"b_int\", dynamic.int),\n    dynamic.field(\"c_float\", dynamic.float),\n    dynamic.field(\"d_two_tuple\", dynamic.tuple2(dynamic.int, dynamic.string)),\n    dynamic.field(\"e_option_int\", dynamic.optional(dynamic.int)),\n    dynamic.field(\"f_string_list\", dynamic.list(dynamic.string)),\n  )\n}\n\npub fn from_string(json_str: String) {\n  json.decode(json_str, get_decoder_foo())\n}\n\n// src/my_module.gleam\nimport foo\nimport foo_json\n\npub fn serialization_identity_test() {\n  let foo_1 = foo.Foo(..) // make a Foo\n\n  let foo_2 = foo_1\n    |\u003e foo_json.to_string // 👀, stringify the Foo to JSON!\n    |\u003e foo_json.from_string // 👀, parse the Foo from JSON!\n\n  foo_1 == foo_2 // pass the identity test\n}\n```\n\nYou can set `DEBUG=1` to get verbose output during codegen.\n\n## todo\n\n- [ ] complete all cases\n- [ ] remove all invocations of assert/panic/todo\n- [x] support non-gleam primitive types\n- [ ] handle all module references properly\n\nFurther documentation can be found at \u003chttps://hexdocs.pm/gserde\u003e.\n\n## Development\n\n```sh\ngleam test  # Run the tests\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdaringe%2Fgserde","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcdaringe%2Fgserde","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdaringe%2Fgserde/lists"}