{"id":19847753,"url":"https://github.com/kkharji/clj-dev","last_synced_at":"2025-02-28T20:28:16.452Z","repository":{"id":42201048,"uuid":"441761884","full_name":"kkharji/clj-dev","owner":"kkharji","description":"Data-driven clojure development environment","archived":false,"fork":false,"pushed_at":"2022-07-05T07:48:53.000Z","size":65,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-11T12:46:05.617Z","etag":null,"topics":["clojrue","clojure-library","duct","integrant","repl","repl-driven"],"latest_commit_sha":null,"homepage":"","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kkharji.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-12-25T21:32:10.000Z","updated_at":"2022-03-18T17:09:35.000Z","dependencies_parsed_at":"2022-09-20T01:02:52.717Z","dependency_job_id":null,"html_url":"https://github.com/kkharji/clj-dev","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkharji%2Fclj-dev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkharji%2Fclj-dev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkharji%2Fclj-dev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kkharji%2Fclj-dev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kkharji","download_url":"https://codeload.github.com/kkharji/clj-dev/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241226805,"owners_count":19930487,"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":["clojrue","clojure-library","duct","integrant","repl","repl-driven"],"created_at":"2024-11-12T13:15:03.653Z","updated_at":"2025-02-28T20:28:16.421Z","avatar_url":"https://github.com/kkharji.png","language":"Clojure","readme":"# clj-dev\n\u003e Data-driven clojure development environment.\n\nThe objective of `clj-dev` is to minimize the complexity of managing clojure\ndevelopment environments and keeping `user.clj` clean. Templating and\nbootstrapping is bad idea for maintaining consistent development environments.\n\n## Installation \nLeiningen/Boot\n\n```clojure \n[org.clojars.kkharji/clj-dev \"0.1.1\"]\n```\n\nClojure CLI/deps.edn\n```clojure\norg.clojars.kkharji/clj-dev {:mvn/version \"0.1.1\"}\n```\n\n## Status\n\n- [x] Hot-reload set of dirs and reload changed files\n- [x] Support [integrant] and [duct framework] state management.\n- [x] Easy configuration language.\n- [ ] Replace hawk with [beholder].\n- [ ] Wrap [nrepl] and [cider-nrepl] and expose start function.\n- [ ] Wrap [viso/pretty] for pretty print exceptions.\n- [ ] Support running and watching tests, maybe wrap [kaocha].\n- [ ] Support [mount].\n\n[duct framework]: https://github.com/weavejester/integrant\n[integrant]: https://github.com/weavejester/integrant\n[beholder]: https://github.com/nextjournal/beholder\n[cider-nrepl]: https://github.com/clojure-emacs/cider-nrepl\n[viso/pretty]: https://github.com/AvisoNovate/pretty\n[kaocha]: https://github.com/lambdaisland/kaocha\n[mount]: https://github.com/tolitius/mount\n[nrepl]: https://github.com/nrepl/nrepl\n\n## Usage\n\n### 1. Create `user.clj`\n\n```clojure\n(ns user\n (:require [clj-dev.core :as d]\n           [potemkin :as p]))\n\n(p/import-vars ;; expose api functions in user namespace. (e.g. user/start )\n [clj-dev.core start pause resume stop restart watch system config])\n ;; or aliases: go, halt, reset, reset-all\n\n;; Initialized with default options\n(d/init)\n\n(comment\n  ;; Map of current state. Most likely would be only integrant state.\n  system\n  ;; Set refresh-dirs, start state, load local.clj if it exists.\n  ;; Pass true as first argument to start watch process.\n  ;; Alias: go\n  (start)\n  ;; Stop the development environment, clear state and namespace tracker.\n  ;; Pass false as first argument to keep current watch job running if any.\n  ;; Alias: halt!, halt\n  (stop)\n  ;; Restart development environment by running (stop) and start.\n  ;; Pass true as first argument to restart watch job too.\n  ;; Alias: reset-all\n  (restart)\n  ;; Pause state, \"only effective with state management\".\n  ;; alias: suspend\n  (pause)\n  ;; Resume state after pausing, \"only effective with state management\".\n  (resume)\n  ;; Refresh development environment by running (pause) and (start).\n  ;; alias: reset\n  (refrsh)\n  ;; Start watching `:watch-paths` for changes. If development environment\n  ;; isn't started yet, then run (start).\n  (watch)\n  ;; Stop watching `:watch-paths` for changes.\n  (watch :stop))\n```\n\n### 2. Create alias in `deps.edn`\n```clojure\n{:aliases\n :repl {:main-opts   [\"-m\" \"nrepl.cmdline\" \"--middleware\"\n                      \"[cider.nrepl/cider-middleware]\" \"--interactive\"]\n        :extra-paths [\"test\" \"dev/src\"]\n        :extra-deps  {cider/cider-nrepl {:mvn/version \"0.27.2\"}\n                      org.clojars.kkharji     {:mvn/version \"0.1.0\"}}}}\n```\n\n\n### 3. Use\n```\nuser =\u003e (user/start) ;; or (start)\nuser =\u003e (user/stop) ;; or (stop)\n```\n\n## Default Options\n\n```clojure\n{;; By default only watch and namespace reload and refresh works\n ;; Paths to target for refresh \u0026 tests\n :paths [\"src\" \"test\" \"dev\" \"resources\" \"dev/src\" \"dev/resources\"]\n ;; Whether to auto-start i.e. when calling clj-dev/init, call clj-dev/start\n :start-on-init? false ;;\n\n ;; Directories to watch for changes. default to :paths\n :watch-paths nil ;; vector\n ;; File patterns to trigger reload on.\n :watch-pattern #\"[^.].*(\\.clj|\\.edn)$\"\n ;; time stamp format, set to nil if you don't want have timestamp.\n :watch-timestamp \"[hh:mm:ss]\"\n\n ;; Integrant file configuration path within :paths.\n :integrant-file-path nil ;; string\n ;; integrant profiles.\n :integrant-profiles nil ;; vector\n ;; Whether duct framework should be considered.\n :integrant-with-duct? nil} ;; boolean\n```\n\n## License\n\nCopyright © 2021 kkharji\n\nDistributed under the Eclipse Public License version 1.0.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkkharji%2Fclj-dev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkkharji%2Fclj-dev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkkharji%2Fclj-dev/lists"}