{"id":27064312,"url":"https://github.com/progfolio/yodel","last_synced_at":"2025-04-05T16:40:02.049Z","repository":{"id":45716426,"uuid":"401455077","full_name":"progfolio/yodel","owner":"progfolio","description":"Communicable Elisp","archived":false,"fork":false,"pushed_at":"2025-01-04T12:52:36.000Z","size":96,"stargazers_count":24,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-04T13:48:45.345Z","etag":null,"topics":["bugs","emacs","reproducibility"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","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/progfolio.png","metadata":{"files":{"readme":"README.org","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":"2021-08-30T18:59:40.000Z","updated_at":"2025-01-04T12:52:40.000Z","dependencies_parsed_at":"2025-01-04T13:48:11.041Z","dependency_job_id":"167648fe-f7ea-47ad-83d7-feddcd39b736","html_url":"https://github.com/progfolio/yodel","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progfolio%2Fyodel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progfolio%2Fyodel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progfolio%2Fyodel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/progfolio%2Fyodel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/progfolio","download_url":"https://codeload.github.com/progfolio/yodel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247369925,"owners_count":20927927,"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":["bugs","emacs","reproducibility"],"created_at":"2025-04-05T16:40:01.428Z","updated_at":"2025-04-05T16:40:02.038Z","avatar_url":"https://github.com/progfolio.png","language":"Emacs Lisp","funding_links":[],"categories":[],"sub_categories":[],"readme":"* Yodel: Communicable Elisp ⛰🎶⛰\n** Yodel-ay-hee-why?\nThe purpose of this package is to make it easier to reproduce elisp bugs.\nBug reproduction cases often follow this pattern:\n\n#+begin_example\nGiven file \"foo\" with the following contents:\n\n--8\u003c---------------cut here---------------start-------------\u003e8---\nfoo bar baz\n--8\u003c---------------cut here---------------end---------------\u003e8---\n\nExecute the following:\n1. do this\n2. do that\n3. do this\n#+end_example\n\nThis is error prone and inefficient. It requires anyone on the other end to\nprepare the test environment and manually execute the reproduction steps. One\nalso has to ensure their elisp environment is clean (ideally only having the\nminimal set of packages needed installed and freshly loaded).\n\n** Yodel-ay-hee-what?\nYodel allows one to send a declarative form which describes\nthe elisp environment and a program to execute within that environment. Others may\nexecute the form on their system and compare results easily via consistently\nformatted reports.\n\nFor example, evaluating the following:\n\n#+begin_src emacs-lisp :lexical t :results silent\n(yodel\n  :post*\n  (yodel-file\n    :point \"|\"\n    :with* \"test: |fail\"\n    :then*\n    (kill-word 1)\n    (insert \"pass\")\n    (message \"%s\" (buffer-string))))\n#+end_src\n\nresults in the following report when using the org report formatter:\n\n#+begin_src org\n,* YODEL REPORT [2021-09-08 17:51]\n\n,#+begin_src emacs-lisp :lexical t\n(yodel\n  :post*\n  (yodel-file\n    :point \"|\"\n    :with* \"test: |fail\"\n    :then*\n    (kill-word 1)\n    (insert \"pass\")\n    (message \"%s\"\n             (buffer-string))))\n,#+end_src\n\n,** STDOUT:\n\n,#+begin_src emacs-lisp :lexical t\ntest: pass\n,#+end_src\n\n,** Environment\n\n- =emacs version=: GNU Emacs 28.0.50 (build 1, x86_64-pc-linux-gnu, X toolkit, cairo version 1.17.4, Xaw3d scroll bars)\n of 2021-09-04\n- =system type=: gnu/linux\n#+end_src\n\nReformatting reports is as easy as =M-x yodel-reformat=.\nYodel offers out-of-the-box formatters for:\n\n- Github\n- Reddit\n- Org\n- Mailing lists\n\n** Yodel-ay-hee-how?\nYodel is currently only available via this repository.\n*** Install with [[https://github.com/raxod502/straight.el][straight.el]]\n#+begin_src emacs-lisp :lexical t\n(straight-use-package '(yodel :host github :repo \"progfolio/yodel\"))\n#+end_src\n(side note: The inspiration for yodel is straight.el's =straight-bug-report=)\n*** Install manually\n- Clone this repository\n- Add it to your load-path\n- =(require 'yodel)=\n** NOTICE\nYodel is still in early development.\nAPI is experimental at this time.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogfolio%2Fyodel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprogfolio%2Fyodel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogfolio%2Fyodel/lists"}