├── .env ├── .github └── workflows │ └── go.yml ├── .gitignore ├── .vscode ├── launch.json └── settings.json ├── LICENSE ├── README.md ├── demo.md ├── errors.go ├── exec.go ├── exec_test.go ├── go.mod ├── go.sum ├── main.go ├── main_test.go ├── parser.go ├── parser_test.go └── tests ├── err_no_shebang_no_infostring.md ├── err_same_command_name.md ├── no_code_in_codefence.md ├── one_command_two_code_blocks.md ├── test1.md ├── test2.md ├── test_config.md ├── test_config_fail.md ├── test_config_ignore.md ├── test_dependencies.md ├── test_dependency_missing.md ├── test_no_launcher_defined.md ├── test_unknown_onerror_value.md ├── two_commands.md └── two_commands_two_code_blocks.md /.env: -------------------------------------------------------------------------------- 1 | MDX_LOG_LEVEL=DEBUG -------------------------------------------------------------------------------- /.github/workflows/go.yml: -------------------------------------------------------------------------------- 1 | # .github/workflows/release.yaml 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | permissions: 8 | contents: write 9 | packages: write 10 | 11 | jobs: 12 | releases-matrix: 13 | name: Release Go Binary 14 | runs-on: ubuntu-latest 15 | strategy: 16 | matrix: 17 | goos: [linux, darwin] 18 | goarch: ["386", amd64, arm64] 19 | exclude: 20 | - goarch: "386" 21 | goos: darwin 22 | - goarch: amd64 23 | goos: darwin 24 | steps: 25 | - uses: actions/checkout@v4 26 | - uses: wangyoucao577/go-release-action@v1 27 | with: 28 | github_token: ${{ secrets.GITHUB_TOKEN }} 29 | goos: ${{ matrix.goos }} 30 | goarch: ${{ matrix.goarch }} 31 | extra_files: LICENSE README.md 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | mdx -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | // Use IntelliSense to learn about possible attributes. 3 | // Hover to view descriptions of existing attributes. 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 5 | "version": "0.2.0", 6 | "configurations": [ 7 | { 8 | "name": "Launch command with arg", 9 | "type": "go", 10 | "request": "launch", 11 | "mode": "auto", 12 | "program": "${workspaceFolder}", 13 | "args": [ 14 | "${input:command}", 15 | "${input:arg}" 16 | ], 17 | "envFile": "${workspaceFolder}/.env" 18 | }, 19 | { 20 | "name": "Launch command", 21 | "type": "go", 22 | "request": "launch", 23 | "mode": "auto", 24 | "program": "${workspaceFolder}", 25 | "args": [ 26 | "${input:command}" 27 | ], 28 | "envFile": "${workspaceFolder}/.env" 29 | }, 30 | { 31 | "name": "Launch command with specific md file and arg", 32 | "type": "go", 33 | "request": "launch", 34 | "mode": "auto", 35 | "program": "${workspaceFolder}", 36 | "args": [ 37 | "${input:markdownfile}", 38 | "${input:command}", 39 | "${input:arg}" 40 | ], 41 | "envFile": "${workspaceFolder}/.env" 42 | } 43 | ], 44 | "inputs": [ 45 | { 46 | "id": "markdownfile", 47 | "type": "promptString", 48 | "description": "The Markdown file", 49 | "default": "demo.md" 50 | }, 51 | { 52 | "id": "command", 53 | "type": "promptString", 54 | "description": "Command name", 55 | "default": "cmd1" 56 | }, 57 | { 58 | "id": "arg", 59 | "type": "promptString", 60 | "description": "arg for command", 61 | "default": "" 62 | } 63 | ] 64 | } -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "go.delveConfig": { 3 | "showGlobalVariables": true, 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mdx - Execute your Markdown Code Blocks 2 | 3 | Imagine you have the following Markdown file to document your commands: 4 | 5 | 6 | # demo.md 7 | ## [simple_echo]() - Simple echo in shell 8 | 9 | ```sh 10 | echo "hello world" 11 | ``` 12 | 13 | With `mdx` you execute the `sh` code block: 14 | 15 | ``` 16 | % mdx simple_echo 17 | hello world 18 | ``` 19 | 20 | 🚀 In a nutshell: 21 | 22 | * Pass arguments into your code block. ➔ [Example](https://github.com/dim0x69/mdx/wiki/Examples#ldap-spn-find-account-by-spn) 23 | * Define dependencies ➔ [Example](https://github.com/dim0x69/mdx/wiki/Examples#docker) 24 | * supports shebangs in code block ➔ [Example](https://github.com/dim0x69/mdx/wiki/Examples#venv-shebang-shebang-support) 25 | 26 | 27 | * parses all .md files in the CWD for potential commands 28 | * list all commands using `-list` or `-l` 29 | 30 | ➔ [Usage](https://github.com/dim0x69/mdx/wiki/Usage) 31 | 32 | ## Getting started 33 | 34 | ### Installation 35 | 36 | You can simply download a binary which fits your operating system and achitecture from the [releases page](https://github.com/dim0x69/mdx/releases). 37 | 38 | Then just use the demo.md from above to execute `simple_echo`. 39 | 40 | ### Build 41 | 42 | Go should be installed on your system: Follow [this guide](https://go.dev/doc/install) to install go in your PATH. 43 | 44 | ```sh 45 | $ git clone https://github.com/dim0x69/mdx 46 | $ go build 47 | $ go install 48 | ``` 49 | 50 | ## Resources 51 | The idea for this project came from [Makedown](https://github.com/tzador/makedown). 52 | -------------------------------------------------------------------------------- /demo.md: -------------------------------------------------------------------------------- 1 | # demo.md 2 | ## `simple_echo` - Simple echo in shell 3 | 4 | ```sh 5 | echo "{{.arg1}} {{.arg2}}" 6 | ``` 7 | 8 | Execute with `mdx demo.md simple_echo hello world` 9 | 10 | Output: 11 | ``` 12 | $ hello world 13 | ``` 14 | 15 | ## `shebang1`- Example using shebang from a python venv 16 | 17 | ``` 18 | #!/home/ldm9fe/git/mdx/.venv/bin/python 19 | 20 | import sys 21 | print(sys.executable) 22 | ``` 23 | 24 | Note: No infostring is specified. You can also specify a infostring, the shebang will nontheless be preferrred. -------------------------------------------------------------------------------- /errors.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import "errors" 4 | 5 | var ( 6 | ErrNoCommandFoundCommands = errors.New("no command found in commands") 7 | ErrArgProvidedButNotUsed = errors.New("argument provided but not used in the template") 8 | ErrArgUsedInTemplateNotProvided = errors.New("argument used in template but not provided in args") 9 | ErrNoCommandFoundHeading = errors.New("no command found in heading") 10 | ErrNoLauncherDefined = errors.New("no launcher defined for infostring") 11 | ErrNoInfostringOrShebang = errors.New("no infostring and no shebang defined") 12 | ErrDuplicateCommand = errors.New("duplicate command found") 13 | ErrDependencyNotFound = errors.New("dependency not found") 14 | ErrCodeBlockExecFailed = errors.New("failed to execute code block") 15 | ErrNoEnv = errors.New("env binary not found") 16 | ) 17 | -------------------------------------------------------------------------------- /exec.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "os" 7 | "os/exec" 8 | "regexp" 9 | "text/template" 10 | 11 | "github.com/sirupsen/logrus" 12 | ) 13 | 14 | func isExecutableInPath(candidates []string) string { 15 | for _, cmd := range candidates { 16 | if path, err := exec.LookPath(cmd); err == nil { 17 | return path 18 | } 19 | } 20 | return "" 21 | } 22 | 23 | type LauncherBlock struct { 24 | cmd string // The command to execute for the infostring above 25 | extension string // The file extension for the language 26 | } 27 | 28 | // global storage for launchers 29 | // the key is the infostring from the code fence 30 | var launchers = map[string]LauncherBlock{} 31 | 32 | func loadLaunchers() error { 33 | addedLaunchers := []string{} 34 | 35 | if env := isExecutableInPath([]string{"env"}); env != "" { 36 | launchers["env"] = LauncherBlock{cmd: env, extension: "env"} 37 | addedLaunchers = append(addedLaunchers, env) 38 | } else { 39 | return fmt.Errorf("%w: env must be available in PATH", ErrNoEnv) 40 | } 41 | if cmd := isExecutableInPath([]string{"sh"}); cmd != "" { 42 | launchers["sh"] = LauncherBlock{cmd: cmd, extension: "sh"} 43 | launchers["bash"] = LauncherBlock{cmd: cmd, extension: "sh"} 44 | addedLaunchers = append(addedLaunchers, cmd) 45 | } 46 | 47 | if cmd := isExecutableInPath([]string{"bash"}); cmd != "" { 48 | launchers["bash"] = LauncherBlock{cmd: cmd, extension: "bash"} 49 | addedLaunchers = append(addedLaunchers, cmd) 50 | } 51 | 52 | pythonCandidates := []string{"python", "python3"} 53 | if cmd := isExecutableInPath(pythonCandidates); cmd != "" { 54 | launchers["py"] = LauncherBlock{cmd: cmd, extension: "py"} 55 | addedLaunchers = append(addedLaunchers, cmd) 56 | } 57 | 58 | logrus.Debug("Added launchers: ", addedLaunchers) 59 | return nil 60 | } 61 | 62 | func listLaunchers() { 63 | fmt.Println("Available launchers:") 64 | for lang, launcher := range launchers { 65 | fmt.Printf("%s: %s (extension: %s)\n", lang, launcher.cmd, launcher.extension) 66 | } 67 | } 68 | 69 | /* 70 | Before executing commandBlock, this function validates that all dependencies are present in the commands map. 71 | */ 72 | func validateDependencies(commands map[string]CommandBlock, commandBlock *CommandBlock) error { 73 | for _, dep := range commandBlock.Dependencies { 74 | if _, ok := commands[dep]; !ok { 75 | return fmt.Errorf("%w: %s", ErrDependencyNotFound, dep) 76 | } 77 | dependency := commands[dep] 78 | if err := validateDependencies(commands, &dependency); err != nil { 79 | return err 80 | } 81 | } 82 | return nil 83 | } 84 | 85 | func executeCommandBlock(commands map[string]CommandBlock, commandBlock *CommandBlock, args ...string) error { 86 | 87 | if err := validateDependencies(commands, commandBlock); err != nil { 88 | return err 89 | } 90 | 91 | for _, dep := range commandBlock.Dependencies { 92 | if _, ok := commands[dep]; !ok { 93 | return fmt.Errorf("%w: %s", ErrDependencyNotFound, dep) 94 | } 95 | dependency := commands[dep] 96 | if err := executeCommandBlock(commands, &dependency); err != nil { 97 | logrus.Debug(fmt.Sprintf("Executing command %s with args %v", dependency.Name, args)) 98 | return err 99 | } 100 | } 101 | 102 | for i, codeBlock := range commandBlock.CodeBlocks { 103 | logrus.Debug(fmt.Sprintf("Executing Code Block #%d", i)) 104 | 105 | var err error 106 | if i == 0 { 107 | err = executeCodeBlock(&codeBlock, args...) 108 | } else { 109 | err = executeCodeBlock(&codeBlock) 110 | } 111 | 112 | if err != nil { 113 | if codeBlock.Config.OnError == "ignore" { 114 | logrus.Debug(fmt.Sprintf("Ignoring error in command block %s (b/c on-error = ignore): %v", commandBlock.Name, err)) 115 | } else { 116 | return err 117 | } 118 | } 119 | } 120 | 121 | return nil 122 | 123 | } 124 | func executeCodeBlock(codeBlock *CodeBlock, args ...string) error { 125 | 126 | // Create a map for the template arguments 127 | argMap := make(map[string]string) 128 | for i, arg := range args { 129 | argMap[fmt.Sprintf("arg%d", i+1)] = arg 130 | } 131 | 132 | // Validate that all placeholders in the template are provided in args and vice versa 133 | placeholderPattern := regexp.MustCompile(`{{\s*\.arg(\d+)\s*}}`) 134 | matches := placeholderPattern.FindAllStringSubmatch(codeBlock.Code, -1) 135 | 136 | placeholderSet := make(map[string]struct{}) 137 | for _, match := range matches { 138 | placeholderSet[match[1]] = struct{}{} 139 | } 140 | 141 | for i := range args { 142 | argKey := fmt.Sprintf("%d", i+1) 143 | if _, ok := placeholderSet[argKey]; !ok { 144 | return fmt.Errorf("%w: argument: %d (\"%s\")", ErrArgProvidedButNotUsed, i+1, args[i]) 145 | } 146 | } 147 | 148 | for placeholder := range placeholderSet { 149 | argIndex := fmt.Sprintf("arg%s", placeholder) 150 | if _, ok := argMap[argIndex]; !ok { 151 | return fmt.Errorf("%w: {{.arg%s}}", ErrArgUsedInTemplateNotProvided, placeholder) 152 | } 153 | } 154 | 155 | tmpl, err := template.New("command").Parse(codeBlock.Code) 156 | if err != nil { 157 | return fmt.Errorf("failed to parse template: %v", err) 158 | } 159 | 160 | var renderedCode bytes.Buffer 161 | err = tmpl.Execute(&renderedCode, argMap) 162 | if err != nil { 163 | return fmt.Errorf("failed to execute template: %v", err) 164 | } 165 | 166 | launcher, ok := launchers[codeBlock.Lang] 167 | if !ok && !codeBlock.Config.SheBang { 168 | return fmt.Errorf("%w: %s", ErrNoInfostringOrShebang, codeBlock.Lang) 169 | } 170 | 171 | // Write the rendered code to the temporary file 172 | tmpFile, err := os.CreateTemp("", fmt.Sprintf("mdx-*.%s", launcher.extension)) 173 | if err != nil { 174 | return fmt.Errorf("failed to create temporary file: %v", err) 175 | } 176 | // Set the permissions of the temporary file to 755 177 | if err := os.Chmod(tmpFile.Name(), 0755); err != nil { 178 | return fmt.Errorf("failed to set permissions on temporary file: %v", err) 179 | } 180 | 181 | defer os.Remove(tmpFile.Name()) 182 | 183 | if !codeBlock.Config.SheBang { 184 | env := launchers["env"] 185 | if _, err := tmpFile.Write([]byte(fmt.Sprintf("#!%s %s\n", env.cmd, launcher.cmd))); err != nil { 186 | return fmt.Errorf("failed to write to temporary file: %v", err) 187 | } 188 | 189 | } 190 | if _, err := tmpFile.Write(renderedCode.Bytes()); err != nil { 191 | return fmt.Errorf("failed to write to temporary file: %v", err) 192 | } 193 | if err := tmpFile.Close(); err != nil { 194 | return fmt.Errorf("failed to close temporary file: %v", err) 195 | } 196 | 197 | cmd := exec.Command(tmpFile.Name()) 198 | cmd.Stdout = os.Stdout 199 | cmd.Stderr = os.Stderr 200 | 201 | cmd.Dir = os.Getenv("PWD") 202 | logrus.Debug(fmt.Sprintf("Executing command in directory: %s", cmd.Dir)) 203 | 204 | if err := cmd.Run(); err != nil { 205 | content, readErr := os.ReadFile(tmpFile.Name()) 206 | if readErr != nil { 207 | return fmt.Errorf("failed to execute command: %v, and failed to read temporary file: %v", err, readErr) 208 | } 209 | fmt.Fprintf(os.Stderr, "Error executing Code Block:\n%s\n", content) 210 | return fmt.Errorf("%w: %v", ErrCodeBlockExecFailed, err) 211 | } 212 | return nil 213 | } 214 | -------------------------------------------------------------------------------- /exec_test.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bytes" 5 | "errors" 6 | "io" 7 | "os" 8 | "strings" 9 | "testing" 10 | ) 11 | 12 | func captureOutput(f func() error, captureStderr bool) (string, error) { 13 | var buf bytes.Buffer 14 | stdout := os.Stdout 15 | stderr := os.Stderr 16 | r, w, _ := os.Pipe() 17 | os.Stdout = w 18 | if captureStderr { 19 | os.Stderr = w 20 | } 21 | 22 | err := f() 23 | 24 | w.Close() 25 | io.Copy(&buf, r) 26 | os.Stdout = stdout 27 | if captureStderr { 28 | os.Stderr = stderr 29 | } 30 | 31 | return buf.String(), err 32 | } 33 | 34 | func TestExecuteExecuteCommandBlock_ValidCodeBlockExecution(t *testing.T) { 35 | launchers = map[string]LauncherBlock{"sh": {"sh", "sh"}, "bash": {"sh", "sh"}, "env": {"/usr/bin/env", "env"}} 36 | commands := make(map[string]CommandBlock) 37 | 38 | commands["test"] = CommandBlock{ 39 | 40 | CodeBlocks: []CodeBlock{ 41 | { 42 | Lang: "sh", 43 | Code: `echo "Hello, {{.arg1}}"`, 44 | Config: ConfigBlock{SheBang: false}, 45 | }, 46 | { 47 | Lang: "sh", 48 | Code: `echo -n "Hello"`, 49 | Config: ConfigBlock{SheBang: false}, 50 | }, 51 | }, 52 | Dependencies: []string{}, 53 | Meta: map[string]interface{}{}, 54 | } 55 | args := []string{"World"} 56 | var wantErr error = nil 57 | 58 | commandBlock := commands["test"] 59 | output, err := captureOutput(func() error { 60 | return executeCommandBlock(commands, &commandBlock, args...) 61 | }, false) 62 | 63 | expectedOutput := "Hello, World\nHello" 64 | if output != expectedOutput { 65 | t.Errorf("executeCodeBlock() output = %v, expectedOutput %v", output, expectedOutput) 66 | } 67 | 68 | if wantErr != nil { 69 | if !errors.Is(err, wantErr) { 70 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 71 | } 72 | } else if err != nil { 73 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 74 | } 75 | } 76 | 77 | func TestExecuteExecuteCommandBlock_ValidCodeBlockExecutionTwoLayersDependencies(t *testing.T) { 78 | launchers = map[string]LauncherBlock{"sh": {"sh", "sh"}, "bash": {"sh", "sh"}, "env": {"/usr/bin/env", "env"}} 79 | commands := make(map[string]CommandBlock) 80 | 81 | commands["test"] = CommandBlock{ 82 | CodeBlocks: []CodeBlock{ 83 | { 84 | Lang: "sh", 85 | Code: `echo -n "!"`, 86 | Config: ConfigBlock{SheBang: false}, 87 | }, 88 | }, 89 | Dependencies: []string{"dep1"}, 90 | Meta: map[string]interface{}{}, 91 | } 92 | commands["dep1"] = CommandBlock{ 93 | CodeBlocks: []CodeBlock{ 94 | { 95 | Lang: "sh", 96 | Code: `echo -n "World"`, 97 | Config: ConfigBlock{SheBang: false}, 98 | }, 99 | }, 100 | Dependencies: []string{"dep2"}, 101 | Meta: map[string]interface{}{}, 102 | } 103 | commands["dep2"] = CommandBlock{ 104 | CodeBlocks: []CodeBlock{ 105 | { 106 | Lang: "sh", 107 | Code: `echo -n "Hello "`, 108 | Config: ConfigBlock{SheBang: false}, 109 | }, 110 | }, 111 | Dependencies: []string{}, 112 | Meta: map[string]interface{}{}, 113 | } 114 | args := []string{} 115 | var wantErr error = nil 116 | 117 | commandBlock := commands["test"] 118 | output, err := captureOutput(func() error { 119 | return executeCommandBlock(commands, &commandBlock, args...) 120 | }, false) 121 | 122 | expectedOutput := "Hello World!" 123 | if output != expectedOutput { 124 | t.Errorf("executeCodeBlock() output = %v, expectedOutput %v", output, expectedOutput) 125 | } 126 | 127 | if wantErr != nil { 128 | if !errors.Is(err, wantErr) { 129 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 130 | } 131 | } else if err != nil { 132 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 133 | } 134 | } 135 | 136 | func TestExecuteCodeBlock_ValidCodeBlockExecution(t *testing.T) { 137 | launchers = map[string]LauncherBlock{"sh": {"sh", "sh"}, "bash": {"sh", "sh"}, "env": {"/usr/bin/env", "env"}} 138 | codeBlock := CodeBlock{ 139 | Lang: "sh", 140 | Code: `echo "Hello, {{.arg1}}"`, 141 | Config: ConfigBlock{SheBang: false}, 142 | } 143 | args := []string{"World"} 144 | var wantErr error = nil 145 | 146 | output, err := captureOutput(func() error { 147 | return executeCodeBlock(&codeBlock, args...) 148 | }, false) 149 | 150 | expectedOutput := "Hello, World\n" 151 | if output != expectedOutput { 152 | t.Errorf("executeCodeBlock() output = %v, expectedOutput %v", output, expectedOutput) 153 | } 154 | 155 | if wantErr != nil { 156 | if !errors.Is(err, wantErr) { 157 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 158 | } 159 | } else if err != nil { 160 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 161 | } 162 | } 163 | 164 | func TestExecuteCodeBlock_ValidCodeBlockExecution_CWD(t *testing.T) { 165 | launchers = map[string]LauncherBlock{"sh": {"sh", "sh"}, "bash": {"sh", "sh"}, "env": {"/usr/bin/env", "env"}} 166 | codeBlock := CodeBlock{ 167 | Lang: "sh", 168 | Code: `echo "Hello, {{.arg1}}" > file.txt && cat ${PWD}/file.txt && rm file.txt`, 169 | Config: ConfigBlock{SheBang: false}, 170 | } 171 | args := []string{"World"} 172 | var wantErr error = nil 173 | 174 | output, err := captureOutput(func() error { 175 | return executeCodeBlock(&codeBlock, args...) 176 | }, false) 177 | 178 | expectedOutput := "Hello, World\n" 179 | if output != expectedOutput { 180 | t.Errorf("executeCodeBlock() output = %v, expectedOutput %v", output, expectedOutput) 181 | } 182 | 183 | if wantErr != nil { 184 | if !errors.Is(err, wantErr) { 185 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 186 | } 187 | } else if err != nil { 188 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 189 | } 190 | } 191 | 192 | func TestExecuteCodeBlock_ValidCodeBlockExecution_SheBang(t *testing.T) { 193 | launchers = map[string]LauncherBlock{"sh": {"sh", "sh"}, "bash": {"sh", "sh"}, "env": {"/usr/bin/env", "env"}} 194 | codeBlock := CodeBlock{ 195 | Lang: "sh", 196 | Code: "#!/bin/sh" + "\n" + `echo "Hello, {{.arg1}}"`, 197 | Config: ConfigBlock{SheBang: true}, 198 | } 199 | args := []string{"World"} 200 | var wantErr error = nil 201 | 202 | output, err := captureOutput(func() error { 203 | return executeCodeBlock(&codeBlock, args...) 204 | }, false) 205 | 206 | expectedOutput := "Hello, World\n" 207 | if output != expectedOutput { 208 | t.Errorf("executeCodeBlock() output = %v, expectedOutput %v", output, expectedOutput) 209 | } 210 | 211 | if wantErr != nil { 212 | if !errors.Is(err, wantErr) { 213 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 214 | } 215 | } else if err != nil { 216 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 217 | } 218 | } 219 | 220 | func TestExecuteCodeBlock_MissingArgument(t *testing.T) { 221 | codeBlock := CodeBlock{ 222 | Lang: "sh", 223 | Code: `echo "Hello, {{.arg1}}"`, 224 | Config: ConfigBlock{SheBang: false}, 225 | } 226 | args := []string{} 227 | wantErr := ErrArgUsedInTemplateNotProvided 228 | 229 | err := executeCodeBlock(&codeBlock, args...) 230 | 231 | if wantErr != nil { 232 | if !errors.Is(err, wantErr) { 233 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 234 | } 235 | } else if err != nil { 236 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 237 | } 238 | } 239 | 240 | func TestExecuteCodeBlock_UnusedArgument(t *testing.T) { 241 | codeBlock := CodeBlock{ 242 | Lang: "sh", 243 | Code: `echo "Hello, {{.arg1}}"`, 244 | Config: ConfigBlock{SheBang: false}, 245 | } 246 | args := []string{"World", "Extra"} 247 | wantErr := ErrArgProvidedButNotUsed 248 | 249 | err := executeCodeBlock(&codeBlock, args...) 250 | 251 | if wantErr != nil { 252 | if !errors.Is(err, wantErr) { 253 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 254 | } 255 | } else if err != nil { 256 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 257 | } 258 | } 259 | 260 | func TestExecuteCodeBlock_TemplateParsingError(t *testing.T) { 261 | codeBlock := CodeBlock{ 262 | Lang: "sh", 263 | Code: `echo "Hello, {{.arg1"`, // Missing closing braces 264 | Config: ConfigBlock{SheBang: false}, 265 | } 266 | args := []string{"World"} 267 | wantErr := ErrArgProvidedButNotUsed 268 | 269 | err := executeCodeBlock(&codeBlock, args...) 270 | 271 | if wantErr != nil { 272 | if !errors.Is(err, wantErr) { 273 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 274 | } 275 | } else if err != nil { 276 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 277 | } 278 | } 279 | 280 | func TestExecuteCodeBlock_LauncherNotDefined(t *testing.T) { 281 | codeBlock := CodeBlock{ 282 | Lang: "unknown", 283 | Code: `echo "Hello, {{.arg1}}"`, 284 | Config: ConfigBlock{SheBang: false}, 285 | } 286 | args := []string{"World"} 287 | wantErr := ErrNoInfostringOrShebang 288 | 289 | err := executeCodeBlock(&codeBlock, args...) 290 | 291 | if wantErr != nil { 292 | if !errors.Is(err, wantErr) { 293 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 294 | } 295 | } else if err != nil { 296 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 297 | } 298 | } 299 | 300 | func TestExecuteCodeBlock_DependencyMissing(t *testing.T) { 301 | launchers = map[string]LauncherBlock{"sh": {"sh", "sh"}, "bash": {"sh", "sh"}, "env": {"/usr/bin/env", "env"}} 302 | 303 | args := []string{} 304 | wantErr := ErrDependencyNotFound 305 | commands := map[string]CommandBlock{} 306 | loadCommands("tests/test_dependency_missing.md", commands) 307 | commandBlock := commands["cmd1"] 308 | output, err := captureOutput(func() error { 309 | return executeCommandBlock(commands, &commandBlock, args...) 310 | }, false) 311 | 312 | // This test would output Hello, if the availability of all deps is not validated before execution. 313 | expectedOutput := "" 314 | if output != expectedOutput { 315 | t.Errorf("executeCodeBlock() output = %v, expectedOutput %v", output, expectedOutput) 316 | } 317 | 318 | if wantErr != nil { 319 | if !errors.Is(err, wantErr) { 320 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 321 | } 322 | } else if err != nil { 323 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 324 | } 325 | } 326 | 327 | func TestExecuteCodeBlock_ConfigFailExecution(t *testing.T) { 328 | launchers = map[string]LauncherBlock{"sh": {"sh", "sh"}, "bash": {"sh", "sh"}, "env": {"/usr/bin/env", "env"}} 329 | 330 | args := []string{} 331 | var wantErr error = ErrCodeBlockExecFailed 332 | commands := map[string]CommandBlock{} 333 | loadCommands("tests/test_config_fail.md", commands) 334 | commandBlock := commands["cmd"] 335 | output, err := captureOutput(func() error { 336 | return executeCommandBlock(commands, &commandBlock, args...) 337 | }, false) 338 | 339 | // This test would output Hello, if the availability of all deps is not validated before execution. 340 | expectedOutput := "hello" 341 | if output != expectedOutput { 342 | t.Errorf("executeCodeBlock() output = %v, expectedOutput %v", output, expectedOutput) 343 | } 344 | 345 | if wantErr != nil { 346 | if !errors.Is(err, wantErr) { 347 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 348 | } 349 | } else if err != nil { 350 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 351 | } 352 | } 353 | 354 | func TestExecuteCodeBlock_ConfigIgnoreError(t *testing.T) { 355 | launchers = map[string]LauncherBlock{"sh": {"sh", "sh"}, "bash": {"sh", "sh"}, "env": {"/usr/bin/env", "env"}} 356 | 357 | args := []string{} 358 | var wantErr error = nil 359 | commands := map[string]CommandBlock{} 360 | loadCommands("tests/test_config_ignore.md", commands) 361 | commandBlock := commands["cmd"] 362 | output, err := captureOutput(func() error { 363 | return executeCommandBlock(commands, &commandBlock, args...) 364 | }, false) 365 | 366 | // This test would output Hello, if the availability of all deps is not validated before execution. 367 | expectedOutput := "hello world" 368 | if output != expectedOutput { 369 | t.Errorf("executeCodeBlock() output = %v, expectedOutput %v", output, expectedOutput) 370 | } 371 | 372 | if wantErr != nil { 373 | if !errors.Is(err, wantErr) { 374 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 375 | } 376 | } else if err != nil { 377 | t.Errorf("executeCodeBlock() error = %v, wantErr %v", err, wantErr) 378 | } 379 | } 380 | 381 | func TestLoadLaunchers(t *testing.T) { 382 | err := loadLaunchers() 383 | for _, launcher := range launchers { 384 | if !strings.HasPrefix(launcher.cmd, "/") { 385 | t.Errorf("launcher.Cmd = %v, expected to start with '/'", launcher.cmd) 386 | } 387 | } 388 | 389 | if _, ok := launchers["sh"]; !ok { 390 | t.Errorf("Expected launcher for 'sh' to be defined") 391 | } 392 | 393 | if _, ok := launchers["py"]; !ok { 394 | t.Errorf("Expected launcher for 'py' to be defined") 395 | } 396 | if _, ok := launchers["env"]; !ok { 397 | t.Errorf("Expected launcher for 'env' to be defined") 398 | } 399 | 400 | if err != nil { 401 | t.Errorf("loadLaunchers() error = %v, wantErr %v", err, nil) 402 | } 403 | } 404 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module mdx 2 | 3 | go 1.23.2 4 | 5 | require ( 6 | github.com/sirupsen/logrus v1.9.3 7 | github.com/yuin/goldmark v1.7.7 8 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c 9 | ) 10 | 11 | require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect 12 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 2 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 3 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 4 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 5 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 6 | github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= 7 | github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= 8 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 9 | github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= 10 | github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 11 | github.com/yuin/goldmark v1.7.7 h1:5m9rrB1sW3JUMToKFQfb+FGt1U7r57IHu5GrYrG2nqU= 12 | github.com/yuin/goldmark v1.7.7/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E= 13 | golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ= 14 | golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 15 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 16 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 17 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= 18 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 19 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "os" 7 | "path/filepath" 8 | 9 | "github.com/sirupsen/logrus" 10 | ) 11 | 12 | func setLogLevel() { 13 | logLevel := os.Getenv("MDX_LOG_LEVEL") 14 | switch logLevel { 15 | case "DEBUG": 16 | logrus.SetLevel(logrus.DebugLevel) 17 | case "INFO": 18 | logrus.SetLevel(logrus.InfoLevel) 19 | case "ERROR": 20 | logrus.SetLevel(logrus.ErrorLevel) 21 | default: 22 | logrus.SetLevel(logrus.WarnLevel) 23 | } 24 | } 25 | 26 | func errorExit(format string, args ...interface{}) { 27 | fmt.Fprintf(os.Stderr, format+"\n", args...) 28 | os.Exit(1) 29 | } 30 | 31 | /* 32 | getMarkdownFilePaths returns a list of markdown files to load commands from. 33 | The order of precedence is: 34 | 1. The file flag 35 | 2. The MDX_FILE_DIR environment variable 36 | 3. The MDX_FILE_PATH environment variable 37 | 4. The current working directory 38 | */ 39 | func getMarkdownFilePaths(fileFlag string) []string { 40 | var mdFiles []string 41 | if fileFlag != "" { 42 | logrus.Debug("using file flag to find markdown files") 43 | mdFiles = []string{fileFlag} 44 | 45 | } else if mdxFileDir := os.Getenv("MDX_FILE_DIR"); mdxFileDir != "" { 46 | logrus.Debug("using MDX_FILE_DIR") 47 | var err error 48 | mdFiles, err = filepath.Glob(filepath.Join(mdxFileDir, "*.md")) 49 | logrus.Debug(fmt.Sprintf("Searching for markdown files in %s", mdxFileDir)) 50 | if err != nil { 51 | errorExit("Error searching for markdown files in %s: %v", mdxFileDir, err) 52 | } 53 | } else if mdxFilePath := os.Getenv("MDX_FILE_PATH"); mdxFilePath != "" { 54 | logrus.Debug("using MDX_FILE_PATH") 55 | var err error 56 | mdFiles = []string{mdxFilePath} 57 | logrus.Debug(fmt.Sprintf("Searching in markdown file %s", mdxFilePath)) 58 | if err != nil { 59 | errorExit("Error searching for markdown files in %s: %v", mdxFilePath, err) 60 | } 61 | } else { 62 | logrus.Debug("using CWD to find markdown files") 63 | var err error 64 | mdFiles, err = filepath.Glob("*.md") 65 | if err != nil { 66 | errorExit("Error searching for markdown files: %v", err) 67 | } 68 | } 69 | 70 | if len(mdFiles) == 0 { 71 | errorExit("No markdown files found") 72 | } 73 | return mdFiles 74 | } 75 | 76 | // Defaults for ConfigBlock are set in findHeadingWalker 77 | type ConfigBlock struct { 78 | OnError string // Valid OnError values are 'ignore' and 'fail'. Default is 'ignore' 79 | SheBang bool 80 | } 81 | 82 | type CodeBlock struct { 83 | Lang string // the infostring from the code fence 84 | Code string // the content of the code fence 85 | Config ConfigBlock // contains metadata for the code block 86 | 87 | } 88 | 89 | // CommandBlock represents a heading, which contains one to multiple code fences. 90 | type CommandBlock struct { 91 | Name string // the name of the command, same as the key in the commands map 92 | Dependencies []string // commands to execute before this command 93 | CodeBlocks []CodeBlock // the code fences below the heading 94 | Filename string // the filename of the markdown file 95 | Meta map[string]any // placeholder for the future 96 | } 97 | 98 | func listCommands(commands map[string]CommandBlock) { 99 | fmt.Println("Available commands:") 100 | for name, command := range commands { 101 | if len(command.Dependencies) > 0 { 102 | fmt.Printf("%s: %s (%s)\n", name, command.Dependencies, command.Filename) 103 | } else { 104 | fmt.Printf("%s (%s)\n", name, command.Filename) 105 | } 106 | } 107 | } 108 | 109 | func main() { 110 | setLogLevel() 111 | fileFlag := flag.String("file", "", "Specify a markdown file") 112 | fileFlagShort := flag.String("f", "", "Specify a markdown file (shorthand)") 113 | listFlag := flag.Bool("list", false, "list commands") 114 | listFlagShort := flag.Bool("l", false, "list commands (shorthand)") 115 | listLaunchersFlag := flag.Bool("list-launchers", false, "list commands") 116 | listLaunchersFlagShort := flag.Bool("ll", false, "list commands (shorthand)") 117 | flag.Parse() 118 | 119 | if *fileFlagShort != "" { 120 | fileFlag = fileFlagShort 121 | } 122 | 123 | if *listFlagShort { 124 | listFlag = listFlagShort 125 | } 126 | 127 | if *listLaunchersFlagShort { 128 | listLaunchersFlag = listLaunchersFlagShort 129 | } 130 | 131 | logrus.Debug("MDX started with parameters:", os.Args) 132 | 133 | // Check for subcommands 134 | if flag.NArg() < 1 && !*listFlag && !*listLaunchersFlag { 135 | errorExit("Usage: mdx [-file ] [-list] [args]") 136 | } 137 | 138 | commandName := flag.Arg(0) 139 | commandArgs := []string{} 140 | if flag.NArg() > 1 { 141 | commandArgs = flag.Args()[1:] 142 | } 143 | 144 | if error := loadLaunchers(); error != nil { 145 | errorExit("Error loading launchers: %v", error) 146 | } 147 | 148 | if *listLaunchersFlag { 149 | listLaunchers() 150 | os.Exit(0) 151 | } 152 | 153 | var commands = map[string]CommandBlock{} 154 | 155 | mdFiles := getMarkdownFilePaths(*fileFlag) 156 | for _, mdFile := range mdFiles { 157 | logrus.Debug(fmt.Sprintf("Loading file %s", mdFile)) 158 | err := loadCommands(mdFile, commands) 159 | if err != nil { 160 | errorExit("Error loading commands from %s: %v", mdFile, err) 161 | } 162 | } 163 | 164 | if *listFlag { 165 | listCommands(commands) 166 | os.Exit(0) 167 | } 168 | 169 | if command, ok := commands[commandName]; ok { 170 | err := executeCommandBlock(commands, &command, commandArgs...) 171 | if err != nil { 172 | errorExit("Error executing command: %v", err) 173 | } 174 | } else { 175 | errorExit("Command not found: %s", commandName) 176 | } 177 | } 178 | -------------------------------------------------------------------------------- /main_test.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "os" 5 | "path/filepath" 6 | "reflect" 7 | "testing" 8 | ) 9 | 10 | func TestGetMarkdownFilePaths_FileFlag(t *testing.T) { 11 | mdFiles := getMarkdownFilePaths("test.md") 12 | if !reflect.DeepEqual(mdFiles, []string{"test.md"}) { 13 | t.Errorf("Expected %v, but got %v", []string{"test.md"}, mdFiles) 14 | } 15 | } 16 | 17 | func TestGetMarkdownFilePaths_MDXFileDir(t *testing.T) { 18 | os.Setenv("MDX_FILE_DIR", "TestGetMarkdownFilePaths_MDXFileDir") 19 | defer os.Unsetenv("MDX_FILE_DIR") 20 | 21 | // Create test directory and files 22 | os.Mkdir("TestGetMarkdownFilePaths_MDXFileDir", 0755) 23 | defer os.RemoveAll("TestGetMarkdownFilePaths_MDXFileDir") 24 | os.Create("TestGetMarkdownFilePaths_MDXFileDir/test1.md") 25 | os.Create("TestGetMarkdownFilePaths_MDXFileDir/test2.md") 26 | 27 | mdFiles := getMarkdownFilePaths("") 28 | expectedFiles, _ := filepath.Glob("TestGetMarkdownFilePaths_MDXFileDir/*.md") 29 | if !reflect.DeepEqual(mdFiles, expectedFiles) { 30 | t.Errorf("Expected %v, but got %v", expectedFiles, mdFiles) 31 | } 32 | } 33 | 34 | func TestGetMarkdownFilePaths_MDXFilePath(t *testing.T) { 35 | os.Setenv("MDX_FILE_PATH", "test.md") 36 | defer os.Unsetenv("MDX_FILE_PATH") 37 | 38 | mdFiles := getMarkdownFilePaths("") 39 | if !reflect.DeepEqual(mdFiles, []string{"test.md"}) { 40 | t.Errorf("Expected %v, but got %v", []string{"test.md"}, mdFiles) 41 | } 42 | } 43 | 44 | func TestGetMarkdownFilePaths_EnvAllDefined(t *testing.T) { 45 | os.Setenv("MDX_FILE_DIR", "testdir") 46 | defer os.Unsetenv("MDX_FILE_DIR") 47 | 48 | // Create test directory and files 49 | os.Mkdir("testdir", 0755) 50 | defer os.RemoveAll("testdir") 51 | os.Create("testdir/test1.md") 52 | os.Create("testdir/test2.md") 53 | 54 | os.Setenv("MDX_FILE_PATH", "test3.md") 55 | defer os.Unsetenv("MDX_FILE_PATH") 56 | 57 | mdFiles := getMarkdownFilePaths("") 58 | if !reflect.DeepEqual(mdFiles, []string{"testdir/test1.md", "testdir/test2.md"}) { 59 | t.Errorf("Expected %v, but got %v", []string{"testdir/test1.md", "testdir/test2.md"}, mdFiles) 60 | } 61 | } 62 | 63 | func TestGetMarkdownFilePaths_AllDefined(t *testing.T) { 64 | os.Setenv("MDX_FILE_DIR", "testdir") 65 | defer os.Unsetenv("MDX_FILE_DIR") 66 | 67 | // Create test directory and files 68 | os.Mkdir("testdir", 0755) 69 | defer os.RemoveAll("testdir") 70 | os.Create("testdir/test1.md") 71 | os.Create("testdir/test2.md") 72 | 73 | os.Setenv("MDX_FILE_PATH", "test3.md") 74 | defer os.Unsetenv("MDX_FILE_PATH") 75 | 76 | mdFiles := getMarkdownFilePaths("ff.md") 77 | if !reflect.DeepEqual(mdFiles, []string{"ff.md"}) { 78 | t.Errorf("Expected %v, but got %v", []string{"ff.md"}, mdFiles) 79 | } 80 | 81 | } 82 | -------------------------------------------------------------------------------- /parser.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "regexp" 7 | "strings" 8 | 9 | "github.com/sirupsen/logrus" 10 | "github.com/yuin/goldmark" 11 | "github.com/yuin/goldmark/ast" 12 | "github.com/yuin/goldmark/parser" 13 | "github.com/yuin/goldmark/text" 14 | "github.com/yuin/goldmark/util" 15 | "gopkg.in/yaml.v3" 16 | ) 17 | 18 | type MdxHeading struct { 19 | ast.BaseBlock 20 | commandName string 21 | deps []string 22 | } 23 | 24 | func (b *MdxHeading) Dump(source []byte, level int) { 25 | ast.DumpHelper(b, source, level, nil, nil) 26 | } 27 | 28 | func (b *MdxHeading) Kind() ast.NodeKind { 29 | return KindMdxHeading 30 | } 31 | 32 | var KindMdxHeading = ast.NewNodeKind("MdxHeading") 33 | 34 | type MdxHeadingParser struct{} 35 | 36 | func (p *MdxHeadingParser) Trigger() []byte { 37 | return []byte{'#'} 38 | } 39 | 40 | func (p *MdxHeadingParser) Open(parent ast.Node, reader text.Reader, pc parser.Context) (ast.Node, parser.State) { 41 | line, _ := reader.PeekLine() 42 | commandName, deps := extractCommandAndDepsFromHeading(string(line)) 43 | 44 | if commandName == "" { 45 | logrus.Debug(fmt.Sprintf("No command found in heading: %s", line)) 46 | return nil, parser.NoChildren 47 | } 48 | 49 | reader.Advance(len(line)) 50 | return &MdxHeading{commandName: commandName, deps: deps}, parser.NoChildren 51 | } 52 | 53 | func (p *MdxHeadingParser) Continue(node ast.Node, reader text.Reader, pc parser.Context) parser.State { 54 | return parser.Close 55 | } 56 | 57 | func (p *MdxHeadingParser) Close(node ast.Node, reader text.Reader, pc parser.Context) { 58 | } 59 | 60 | func (p *MdxHeadingParser) CanInterruptParagraph() bool { 61 | return false 62 | } 63 | 64 | func (p *MdxHeadingParser) CanAcceptIndentedLine() bool { 65 | return false 66 | } 67 | 68 | /* 69 | extractCommandAndDepsFromHeading extracts the command name and dependencies from the given heading and source. 70 | The command name is extracted from the link text and the dependencies are extracted from the link destination. 71 | 72 | [commandName](dep1 dep2 dep3) => commandName, [dep1, dep2, dep3] 73 | */ 74 | 75 | func extractCommandAndDepsFromHeading(heading string) (string, []string) { 76 | 77 | // NOTE: goldmark does not support parsing links inside of a heading. 78 | // We have to use a regular expression to extract the command name and dependencies. 79 | re := regexp.MustCompile(`\[([^\]]+)\]\((?:([^)]*))?\)`) 80 | matches := re.FindStringSubmatch(heading) 81 | if len(matches) < 2 { 82 | return "", nil 83 | } 84 | 85 | // matches[1] is the text inside the square brackets 86 | // matches[2] is the URL inside the parentheses (if present) 87 | text := matches[1] 88 | commandName := strings.TrimSpace(text) 89 | var url string 90 | if len(matches) > 2 { 91 | url = matches[2] 92 | depsString := strings.TrimSpace(url) 93 | deps := strings.Fields(depsString) 94 | return commandName, deps 95 | } 96 | 97 | return commandName, []string{} 98 | } 99 | 100 | func loadCommands(markdownFile string, commands map[string]CommandBlock) error { 101 | /* 102 | The search strategy is as follows. We start at the beginning of the document, parse the Markdown file into an AST and walk the tree: 103 | 104 | 1 We search for a heading. (findHeadingWalker) 105 | 2 If we find a heading, we walk all siblings of the heading and call parseCodeBlock for all FencedCodeBlock nodes and parseConfigBlock for all FencedCodeBlock nodes with the language 'mdx'. 106 | praseCodeBlock extacts the code from the code block, updates the currentCommandBlock and appends the code block to the currentCommandBlock.CodeBlocks. 107 | 3 Goto 1. 108 | */ 109 | source, err := os.ReadFile(markdownFile) 110 | if err != nil { 111 | return err 112 | } 113 | 114 | md := goldmark.New( 115 | goldmark.WithParserOptions( 116 | parser.WithBlockParsers( 117 | util.Prioritized(&MdxHeadingParser{}, 0), 118 | ), 119 | ), 120 | ) 121 | reader := text.NewReader(source) 122 | doc := md.Parser().Parse(reader) 123 | 124 | var currentCommandBlock CommandBlock 125 | var currentConfigBlock ConfigBlock 126 | 127 | parseCodeBlock := func(n ast.Node) error { 128 | 129 | if block, ok := n.(*ast.FencedCodeBlock); ok { 130 | 131 | lang := string(block.Language(source)) 132 | code := string(block.Text(source)) 133 | 134 | if code == "" { 135 | logrus.Warn(fmt.Sprintf("Empty code block found for command '%s' in '%s'.", currentCommandBlock.Name, markdownFile)) 136 | return nil 137 | } 138 | code_shebang := false 139 | if len(code) >= 2 && code[:2] == "#!" { 140 | code_shebang = true 141 | } 142 | 143 | if lang == "" && !code_shebang { 144 | logrus.Warn(fmt.Sprintf("Found Code Block with no infostring and no shebang defined for command '%s' in '%s'. Ignoring", currentCommandBlock.Name, markdownFile)) 145 | return nil 146 | } 147 | 148 | if lang != "" && !code_shebang { 149 | logrus.Debug(fmt.Sprintf("No language defined for command '%s' in '%s'. Using shebang!", currentCommandBlock.Name, markdownFile)) 150 | if _, ok := launchers[lang]; !ok { 151 | return fmt.Errorf("%w: %s", ErrNoLauncherDefined, lang) 152 | } 153 | } 154 | 155 | if lang != "" && code_shebang { 156 | logrus.Warn(fmt.Sprintf("Both language and shebang defined for command '%s' in '%s'. The shebang will be used!", currentCommandBlock.Name, markdownFile)) 157 | } 158 | 159 | codeBlock := CodeBlock{ 160 | Lang: lang, 161 | Code: code, 162 | Config: ConfigBlock{}, 163 | } 164 | codeBlock.Config.SheBang = code_shebang 165 | codeBlock.Config.OnError = currentConfigBlock.OnError 166 | 167 | currentCommandBlock.CodeBlocks = append(currentCommandBlock.CodeBlocks, codeBlock) 168 | logrus.Debug(fmt.Sprintf("Wrote new code block. Infostring: '%s', Command: '%s'", lang, currentCommandBlock.Name)) 169 | } 170 | 171 | return nil 172 | } 173 | 174 | parseConfigBlock := func(n ast.Node) error { 175 | // Called when a FencedCodeBlock with the language 'mdx' is found. 176 | if block, ok := n.(*ast.FencedCodeBlock); ok { 177 | mdxConfig := make(map[string]any) 178 | code := string(block.Text(source)) 179 | if err := yaml.Unmarshal([]byte(code), &mdxConfig); err != nil { 180 | return fmt.Errorf("failed to unmarshal YAML: %w", err) 181 | } 182 | logrus.Debug(fmt.Sprintf("Found config block: %v", mdxConfig)) 183 | if config, ok := mdxConfig["config"].(map[string]interface{}); ok { 184 | if onError, ok := config["on-error"].(string); ok { 185 | if onError == "ignore" || onError == "fail" { 186 | currentConfigBlock.OnError = onError 187 | } else { 188 | logrus.Warn(fmt.Sprintf("Invalid value for onError: '%s'. Using default 'ignore'.", onError)) 189 | } 190 | } 191 | } 192 | return nil 193 | } 194 | return fmt.Errorf("node is not a FencedCodeBlock") 195 | } 196 | 197 | findHeadingWalker := func(n ast.Node, entering bool) (ast.WalkStatus, error) { 198 | if heading, ok := n.(*MdxHeading); ok && entering { 199 | currentCommandBlock = CommandBlock{} 200 | currentCommandBlock.Filename = markdownFile 201 | currentCommandBlock.Meta = make(map[string]any) 202 | currentCommandBlock.CodeBlocks = []CodeBlock{} 203 | currentCommandBlock.Name = heading.commandName 204 | currentCommandBlock.Dependencies = heading.deps 205 | 206 | // Reset the config block. Defaults are defined here. 207 | // parseConfigBlock will update the currentConfigBlock if a config block is found. 208 | // parseCodeBlock will use the currentConfigBlock to update the ConfigBlock of the CodeBlock. 209 | currentConfigBlock = ConfigBlock{OnError: "ignore"} 210 | 211 | if _, exists := commands[currentCommandBlock.Name]; exists { 212 | return ast.WalkStop, fmt.Errorf("%w: '%s' was already defined in '%s'", ErrDuplicateCommand, currentCommandBlock.Name, commands[currentCommandBlock.Name].Filename) 213 | } 214 | 215 | logrus.Debug(fmt.Sprintf("Found heading with command: '%s' and dependencies: %v", currentCommandBlock.Name, currentCommandBlock.Dependencies)) 216 | // findCodeBlocksWalker will extract the code blocks below this heading 217 | // and append them to the currentCommandBlock.CodeBlocks 218 | 219 | for sibling := heading.NextSibling(); sibling != nil; sibling = sibling.NextSibling() { 220 | if _, ok := sibling.(*ast.Heading); ok { 221 | break 222 | } 223 | if _, ok := sibling.(*MdxHeading); ok { 224 | break 225 | } 226 | if _, ok := sibling.(*ast.FencedCodeBlock); ok { 227 | lang := string(sibling.(*ast.FencedCodeBlock).Language(source)) 228 | if lang == "mdx" { 229 | err = parseConfigBlock(sibling) 230 | } else { 231 | err = parseCodeBlock(sibling) 232 | } 233 | } 234 | if err != nil { 235 | return ast.WalkStop, err 236 | } 237 | } 238 | 239 | if len(currentCommandBlock.CodeBlocks) > 0 { 240 | commands[currentCommandBlock.Name] = currentCommandBlock 241 | } else { 242 | logrus.Debug(fmt.Sprintf("No code blocks found for command '%s' in '%s'.", currentCommandBlock.Name, markdownFile)) 243 | } 244 | 245 | } 246 | return ast.WalkContinue, nil 247 | } 248 | 249 | return ast.Walk(doc, findHeadingWalker) 250 | } 251 | -------------------------------------------------------------------------------- /parser_test.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "errors" 5 | "reflect" 6 | "strings" 7 | "testing" 8 | ) 9 | 10 | func TestExtractCommandAndDepsFromHeading(t *testing.T) { 11 | tests := []struct { 12 | heading string 13 | expectedCmd string 14 | expectedDeps []string 15 | }{ 16 | { 17 | heading: "[commandName](dep1 dep2 dep3)", 18 | expectedCmd: "commandName", 19 | expectedDeps: []string{"dep1", "dep2", "dep3"}, 20 | }, 21 | { 22 | heading: "# This is a heading [commandName](dep1 dep2 dep3) with some text", 23 | expectedCmd: "commandName", 24 | expectedDeps: []string{"dep1", "dep2", "dep3"}, 25 | }, 26 | { 27 | heading: "[commandName]()", 28 | expectedCmd: "commandName", 29 | expectedDeps: []string{}, 30 | }, 31 | { 32 | heading: "[commandName]", 33 | expectedCmd: "", 34 | expectedDeps: nil, 35 | }, 36 | { 37 | heading: "[commandName](dep1)", 38 | expectedCmd: "commandName", 39 | expectedDeps: []string{"dep1"}, 40 | }, 41 | { 42 | heading: "NoCommand", 43 | expectedCmd: "", 44 | expectedDeps: nil, 45 | }, 46 | { 47 | heading: "[commandName]( dep1 dep2 dep3 )", 48 | expectedCmd: "commandName", 49 | expectedDeps: []string{"dep1", "dep2", "dep3"}, 50 | }, 51 | { 52 | heading: "[commandName](dep1, dep2, dep3)", 53 | expectedCmd: "commandName", 54 | expectedDeps: []string{"dep1,", "dep2,", "dep3"}, 55 | }, 56 | } 57 | 58 | for _, test := range tests { 59 | cmd, deps := extractCommandAndDepsFromHeading(test.heading) 60 | if cmd != test.expectedCmd { 61 | t.Errorf("extractCommandAndDepsFromHeading(%q) = %q; want %q", test.heading, cmd, test.expectedCmd) 62 | } 63 | if !reflect.DeepEqual(deps, test.expectedDeps) { 64 | t.Errorf("extractCommandAndDepsFromHeading(%q) = %v; want %v", test.heading, deps, test.expectedDeps) 65 | } 66 | } 67 | } 68 | 69 | type FileParseTest struct { 70 | filePath string 71 | expectedCmds map[string]CommandBlock 72 | expectedErr error 73 | } 74 | 75 | func RunFileParseTest(t *testing.T, tt *FileParseTest) { 76 | t.Run(tt.filePath, func(t *testing.T) { 77 | commands := map[string]CommandBlock{} 78 | err := loadCommands(tt.filePath, commands) 79 | 80 | if (err != nil || tt.expectedErr != nil) && !errors.Is(err, tt.expectedErr) { 81 | t.Fatalf("expected error %v, got %v", tt.expectedErr, err) 82 | return 83 | } 84 | if (err != nil || tt.expectedErr != nil) && errors.Is(err, tt.expectedErr) { 85 | return 86 | } 87 | 88 | if len(commands) != len(tt.expectedCmds) { 89 | t.Fatalf("expected %d commands, got %d", len(tt.expectedCmds), len(commands)) 90 | } 91 | 92 | for name, expectedCmd := range tt.expectedCmds { 93 | actualCmd, ok := commands[name] 94 | if !ok { 95 | t.Fatalf("expected command %s to be present", name) 96 | } 97 | 98 | for i, expectedCodeBlock := range expectedCmd.CodeBlocks { 99 | actualCodeBlock := actualCmd.CodeBlocks[i] 100 | if actualCodeBlock.Lang != expectedCodeBlock.Lang { 101 | t.Fatalf("expected lang %s, got %s", expectedCodeBlock.Lang, actualCodeBlock.Lang) 102 | } 103 | 104 | if strings.TrimSpace(actualCodeBlock.Code) != strings.TrimSpace(expectedCodeBlock.Code) { 105 | t.Fatalf("expected code %s, got %s", expectedCodeBlock.Code, actualCodeBlock.Code) 106 | } 107 | 108 | if !reflect.DeepEqual(actualCodeBlock.Config, expectedCodeBlock.Config) { 109 | t.Fatalf("expected config %v, got %v", expectedCodeBlock.Config, actualCodeBlock.Config) 110 | } 111 | } 112 | 113 | if !reflect.DeepEqual(actualCmd.Dependencies, expectedCmd.Dependencies) { 114 | t.Fatalf("expected dependencies %v, got %v", expectedCmd.Dependencies, actualCmd.Dependencies) 115 | } 116 | 117 | if !reflect.DeepEqual(actualCmd.Meta, expectedCmd.Meta) { 118 | t.Fatalf("expected meta %v, got %v", expectedCmd.Meta, actualCmd.Meta) 119 | } 120 | } 121 | }) 122 | 123 | } 124 | func TestOneCommandWithDeps(t *testing.T) { 125 | test := &FileParseTest{ 126 | filePath: "tests/test1.md", 127 | expectedCmds: map[string]CommandBlock{ 128 | "simple_echo": { 129 | CodeBlocks: []CodeBlock{{ 130 | Lang: "sh", 131 | Code: "echo \"{{.arg1}} {{.arg2}}\"", 132 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 133 | }}, 134 | Dependencies: []string{"dep1", "dep2"}, 135 | Meta: map[string]interface{}{}, 136 | }, 137 | }, 138 | expectedErr: nil, 139 | } 140 | RunFileParseTest(t, test) 141 | } 142 | 143 | func TestTwoCommands(t *testing.T) { 144 | test := &FileParseTest{ 145 | filePath: "tests/two_commands.md", 146 | expectedCmds: map[string]CommandBlock{ 147 | "simple_echo1": { 148 | CodeBlocks: []CodeBlock{{ 149 | Lang: "sh", 150 | Code: "code1", 151 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 152 | }}, 153 | Dependencies: []string{"dep1"}, 154 | Meta: map[string]interface{}{}, 155 | }, 156 | "simple_echo2": { 157 | CodeBlocks: []CodeBlock{{ 158 | Lang: "sh", 159 | Code: "code2", 160 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 161 | }}, 162 | Dependencies: []string{"dep1", "dep2"}, 163 | Meta: map[string]interface{}{}, 164 | }, 165 | }, 166 | expectedErr: nil, 167 | } 168 | RunFileParseTest(t, test) 169 | } 170 | 171 | func TestOneCommandTwoCodeBlocks(t *testing.T) { 172 | test := &FileParseTest{ 173 | filePath: "tests/one_command_two_code_blocks.md", 174 | expectedCmds: map[string]CommandBlock{ 175 | "simple_echo1": { 176 | CodeBlocks: []CodeBlock{ 177 | { 178 | Lang: "sh", 179 | Code: "code1", 180 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 181 | }, 182 | { 183 | Lang: "python", 184 | Code: "#!/bin/venv/python\ncode2", 185 | Config: ConfigBlock{SheBang: true, OnError: "ignore"}, 186 | }, 187 | }, 188 | Dependencies: []string{"dep1"}, 189 | Meta: map[string]interface{}{}, 190 | }, 191 | }, 192 | expectedErr: nil, 193 | } 194 | RunFileParseTest(t, test) 195 | } 196 | 197 | func TestTwoCommandsTwoCodeBlocks(t *testing.T) { 198 | test := &FileParseTest{ 199 | filePath: "tests/two_commands_two_code_blocks.md", 200 | expectedCmds: map[string]CommandBlock{ 201 | "simple_echo1": { 202 | CodeBlocks: []CodeBlock{ 203 | { 204 | Lang: "sh", 205 | Code: "code1", 206 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 207 | }, 208 | { 209 | Lang: "python", 210 | Code: "#!/bin/venv/python\ncode2", 211 | Config: ConfigBlock{SheBang: true, OnError: "ignore"}, 212 | }, 213 | }, 214 | Dependencies: []string{"dep1"}, 215 | Meta: map[string]interface{}{}, 216 | }, 217 | "simple_echo2": { 218 | CodeBlocks: []CodeBlock{ 219 | { 220 | Lang: "sh", 221 | Code: "code1", 222 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 223 | }, 224 | { 225 | Lang: "python", 226 | Code: "#!/bin/venv/python\ncode2", 227 | Config: ConfigBlock{SheBang: true, OnError: "ignore"}, 228 | }, 229 | }, 230 | Dependencies: []string{}, 231 | Meta: map[string]interface{}{}, 232 | }, 233 | }, 234 | expectedErr: nil, 235 | } 236 | RunFileParseTest(t, test) 237 | } 238 | 239 | func TestParseShebang(t *testing.T) { 240 | test := &FileParseTest{ 241 | filePath: "tests/test2.md", 242 | expectedCmds: map[string]CommandBlock{ 243 | "simple_echo": { 244 | CodeBlocks: []CodeBlock{{ 245 | Lang: "", 246 | Code: "#!/my/python\nprint(blubb)", 247 | Config: ConfigBlock{SheBang: true, OnError: "ignore"}, 248 | }}, 249 | Dependencies: []string{}, 250 | Meta: map[string]interface{}{}, 251 | }, 252 | }, 253 | expectedErr: nil, 254 | } 255 | RunFileParseTest(t, test) 256 | } 257 | 258 | func TestNoLauncherDefined(t *testing.T) { 259 | test := &FileParseTest{ 260 | filePath: "tests/test_no_launcher_defined.md", 261 | expectedCmds: map[string]CommandBlock{ 262 | "cmd": { 263 | CodeBlocks: []CodeBlock{{ 264 | Lang: "na", 265 | Code: "command", 266 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 267 | }}, 268 | Dependencies: []string{}, 269 | Meta: map[string]interface{}{}, 270 | }, 271 | }, 272 | expectedErr: ErrNoLauncherDefined, 273 | } 274 | RunFileParseTest(t, test) 275 | } 276 | 277 | func TestTwoCommandHaveSameName(t *testing.T) { 278 | test := &FileParseTest{ 279 | filePath: "tests/err_same_command_name.md", 280 | expectedCmds: nil, 281 | expectedErr: ErrDuplicateCommand, 282 | } 283 | RunFileParseTest(t, test) 284 | } 285 | 286 | func TestNoShebangNoInfostringDefined(t *testing.T) { 287 | test := &FileParseTest{ 288 | filePath: "tests/err_no_shebang_no_infostring.md", 289 | expectedCmds: nil, 290 | expectedErr: nil, 291 | } 292 | RunFileParseTest(t, test) 293 | 294 | } 295 | 296 | func TestNoCodeInCodeFence(t *testing.T) { 297 | test := &FileParseTest{ 298 | filePath: "tests/no_code_in_codefence.md", 299 | expectedCmds: nil, 300 | expectedErr: nil, 301 | } 302 | RunFileParseTest(t, test) 303 | 304 | } 305 | 306 | func TestLoadMDXConfig(t *testing.T) { 307 | test := &FileParseTest{ 308 | filePath: "tests/test_config.md", 309 | expectedCmds: map[string]CommandBlock{ 310 | "cmd": { 311 | CodeBlocks: []CodeBlock{{ 312 | Lang: "sh", 313 | Code: "echo\n", 314 | Config: ConfigBlock{SheBang: false, OnError: "fail"}, 315 | }, 316 | { 317 | Lang: "py", 318 | Code: "echo\n", 319 | Config: ConfigBlock{SheBang: false, OnError: "fail"}, 320 | }, 321 | { 322 | Lang: "sh", 323 | Code: "echo2\n", 324 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 325 | }, 326 | }, 327 | Dependencies: []string{}, 328 | Meta: map[string]interface{}{}, 329 | }}, 330 | expectedErr: nil, 331 | } 332 | RunFileParseTest(t, test) 333 | } 334 | 335 | func TestConfigUnknownOnErrorValue(t *testing.T) { 336 | test := &FileParseTest{ 337 | filePath: "tests/test_unknown_onerror_value.md", 338 | expectedCmds: map[string]CommandBlock{ 339 | "cmd": { 340 | CodeBlocks: []CodeBlock{{ 341 | Lang: "sh", 342 | Code: "echo\n", 343 | Config: ConfigBlock{SheBang: false, OnError: "ignore"}, 344 | }, 345 | }, 346 | Dependencies: []string{}, 347 | Meta: map[string]interface{}{}, 348 | }}, 349 | expectedErr: nil, 350 | } 351 | RunFileParseTest(t, test) 352 | } 353 | -------------------------------------------------------------------------------- /tests/err_no_shebang_no_infostring.md: -------------------------------------------------------------------------------- 1 | ## [simple_echo1]() 2 | 3 | ``` 4 | code1 5 | ``` 6 | -------------------------------------------------------------------------------- /tests/err_same_command_name.md: -------------------------------------------------------------------------------- 1 | ## [simple_echo1]() 2 | 3 | ```sh 4 | code1 5 | ``` 6 | 7 | # [simple_echo1](dep1 dep2) - Simple echo in shell 8 | 9 | ```sh 10 | code 11 | ``` 12 | -------------------------------------------------------------------------------- /tests/no_code_in_codefence.md: -------------------------------------------------------------------------------- 1 | ## [simple_echo]() - Simple echo in shell 2 | 3 | ```sh 4 | ``` 5 | 6 | 7 | -------------------------------------------------------------------------------- /tests/one_command_two_code_blocks.md: -------------------------------------------------------------------------------- 1 | ## [simple_echo1](dep1) - Simple echo in shell 2 | 3 | ```sh 4 | code1 5 | ``` 6 | 7 | ```python 8 | #!/bin/venv/python 9 | code2 10 | ``` 11 | 12 | -------------------------------------------------------------------------------- /tests/test1.md: -------------------------------------------------------------------------------- 1 | ## [simple_echo](dep1 dep2) - Simple echo in shell 2 | 3 | ```sh 4 | echo "{{.arg1}} {{.arg2}}" 5 | ``` 6 | 7 | Execute with `mdx demo.md simple_echo hello world` 8 | 9 | Output: 10 | ``` 11 | $ hello world 12 | ``` 13 | -------------------------------------------------------------------------------- /tests/test2.md: -------------------------------------------------------------------------------- 1 | ## [simple_echo]() - Simple echo in shell 2 | 3 | ``` 4 | #!/my/python 5 | print(blubb) 6 | ``` 7 | 8 | Execute with `mdx demo.md simple_echo hello world` 9 | 10 | Output: 11 | ``` 12 | $ hello world 13 | ``` 14 | -------------------------------------------------------------------------------- /tests/test_config.md: -------------------------------------------------------------------------------- 1 | # [cmd]() 2 | 3 | ```mdx 4 | config: 5 | on-error: fail 6 | ``` 7 | 8 | ```sh 9 | echo 10 | ``` 11 | 12 | ```py 13 | echo 14 | ``` 15 | 16 | ```mdx 17 | config: 18 | on-error: ignore 19 | ``` 20 | 21 | ```sh 22 | echo2 23 | ``` -------------------------------------------------------------------------------- /tests/test_config_fail.md: -------------------------------------------------------------------------------- 1 | # [cmd]() 2 | 3 | ```mdx 4 | config: 5 | on-error: fail 6 | ``` 7 | 8 | 9 | ```sh 10 | echo -n "hello" 11 | ``` 12 | 13 | ```sh 14 | exit 1 15 | ``` 16 | 17 | ```sh 18 | echo -n "world" 19 | ``` -------------------------------------------------------------------------------- /tests/test_config_ignore.md: -------------------------------------------------------------------------------- 1 | # [cmd]() 2 | 3 | ```mdx 4 | config: 5 | on-error: ignore 6 | ``` 7 | 8 | 9 | ```sh 10 | echo -n "hello" 11 | ``` 12 | 13 | ```sh 14 | exit 1 15 | ``` 16 | 17 | ```sh 18 | echo -n " world" 19 | ``` -------------------------------------------------------------------------------- /tests/test_dependencies.md: -------------------------------------------------------------------------------- 1 | ## [cmd1](dep1) 2 | 3 | ```sh 4 | echo -n "Hello" 5 | ``` 6 | ## [dep1](dep2) 7 | 8 | ```sh 9 | echo -n "World" 10 | ``` 11 | 12 | 13 | ## [dep2]() 14 | 15 | ```sh 16 | echo -n "!" 17 | ``` 18 | 19 | -------------------------------------------------------------------------------- /tests/test_dependency_missing.md: -------------------------------------------------------------------------------- 1 | ## [cmd1](dep1 dep2) 2 | 3 | This test would output Hello, if the availability of all deps is not validated before execution. 4 | 5 | ```sh 6 | echo -n "Hello" 7 | ``` 8 | ## [dep1]() 9 | 10 | ```sh 11 | echo -n "Hello" 12 | ``` 13 | 14 | ## [dep2](dep2.1) 15 | 16 | ```sh 17 | echo -n "!" 18 | ``` -------------------------------------------------------------------------------- /tests/test_no_launcher_defined.md: -------------------------------------------------------------------------------- 1 | ## [cmd]() 2 | 3 | ```na 4 | command 5 | ``` -------------------------------------------------------------------------------- /tests/test_unknown_onerror_value.md: -------------------------------------------------------------------------------- 1 | # [cmd]() 2 | 3 | ```mdx 4 | config: 5 | on-error: blubb 6 | ``` 7 | 8 | ```sh 9 | echo 10 | ``` 11 | -------------------------------------------------------------------------------- /tests/two_commands.md: -------------------------------------------------------------------------------- 1 | ## [simple_echo1](dep1) - Simple echo in shell 2 | 3 | ```sh 4 | code1 5 | ``` 6 | 7 | Execute with `mdx demo.md simple_echo hello world` 8 | 9 | Output: 10 | ``` 11 | $ hello world 12 | ``` 13 | 14 | # [simple_echo2](dep1 dep2) - Simple echo in shell 15 | 16 | ```sh 17 | code2 18 | ``` 19 | 20 | Execute with `mdx demo.md simple_echo hello world` 21 | 22 | Output: 23 | ``` 24 | $ hello world 25 | ``` 26 | -------------------------------------------------------------------------------- /tests/two_commands_two_code_blocks.md: -------------------------------------------------------------------------------- 1 | ## [simple_echo1](dep1) - Simple echo in shell 2 | 3 | ```sh 4 | code1 5 | ``` 6 | 7 | ```python 8 | #!/bin/venv/python 9 | code2 10 | ``` 11 | 12 | 13 | 14 | 15 | ## [simple_echo2]() - Simple echo in shell 16 | 17 | ```sh 18 | code1 19 | ``` 20 | 21 | ```python 22 | #!/bin/venv/python 23 | code2 24 | ``` 25 | 26 | --------------------------------------------------------------------------------