diff options
Diffstat (limited to 'public/re-inventing-task-runner-that-i-actually-used-daily.html')
| -rwxr-xr-x | public/re-inventing-task-runner-that-i-actually-used-daily.html | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/public/re-inventing-task-runner-that-i-actually-used-daily.html b/public/re-inventing-task-runner-that-i-actually-used-daily.html new file mode 100755 index 0000000..4035bdd --- /dev/null +++ b/public/re-inventing-task-runner-that-i-actually-used-daily.html | |||
| @@ -0,0 +1,126 @@ | |||
| 1 | <!doctype html><html lang=en-us><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><link href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAL69vf8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAv76+/8LBwQkAAAAAAAAAAAAAAAC+vb3/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAL+9vf/Bv78JAAAAAAAAAAAAAAAAu7q6/wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC7ubr/vr29CAAAAAAAAAAAy8nJAZ6foP8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAnqGj/6GipAoAAAAAHLjU/xcXHf/BwsL/I8XY/yPK3v8XGiD/IbjL/yPF2f8XGiD/Fxkf/yLF2f8gnK3/Fxog/62ztv8fwNf/FRcd/x271v8mz93/GRsi/xkXHf8p097/GiIp/xobIv8p0t3/KdPe/xocIv8fYmr/KNPe/xoZH/8aHCL/J87c/xy81/8VFxz/IsPZ/8zS0/8XGiD/Ir/R/yPH2/8XGiD/Fxkf/yPH2/8dd4T/GBog/yPJ3f8jyNr/uru9/xcUGv8cudb/EhITDKi5vRKlvMP/RUpOERwcHRAdOj4QHTk8EBwdHRAdNTgQHTo/EBwcHRAcHB0QSGduEKW4vf+koqQfHzg+EBqz0ewSFRv7EyMr/xq51vsTERb7ExUb+xq41fsau9j7ExUb+xiPp/sZudb7ExUb+xMVG/sZuNX/GKvI/BIUGfMdvdn/IrfL/xcaIP8n1eb/J9Dh/xkcIf8ZGR7/J8/f/xxCSv8ZGyH/J9Dg/ybQ4P8ZHCL/FSQs/yPK3/8UExj/GE1b/ybS5P8ZGB7/Ghwj/ynW5P8p2Ob/Ghwi/yWrtv8p1eH/Ghwi/xocIv8p1uT/J8XT/xkcIv8m1un/Hb7d/xUYH/8hzOr/HtHu/xcaIf8XGB//I8vi/xgxOv8XGSD/I8rg/yPK4P8XGiD/GUFL/yPP6f8SERj/Fhkh/x3A4f8AAAAAJ2f9/ydr//8mZPH/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlYu38J2v//ydo/f8AAAAAAAAAAAd8/fkFqf//Iob8sAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMY39awWr//8FfP3/AAAAAAAAAAAFm/7/SfD//wR+/f8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAOB/f9B7v//BaX+/wAAAAAAAAAAQ878SAyZ/v9n1v4KAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADu9v8DDJb+/z3N/XgAAAAA3/sAAN/7AADf+wAA3/sAAAAAAAAAAAAAAAAAAN/7AAAAAAAAAAAAAAAAAAAAAAAAj/EAAI/5AACP8QAA3/sAAA==" rel=icon type=image/x-icon><title>Re-Inventing Task Runner That I Actually Used Daily</title><meta name=description content="Couple of months ago I had this brilliant idea of re-inventing the wheel bymaking an alternative for make."><link rel=alternate type=application/rss+xml title="Mitja Felicijan's posts" href=https://mitjafelicijan.com/index.xml><link rel=alternate type=application/rss+xml title="Mitja Felicijan's notes" href=https://mitjafelicijan.com/notes.xml><style>body{padding:1rem;max-width:760px;background:#fff;font-family:sans-serif;line-height:1.35rem;font-size:16px;margin:0 auto}hr{margin-block-start:1.5rem}h1,h2,h3{line-height:initial}h1{font-size:xx-large}footer{margin-block-start:2rem}cap{text-transform:capitalize}table{max-width:100%;width:100%;border-collapse:separate;border-spacing:2px;border:1px solid #000;border-left:1px solid #999;border-top:1px solid #999}blockquote{font-style:italic}table thead{background:#eee}ul.list li{padding:.2em 0}ul{line-height:1.4em}td,th{border:1px solid #000;padding:4px;border-right:1px solid #999;border-bottom:1px solid #999;text-align:left}pre{text-wrap:nowrap;overflow-x:auto;padding:0 1em;border:1px solid #dcdcdc}code{padding:0 3px;font-size:14px;border:0}pre code{line-height:1.3em}pre,code,pre *,code *{font-family:monospace}figure{margin-inline-start:0;margin-inline-end:0}figcaption{text-align:center}figcaption p{margin:.3em 0 0}img,video,audio{max-width:100%}header{display:flex;flex-direction:row;gap:3rem}nav{display:flex;gap:.75rem}nav.main{flex-grow:1}.pstatus-orange{background:gold}.pstatus-green{background:#9acd32}.pstatus-red{background:#cd5c5c}@media only screen and (max-width:600px){body{padding:15px}header{flex-direction:column;gap:1rem}a{word-wrap:break-word}}</style><header><nav class=main itemscope itemtype=http://schema.org/SiteNavigationElement role=toolbar><a href=/>Home</a> | ||
| 2 | <a href=https://git.mitjafelicijan.com/ target=_blank>Git</a> | ||
| 3 | <a href=https://files.mitjafelicijan.com/ target=_blank>Files</a> | ||
| 4 | <a href=/radio.pls target=_blank>Radio</a> | ||
| 5 | <a href=/mitjafelicijan.pgp.pub.txt target=_blank>PGP</a> | ||
| 6 | <a href=/curriculum-vitae.html>CV</a> | ||
| 7 | <a href=/index.xml target=_blank>RSS</a></nav></header><main role=main><article itemtype=http://schema.org/Article><h1 itemtype=headline>Re-Inventing Task Runner That I Actually Used Daily</h1><p><cap>post</cap>, May 31, 2023 on <a href=https://mitjafelicijan.com>Mitja Felicijan's blog</a><div><p>Couple of months ago I had this brilliant idea of re-inventing the wheel by | ||
| 8 | making an alternative for make. And so I went. Boldly into the battle. And to my | ||
| 9 | big surprise my attempt resulted in not a completely useless piece of software.<p>My initial requirements were quite simple but soon grow into something more | ||
| 10 | ambitious. And looking back I should have stuck to the simple version. My | ||
| 11 | laziness was on my side this time though. Because I haven’t implemented some of | ||
| 12 | the features I now realise I really didn’t need them and they would bog the | ||
| 13 | whole program and make it be something it was never meant to be.<p>My basic requirements were following:<ul><li>Syntax should be a tiny bit inspired by Rake and Rakefiles.<li>Should borrow the overall feel of a unit test experience.<li>Using something like Python would be a bit of an overkill.<li>The program must be statically compiled, so it can run on same architecture | ||
| 14 | without libc, musl dependencies or things like that.<li>Install ruby for rake is a bit overkill and can not be done with certain | ||
| 15 | really lightweight distributions like Alpine Linux. This tool would be usable | ||
| 16 | on such lightweight systems for remote debugging.<li>I want to use it for more than just compiling things. I want to use it as an | ||
| 17 | entry-point into a project, and I want this to help me indirectly document the | ||
| 18 | project as well.<li>It should be an abstraction over bash shell or the default system shell.<ul><li>Each task essentially becomes its own shell instance.</ul><li>Must work on Linux and macOS systems.<li>By default, running <code>erd</code> list all the available tasks (when I use make, I | ||
| 19 | usually put a disclaimer that you should check Makefile to see all available | ||
| 20 | target).<li>Should support passing arguments when you run it from a shell.<li>Normal variable as the same as environmental variables. There is no | ||
| 21 | distinction. Every variable is also essentially an environment variable and | ||
| 22 | can be used by other programs.<li>State between tasks is not shared, and this makes this “pure” shell instances.<li>Should be single-threaded for the start and later expanded with <code>@spawn</code> | ||
| 23 | command.<li>Variables behave like macros and are preprocessed before evaluation.<li>Should support something like <code>assure</code> that would check if programs like C | ||
| 24 | compiler or Python (whatever the project requires) are installed on a machine.</ul><p>Quite a reasonable list of requirements. I do this things already in my | ||
| 25 | Makefiles or/and Bash scripts. But I would like to avoid repeating myself every | ||
| 26 | time I start working on something new.<p>So I started with the following syntax.<pre tabindex=0 style=background-color:#fff><code><span style=display:flex><span>@env on | ||
| 27 | </span></span><span style=display:flex><span> | ||
| 28 | </span></span><span style=display:flex><span><span style=color:green># Override the default shell.</span> | ||
| 29 | </span></span><span style=display:flex><span>@shell <span style=color:#a31515>/bin/</span>bash | ||
| 30 | </span></span><span style=display:flex><span> | ||
| 31 | </span></span><span style=display:flex><span><span style=color:green># Assure that program is installed.</span> | ||
| 32 | </span></span><span style=display:flex><span>@assure docker-compose pip python3 | ||
| 33 | </span></span><span style=display:flex><span> | ||
| 34 | </span></span><span style=display:flex><span><span style=color:green># Load local dotenv files (these are then globally available).</span> | ||
| 35 | </span></span><span style=display:flex><span>@dotenv .env | ||
| 36 | </span></span><span style=display:flex><span>@dotenv .env.sample | ||
| 37 | </span></span><span style=display:flex><span>@dotenv some_other_file | ||
| 38 | </span></span><span style=display:flex><span> | ||
| 39 | </span></span><span style=display:flex><span><span style=color:green># This are local variables but still accessible in tasks.</span> | ||
| 40 | </span></span><span style=display:flex><span>@var HI = <span style=color:#a31515>"hey"</span> | ||
| 41 | </span></span><span style=display:flex><span>@var TOKEN = <span style=color:#a31515>"sometoken"</span> | ||
| 42 | </span></span><span style=display:flex><span>@var EMAIL = <span style=color:#a31515>"m@m.com"</span> | ||
| 43 | </span></span><span style=display:flex><span>@var PASSWORD = <span style=color:#a31515>"pass"</span> | ||
| 44 | </span></span><span style=display:flex><span>@var EDITOR = <span style=color:#a31515>"vim"</span> | ||
| 45 | </span></span><span style=display:flex><span> | ||
| 46 | </span></span><span style=display:flex><span>@task dev <span style=color:#a31515>"Test chars .:'}{]!//"</span> does | ||
| 47 | </span></span><span style=display:flex><span> echo <span style=color:#a31515>"..."</span> $HI | ||
| 48 | </span></span><span style=display:flex><span><span style=color:#00f>end</span> | ||
| 49 | </span></span><span style=display:flex><span> | ||
| 50 | </span></span><span style=display:flex><span>@task clean <span style=color:#a31515>"Cleans the obj files"</span> does | ||
| 51 | </span></span><span style=display:flex><span> rm .obj | ||
| 52 | </span></span><span style=display:flex><span><span style=color:#00f>end</span> | ||
| 53 | </span></span><span style=display:flex><span> | ||
| 54 | </span></span><span style=display:flex><span>@task greet <span style=color:#a31515>"Greets the user"</span> does | ||
| 55 | </span></span><span style=display:flex><span> echo <span style=color:#a31515>"Hi user $TOKEN or $WINDOWID $EMAIL"</span> | ||
| 56 | </span></span><span style=display:flex><span><span style=color:#00f>end</span> | ||
| 57 | </span></span><span style=display:flex><span> | ||
| 58 | </span></span><span style=display:flex><span>@task stack <span style=color:#a31515>"Starts Docker stack"</span> does | ||
| 59 | </span></span><span style=display:flex><span> docker-compose -f stack.yml up | ||
| 60 | </span></span><span style=display:flex><span><span style=color:#00f>end</span> | ||
| 61 | </span></span><span style=display:flex><span> | ||
| 62 | </span></span><span style=display:flex><span>@task todo <span style=color:#a31515>"Shows all todos in source files and count them"</span> does | ||
| 63 | </span></span><span style=display:flex><span> grep -ir <span style=color:#a31515>"TODO|FIXME"</span> . | wc -l | ||
| 64 | </span></span><span style=display:flex><span><span style=color:#00f>end</span> | ||
| 65 | </span></span><span style=display:flex><span> | ||
| 66 | </span></span><span style=display:flex><span>@task test1 <span style=color:#a31515>"For testing 1"</span> does | ||
| 67 | </span></span><span style=display:flex><span> unknown-command | ||
| 68 | </span></span><span style=display:flex><span> echo <span style=color:#a31515>"test1"</span> | ||
| 69 | </span></span><span style=display:flex><span> ls -lha | ||
| 70 | </span></span><span style=display:flex><span><span style=color:#00f>end</span> | ||
| 71 | </span></span><span style=display:flex><span> | ||
| 72 | </span></span><span style=display:flex><span>@task test2 <span style=color:#a31515>"For testing 2"</span> does | ||
| 73 | </span></span><span style=display:flex><span> echo <span style=color:#a31515>"test1"</span> | ||
| 74 | </span></span><span style=display:flex><span> ls -lha | ||
| 75 | </span></span><span style=display:flex><span> docker-compose -f samples/stack.yml up | ||
| 76 | </span></span><span style=display:flex><span><span style=color:#00f>end</span> | ||
| 77 | </span></span></code></pre><p>One thing that I really like about Errand. Yes, this is what it is called. And | ||
| 78 | it is available at <a href=https://git.mitjafelicijan.com/errand.git/about/>https://git.mitjafelicijan.com/errand.git/about/</a>. Moving | ||
| 79 | on. One thing that I really like is that a task is a persistent shell. By that I | ||
| 80 | mean, that the whole task, even if it contains multiple command in one shell. | ||
| 81 | In make each line in a target is that and you need to combine lines or add <code>\</code> | ||
| 82 | at the end of the line.<pre tabindex=0 style=background-color:#fff><code><span style=display:flex><span><span style=color:green># How you do this things in make.</span> | ||
| 83 | </span></span><span style=display:flex><span>target: | ||
| 84 | </span></span><span style=display:flex><span> source .venv/bin/activate <span style=color:#a31515>\ | ||
| 85 | </span></span></span><span style=display:flex><span><span style=color:#a31515></span> python script.py | ||
| 86 | </span></span></code></pre><p>This solves this problem. Consider each task and what is being executed in that | ||
| 87 | task a shell that will only close when all the tasks are completed.<p>By self-documenting I mean that if you are in a directory with <code>Errandfile</code> in, | ||
| 88 | if you only type <code>erd</code> and press enter it should by default display all the | ||
| 89 | possible targets. In make i was doing this by having a first target be something | ||
| 90 | like <code>default</code> that echos the message “Check Makefile for all available target.” | ||
| 91 | Because all of the tasks in Errand require a message I use that to display let’s | ||
| 92 | call it table of contents.<p>Because I don’t use any external dependencies this whole thing can be statically | ||
| 93 | compiled. So that also checked one of the boxes.<p>It works on Linux and on a Mac so that’s also a bonus. I don’t believe this | ||
| 94 | would work on Windows machines because of the way that I use shell instances. By | ||
| 95 | you could use something like Windows Subsystem for Linux and run it in | ||
| 96 | there. That is a valid option.<p>To finish this essay off, how was it to use it in “real life”. I have to be | ||
| 97 | honest. Some of the missing features still bother me. <code>@dotenv</code> directive is | ||
| 98 | still missing and I need to implement this ASAP.<p>Another thing that needs to happen is support for streaming output. Currently | ||
| 99 | commands like <code>docker-compose</code> that runs in foreground mode is not compatible | ||
| 100 | with Errand. So commands that stream output are an issue. I need to revisit how | ||
| 101 | I initiate shell and how I read stdout and stderr. But that shouldn’t be a | ||
| 102 | problem.<p>I have been very satisfied with this thing. I am pleasantly surprised by how | ||
| 103 | useful it is. I really wanted to test this in the wild before I commit to it. I | ||
| 104 | have more abandoned project than Google and it’s bringing a massive shame to my | ||
| 105 | family at this point. So I wanted to be sure that this is even useful. And it | ||
| 106 | actually is. Quite surprised at myself.<p>I really need to package this now and write proper docs. And maybe rewrite | ||
| 107 | tokeniser. Its atrocious right now. Site to behold! But that is an issue for | ||
| 108 | another time.</div></article></main><section><hr><h2>Posts from blogs I follow around the net</h2><ul><li><a href=https://chotrin.org/writing/2023-10-20.html target=_blank rel=noopener>OpenBSD upgrade and fall things.</a><div>Been AFK for a bit. It's autumn and I upgraded this server to OpenBSD 7.4! — <a href=https://chotrin.org>chötrin's wiki.</a><li><a href=https://mirzapandzo.com/next-image-url-parameter-is-valid-but-upstream-response-is-invalid target=_blank rel=noopener>Next/Image "url" parameter is valid but upstream response is invalid</a><div>Getting "url" parameter is valid but upstream response is invalid error with Next/Image on WSL2 — <a href=https://mirzapandzo.com/>Mirza Pandzo's Blog</a><li><a href=https://drewdevault.com/2023/10/13/Going-off-script.html target=_blank rel=noopener>Going off-script</a><div>There is a phenomenon in society which I find quite bizarre. Upon our entry to | ||
| 109 | this mortal coil, we are endowed with self-awareness, agency, and free will. | ||
| 110 | Each of th… — <a href=https://drewdevault.com>Drew DeVault's blog</a><li><a href=https://solar.lowtechmagazine.com/2023/10/workshop-in-rotterdam-how-to-build-a-bike-generator/ target=_blank rel=noopener>Workshop in Rotterdam: How to Build a Bike Generator</a><div>Afbeelding: Low-tech Magazine workshop in Rotterdam, the Netherlands. Poster: Marie Verdeil. Image: Sara Vercauteren | ||
| 111 | The workshop takes place on behalf of the “Hou… — <a href=https://solar.lowtechmagazine.com/posts/>LOW←TECH MAGAZINE English</a><li><a href="http://offbeatpursuit.com:80/blog/?id=24" target=_blank rel=noopener>Printf debugging</a><div>tags: | ||
| 112 | plan9 | ||
| 113 | There’s no shame in that. Yes, there is documentation, code to be | ||
| 114 | read, and debuggers to be used. But sometimes you just need to “see” | ||
| 115 | what is happening. | ||
| 116 | So… — <a href=http://offbeatpursuit.com:80/blog/>WLOG - blog</a><li><a href=https://neil.computer/notes/chart-of-accounts-for-startups-and-saas-companies/ target=_blank rel=noopener>Chart of Accounts for Startups and SaaS Companies</a><div>Accounting is fundamental to starting a business. You need to have a basic understanding of accounting principles and essential bookkeeping. I had to learn it. Ther… — <a href=https://neil.computer/>Neil Panchal</a><li><a href=https://journal.valeriansaliou.name/deploy-a-nomad-cluster-on-alpine-linux-with-vultr/ target=_blank rel=noopener>Deploy a Nomad Cluster on Alpine Linux with Vultr</a><div>After spending countless hours trying to understand how to deploy my apps on Kubernetes for the first time to host Mirage, an AI API service that I run, I ended up … — <a href=https://journal.valeriansaliou.name/>Valerian Saliou</a><li><a href=https://jcs.org/2023/10/17/wikipedia target=_blank rel=noopener>Wikipedia Reader 1.0 Released</a><div>Wikipedia Reader | ||
| 117 | 1.0 has been released: | ||
| 118 | wikipedia-1.0.sit | ||
| 119 | (StuffIt 3 archive, includes | ||
| 120 | source code | ||
| 121 | and THINK C 5 project file) | ||
| 122 | SHA256: 360e12d064f6579695f1e627ce34cb2f0… — <a href=https://jcs.org/>joshua stein</a></ul><p><a href=https://git.sr.ht/~sircmpwn/openring>Generated with openring.</a></section><footer><hr><p><big><strong>Want to comment or have something to add?</strong></big><p>You can write me an email | ||
| 123 | at <a href=mailto:m@mitjafelicijan.com>m@mitjafelicijan.com</a> or | ||
| 124 | catch up with me <a href=https://telegram.me/mitjafelicijan target=_blank>on Telegram</a>.<hr><p>This website does not track you. Content is made available under | ||
| 125 | the <a href=https://creativecommons.org/licenses/by/4.0/ target=_blank rel=noreferrer>CC BY 4.0 license</a> unless specified | ||
| 126 | otherwise. Blog is also available as <a href=/index.xml target=_blank>RSS feed</a>.</footer> \ No newline at end of file | ||
