{"id":20936102,"url":"https://github.com/flow-storm/dyna-spec","last_synced_at":"2025-04-22T15:42:39.028Z","repository":{"id":213579168,"uuid":"734050567","full_name":"flow-storm/dyna-spec","owner":"flow-storm","description":"Derive approximate types from sampling tests executions","archived":false,"fork":false,"pushed_at":"2024-04-22T12:48:16.000Z","size":346,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T16:34:15.771Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Clojure","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/flow-storm.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,"publiccode":null,"codemeta":null}},"created_at":"2023-12-20T18:38:37.000Z","updated_at":"2024-12-15T08:46:22.000Z","dependencies_parsed_at":"2023-12-21T19:54:47.170Z","dependency_job_id":"741add68-5eed-40bf-a40a-1cc1fd2ef634","html_url":"https://github.com/flow-storm/dyna-spec","commit_stats":null,"previous_names":["flow-storm/type-trek"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flow-storm%2Fdyna-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flow-storm%2Fdyna-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flow-storm%2Fdyna-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flow-storm%2Fdyna-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flow-storm","download_url":"https://codeload.github.com/flow-storm/dyna-spec/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250269954,"owners_count":21402970,"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-18T22:17:54.274Z","updated_at":"2025-04-22T15:42:39.007Z","avatar_url":"https://github.com/flow-storm.png","language":"Clojure","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dyna-Spec\n\n**Experimental and still a WIP, somehow usable but with almost no documentation**\n\nDyna-Spec generates library functions documentation by instrumenting a code base, running its tests and sampling function\ncalls and return values.\n\nAdd an alias to the project you want to generate docs for like :\n\n```clojure\n{:aliases\n\n ;; Assuming this is your test configuration\n :test {:extra-paths [\"test\"]\n       :extra-deps {io.github.cognitect-labs/test-runner {:git/tag \"v0.5.1\" :git/sha \"dfb30dd\"}}\n       :main-opts   [\"-m\" \"cognitect.test-runner\"]\n       :exec-fn cognitect.test-runner.api/test}\n       \n ;; Add your dyna-spec alias\n {:dyna-spec\n  {:classpath-overrides {org.clojure/clojure nil}\n   :extra-deps {com.github.flow-storm/clojure {:mvn/version \"1.11.2-4\"}\n                com.github.flow-storm/dyna-spec {:git/sha \"4dc9a01ff2f15e9329c0cdad4d907570d852a27f\"}}\n   :exec-fn dyna-spec.main/run\n   :exec-args {:jar-name \"my-project-dyna-spec\" ;; this will generate my-project-dyna-spec.jar\n               :test-fn cognitect.test-runner.api/test ;; whatever function runs your tests\n               :test-fn-args [{}]} ;; arguments if needed\n   :jvm-opts [\"-Dclojure.storm.instrumentOnlyPrefixes=hansel\"\n              \"-Dclojure.storm.instrumentSkipRegex=.*test.*\"]}}}\n```\n\nAnd then run : \n\n```\nclj -X:test:dyna-spec\n```\n\nwhich will generate `my-project-dyna-spec.jar`.\n\nThe only application currently able to show this docs is https://github.com/flow-storm/flow-storm-debugger\n\nAdd as many dyna-spec jars as you want to your classpath using `:deps :local/root` and then you will be able to \nexplore them in FlowStorm Docs tool like this :\n\n![demo](./docs/flow-storm-screenshot.png)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflow-storm%2Fdyna-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflow-storm%2Fdyna-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflow-storm%2Fdyna-spec/lists"}