mnogootex 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 654469a2719e7a34e16be659b3b59cbf8611f1f5025ccba19ba1bea60e35d87b
-  data.tar.gz: cc026af91f6270d36fd5affa76565e49ba781638965cb0b377c8775d84cbc8fb
+  metadata.gz: edf454b8fab7fe98488bade01dd2c59b3419d5afb9bc4a6c7cadca1cd36bf296
+  data.tar.gz: 1036a5f4e565b1deef11daa6c5418eeb4f357e942fc55009d92f7fc6cfd9dcbe
 SHA512:
-  metadata.gz: 2cf80aa5a52753bfec92a5ce7a6ff1c0a1d3d84376fdc897ed364097b52126245e5852284b474e81adee288c30d316753cb0bd38b8d75fbf541345512c834754
-  data.tar.gz: a71bda28d8eded4790cb3b40b6b673c58e3f96e630e42bb512c80afd004f869f559938ff83c7fb358780f59007c4117cad5bd0cf0b20e9d956c9c1d81425cfac
+  metadata.gz: 0c47604bd0302b39ab98ac7417fd0b1b720360c6e54650cc99383237ef2c42cbc65b2edebad71b44d7a662a21aa3740b6f71a66712b87af09d253d86de142989
+  data.tar.gz: 7e00d8a660f75ac7e04e0ba8befea9553f33d8f94b692f31bd634f333043a29abf0eb6eef619389dbf1cc31496ea299ed101b0f4311080ce0e47904983aa939a

data/.github/actions/setup-ruby/action.yml

@@ -0,0 +1,34 @@
+name: Setup Ruby
+description: Setup Ruby
+inputs:
+  ruby-version:
+    required: false
+    default: '2.7'
+  cache-path:
+    required: false
+    default: vendor/bundle
+  cache-key:
+    required: false
+    default: gems-
+  cache-restore-keys:
+    required: false
+    default: gems-
+outputs: {}
+runs:
+    using: "composite"
+    steps:
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ inputs.ruby-version }}
+      - name: Cache Ruby gems
+        uses: actions/cache@v2
+        with:
+          path: ${{ inputs.cache-path }}
+          key: ${{ inputs.cache-key }}
+          restore-keys: ${{ inputs.cache-restore-keys }}
+      - name: Install Ruby gems
+        shell: bash
+        run: |
+          bundle config path ${{ inputs.cache-path }}
+          bundle install --jobs 4 --retry 3

data/.github/workflows/main.yml

@@ -5,37 +5,40 @@ on:
   pull_request:
 
 jobs:
-  main:
-    name: >-
-      ${{ matrix.os }} ${{ matrix.ruby }}
-    runs-on: ${{ matrix.os }}-latest
+
+  test:
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu, macos ]
+        os: [ 'ubuntu-latest', 'macos-latest' ]
         ruby: [ '2.6', '2.7', '3.0' ]
+        include:
+          - os: ubuntu-latest
+            ruby: '2.7'
+            coverage: true
 
     steps:
 
       - name: Checkout repo
         uses: actions/checkout@v2
 
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
+      - name: Setup Ruby
+        uses: ./.github/actions/setup-ruby
         with:
           ruby-version: ${{ matrix.ruby }}
-
-      - name: Cache Ruby gems
-        uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: gems-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('Gemfile', 'mnogootex.gemspec') }}
-          restore-keys: gems-${{ matrix.os }}-${{ matrix.ruby }}-
-
-      - name: Install Ruby gems
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 3 --retry 3
+          cache-key: gems-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('Gemfile', 'mnogootex.gemspec') }}
+          cache-restore-keys: gems-${{ matrix.os }}-${{ matrix.ruby }}-
 
       - name: Run tests
         run: bundle exec rake spec:rspec
+
+      - name: Test and publish coverage to Code Climate
+        uses: paambaati/codeclimate-action@v3.0.0
+        if: ${{ matrix.coverage && github.ref == 'refs/heads/main' }}
+        env:
+          CC_TEST_REPORTER_ID: 890ed5ee01002c7149920883256f8e4790000127faa9ddf14d86dd3ceb3b8179
+          COVERAGE: true
+        with:
+          coverageCommand: bundle exec rspec
+          coverageLocations: ${{ github.workspace }}/coverage/coverage.json:simplecov

data/.rubocop.yml

@@ -5,6 +5,8 @@ Metrics/LineLength:
   Max: 120
 Layout/DotPosition:
   EnforcedStyle: trailing
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
 Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.0.0] - 2021-11-19
+
+### Added
+
+- `exec` command to run `latexmk` directly.
+- `clobber` command to delete both unessential files and artifacts.
+
+### Changed
+
+- `go` command renamed to `build`.
+- `clean` command simply deletes unessential files (instead of everything).
+- Configuration must be named `.mnogootexrc` (instead of `.mnogootex.yml`).
+
+### Removed
+
+- `mnogoo` shell integration no longer exists.
+- `dir` and `pdf` commands no longer exist.
+
+### Fixed
+
+- Avoid deleting files before buils so viewers can reload.
+- Caught nasty IO timing bug when polling `latexmk -pv` for logs.
+
+## [1.1.0] - 2021-11-06
+
+### Added
+
+- New option `work_path` in configuration file to simplify access to build folders.
+
+## [1.0.1] - 2018-09-03
+
+### Fixed
+
+- `mnogootex mnogoo` now produces correct path.
+
+## [1.0.0] - 2018-04-24
+
+### Added
+
+- First public release.
+
+[unreleased]: https://github.com/paolobrasolin/mnogootex/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/paolobrasolin/mnogootex/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/paolobrasolin/mnogootex/compare/v1.0.1...v1.1.0
+[1.0.1]: https://github.com/paolobrasolin/mnogootex/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/paolobrasolin/mnogootex/releases/tag/v1.0.0

data/README.md

@@ -1,12 +1,21 @@
 # Многоꙮтех
 
-[![Build Status](https://travis-ci.org/paolobrasolin/mnogootex.svg?branch=master)](https://travis-ci.org/paolobrasolin/mnogootex)
-[![Gem Version](https://badge.fury.io/rb/mnogootex.svg)](https://badge.fury.io/rb/mnogootex)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Code Climate](https://codeclimate.com/github/paolobrasolin/mnogootex/badges/gpa.svg)](https://codeclimate.com/github/paolobrasolin/mnogootex)
-<!-- [![Test Coverage](https://codeclimate.com/github/paolobrasolin/mnogootex/badges/coverage.svg)](https://codeclimate.com/github/paolobrasolin/mnogootex/coverage) -->
-<!-- [![Inline docs](http://inch-ci.org/github/paolobrasolin/mnogootex.svg?branch=master)](http://inch-ci.org/github/paolobrasolin/mnogootex) -->
-<!-- [![Issue Count](https://codeclimate.com/github/paolobrasolin/mnogootex/badges/issue_count.svg)](https://codeclimate.com/github/paolobrasolin/mnogootex) -->
+[![CI tests status badge][build-shield]][build-url]
+[![Latest release badge][rubygems-shield]][rubygems-url]
+[![License badge][license-shield]][license-url]
+[![Maintainability badge][cc-maintainability-shield]][cc-maintainability-url]
+[![Test coverage badge][cc-coverage-shield]][cc-coverage-url]
+
+[build-shield]: https://img.shields.io/github/workflow/status/paolobrasolin/mnogootex/CI/main?label=tests&logo=github
+[build-url]: https://github.com/paolobrasolin/mnogootex/actions/workflows/main.yml "CI tests status"
+[rubygems-shield]: https://img.shields.io/gem/v/mnogootex?logo=ruby
+[rubygems-url]: https://rubygems.org/gems/mnogootex "Latest release"
+[license-shield]: https://img.shields.io/github/license/paolobrasolin/mnogootex
+[license-url]: https://github.com/paolobrasolin/mnogootex/blob/main/LICENSE "License"
+[cc-maintainability-shield]: https://img.shields.io/codeclimate/maintainability/paolobrasolin/mnogootex?logo=codeclimate
+[cc-maintainability-url]: https://codeclimate.com/github/paolobrasolin/mnogootex "Maintainability"
+[cc-coverage-shield]: https://img.shields.io/codeclimate/coverage/paolobrasolin/mnogootex?logo=codeclimate&label=test%20coverage
+[cc-coverage-url]: https://codeclimate.com/github/paolobrasolin/mnogootex/coverage "Test coverage"
 
 Многоꙮтех (mnogootex) is a utility that parallelizes compilation
 of a LaTeX document using different classes and offers a
@@ -16,174 +25,259 @@ The motivating use case is maintaining a single preamble while
 submitting a paper to many journals using their outdated or crummy
 document classes.
 
-## Installation
+## Getting started
 
-The only requirement is [Ruby](https://www.ruby-lang.org) (>=2.5 as earlier versions are untested).
+### Prerequisites
+
+Многоꙮтех is written in [**Ruby**](https://www.ruby-lang.org) and requires version `>=2.5` (earlier ones are untested).
+You can check whether it's installed by running `ruby --version`.
+For installation instructions you can refer to the [official documentation](https://www.ruby-lang.org/en/documentation/installation/).
+
+
+Многоꙮтех heavily relies on [**`latexmk`**](https://ctan.org/pkg/latexmk).
+You can check whether it's installed by running `latexmk --version`.
+If you are missing it, follow the documentation of your specific LaTeX distribution and install the `latexmk` package.
+
+### Installation
 
 To install многоꙮтех execute
 
-    gem install mnogootex
-    
-To install `mnogoo` (strongly recommended shell integration) add this to your shell profile
+```bash
+gem install mnogootex
+```
+
+If you're upgrading from a previous version, execute
 
-    [ -s "$(mnogootex mnogoo)" ] && . "$(mnogootex mnogoo)"
+```bash
+gem update mnogootex
+```
 
-## Quick start
+and remove any mention of `mnogootex` from your shell profile (it's not needed anymore).
 
-Set up your `LaTeX` project as usual - let's say its main file is `~/project/main.tex` and contains `\documentclass{...}`.
+### Quick start
 
-Create a configuration file `~/project/.mnogootex.yml`
-containing the list of document classes you want to compile your
-project against:
+First you write a LaTeX document:
 
-    jobs:
-      - scrartcl
-      - article
-      - book
-      
-Run `mnogootex go ~/project/main.tex` and enjoy the technicolor:
+```latex
+% ~/demo/main.tex
+\documentclass{scrarticle}
+\begin{document}
+  \abstract{Simply put, my article is awesome.}
+  Let's port my \KOMAScript\ article to other classes!
+\end{document}
+```
 
-![Demo TTY GIF](tty.gif?raw=true "Demo TTY GIF")
+Then you list the desided classes in a Многоꙮтех configuration file:
+
+```yaml
+# ~/demo/.mnogootexrc
+jobs:
+  - scrartcl
+  - article
+  - book
+```
+
+Finally you run `mnogootex build` and enjoy the technicolor:
+
+![A user types `mnogootex build main.tex` in the console. Some spinners indicating progress appear. Then the outcome for each class is presented. Failing ones include abridged and color coded logs, to pinpoint the errors.](demo/demo.gif?raw=true "TTY demo GIF")
 
 ## Usage
 
-In essence, Многоꙮтех
-1. takes the _source_ directory of a project, 
-2. clones it into _target_ directories (one for each _job_),
-3. applies a different source code transformation to each one and then
-4. attempts to compile them.
+A Многоꙮтех run does the following:
+1. copy the _source_ folder of a project to many _target_ folders, one for each _job_;
+2. replace the document class in the source of each _target_ folder with the name of the relative _job_;
+3. call `latexmk` in parallel on each _target_ folder to compile the documents (or do other tasks);
+4. wait for the outcomes and print the logs, filtered and colour-coded in a meaningful way.
 
 Its convenience lies in the fact that it
 * automates the setup process,
 * parallelizes compilation,
-* filters and colour codes the infamous waterfall logs and
-* allows you to easily navigate through targets/source folders. 
+* improves the readability of the infamous waterfall logs.
 
-Многоꙮтех can be invoked from commandline in two ways: `mnogootex` and `mnogoo`.
-The latter is more powerful and requires an extra [installation](#installation) step.
+Многоꙮтех can be invoked from CLI using `mnogootex`.
+It accepts various [commands](#mnogootex-commands) detailed below.
 
-Commands listed below can be passed to both unless otherwise stated.
+To leverage the full power of this tool you will need to learn writing [`mnogootex` configurations](#mnogootex-configuration) and ['latexmk' configurations](#latexmk-configuration).
+It might sound daunting but they're really just a few lines.
 
-### Commands
+### `mnogootex` commands
 
-> **NOTATION:** `[FOO]` means that _`FOO` is optional_ while `FOO ...` means _one or more `FOO`s_. 
-
-#### `help [COMMAND]`
+> **Notation:** `[FOO]` means that _`FOO` is optional_ while `FOO ...` means _one or more `FOO`s_.
 
-Prints the help for `COMMAND` (or all commands if none is given).
+All commands except `help` accept the same parameters, so let's examine them in advance to avoid repeating ourselves later.
+Here is their syntax:
 
-#### `mnogoo`
+```bash
+mnogootex COMMAND [JOB ...] [FLAG ...] ROOT
+```
 
-Prints the location of the `mnogoo` shell integration script.
-Useful only for its [installation](#installation).
+`JOB`s are the names of the document classes to compile your document with.
+Zero or more can be provided, and when none is given the job list is loaded from the [configuration](#jobs).
 
-#### `go [JOB ...] [MAIN]`
+`FLAG`s are `latexmk` options.
+Zero or more can be provided to override the behaviour of the `latexmk` call underlying the `mnogootex` command.
+You can obtain a list of available options with the inline help `latexmk --help`, and the full documentation with `man latexmk`.
+Generally speaking, if you find yourself always using a `FLAG` you should properly [configure `latexmk`](#latexmk-configuration) instead.
 
-Run given compilation `JOB`s for the `MAIN` document.
+The last mandatory parameter is the `ROOT` file for compiling of your document.
 
-If no `JOB` list is given then all of them are run.
-They are deduced from the [configuration](#configuration).
+Let's examine the details of each command now.
 
-If no `MAIN` document is given then it's deduced from either
-your current working directory or the [configuration](#configuration).
-
-#### `dir [JOB] [MAIN]`
-
-Print `JOB`'s temporary directory for the `MAIN` document.
+#### `help [COMMAND]`
 
-If no `JOB` is given then it prints the source directory.
+This command prints the help for `COMMAND` (or all commands if none is given).
 
-If no `MAIN` document is given then it's deduced from either
-your current working directory or the [configuration](#configuration).
+#### `exec [JOB ...] [FLAG ...] ROOT`
 
-#### `cd [JOB] [MAIN]`
+This command simply runs `latexmk` on the `ROOT` document for each of your `JOB`s passing the given `FLAG`s.
 
-> **NOTE:** recognized by `mnogoo` only.
+All other commands below are specializations of this one.
+However you'll seldom use it unless you're debugging.
 
-Checks into `JOB`'s temporary directory for the `MAIN` document.
+#### `build [JOB ...] [FLAG ...] ROOT`
 
-If no `JOB` is given then it checks into the source directory.
+This command builds your document.
 
-If no `MAIN` document is given then it's deduced from either
-your current working directory or the [configuration](#configuration).
+It is equivalent to `exec [JOB ...] -interaction=nonstopmode ROOT`.
 
-#### `clobber`
+You will probably need to pass some `FLAG`s (e.g. to use the correct engine) but it is not recommended: [configure `latexmk`](#latexmk-configuration) instead.
 
-Deletes all temporary files.
-Useful to free up some space from time to time.
+#### `open [JOB ...] [FLAG ...] ROOT`
 
-#### `pdf [JOB ...] [MAIN]`
+This command opens the final compilation artifact (after running the build if necessary).
 
-Print `JOB`'s output PDF path for the `MAIN` document.
+It is equivalent to `exec [JOB ...] -pv -interaction=nonstopmode ROOT`.
 
-If no `JOB` list is given then all their output PDFs paths are printed.
-They are deduced from the [configuration](#configuration).
+You might need to pass some `FLAG`s (e.g. to use the correct viewer) but it is not recommended: [configure `latexmk`](#latexmk-configuration) instead.
 
-If no `MAIN` document is given then it's deduced from either
-your current working directory or the [configuration](#configuration).
+#### `clean [JOB ...] [FLAG ...] ROOT`
 
-#### `open [JOB ...] [MAIN]`
+This command deletes all nonessential build files while keeping the compiled artifacts.
 
-> **NOTE:** recognized by `mnogoo` only.
+It is equivalent to `exec [JOB ...] -c ROOT`.
 
-Open `JOB`'s output PDF for the `MAIN` document with your default viewer.
+#### `clobber [JOB ...] [FLAG ...] ROOT`
 
-If no `JOB` list is given then all their output PDFs are opened.
-They are deduced from the [configuration](#configuration).
+This command deletes all nonessential build files including the compiled artifacts.
 
-If no `MAIN` document is given then it's deduced from either
-your current working directory or the [configuration](#configuration).
+It is equivalent to `exec [JOB ...] -C ROOT`.
 
-### Configuration
+### `mnogootex` configuration
 
-Многоꙮтех is configured through [`YAML`](https://learnxinyminutes.com/docs/yaml/)
-files named `.mnogootex.yml` put into your projects' root directory.
+`mnogootex` is configured through [`YAML`](https://learnxinyminutes.com/docs/yaml/)
+files named `.mnogootexrc` put into your projects' root directory.
 
-When  loads a configuration it also looks up for `.mnogootex.yml`
+When `mnogootex` loads a configuration it also looks up for `.mnogootexrc`
 files in all parent directories to merge then together (from the
 shallowest to the deepest path).  This means that e.g. you can keep
 a configuration file in your home folder and use it as a global
 configuration for all you projects, while overwriting only specific
 options in the configuration files of each one.
 
-Многоꙮтех currently accepts three options.
+`mnogootex` currently accepts three options.
 
-#### `spinner`
+#### `jobs`
+
+This option represents the `JOB`s to build your document (when none are given via CLI).
 
-This option is a string whose characters are the frames used to
-animate the spinners for the command line interface.
+It must contain valid document class names, given as a list of strings.
 
-    # Default value:
-    spinner: ⣾⣽⣻⢿⡿⣟⣯⣷
+By default there are no `JOB`s:
 
-#### `commandline`
+```yaml
+# Default value:
+jobs: []
+```
 
-This option is an array of the components for the commandline used
-to compile documents.
+Here is a slightly more interesting example:
 
-    # Default value:
-    commandline:
-      - latexmk
-      - -pdf
-      - --interaction=nonstopmode
+```yaml
+jobs:
+  - scrartcl
+  - article
+  - book
+```
 
 #### `work_path`
 
-This option is an override for the path where compilation happens.
+This option is the folder where all elaboration happens.
+
+It must be a well formed path, given as a string.
+
+By default none is given, meaning that each run of any given job happens in a dedicated temporary folder:
+
+```yaml
+# Default value:
+work_path: null
+```
+
+Overriding this allows you to have easier access to the compilation artifacts.
+A good choice is setting it to `./build` and keep everything below your source folder:
+
+```yaml
+work_path: ./build
+```
+
+#### `spinner`
+
+This option is the spinner animation shown by the CLI.
+
+It is a series of frames given as characters of a string.
+
+By default it's a hole looping around in a blister:
+
+```yaml
+# Default value:
+spinner: ⣾⣽⣻⢿⡿⣟⣯⣷
+```
+
+Here is a couple more in case your terminal doesn't like Unicode:
+
+```yaml
+# A wriggly ASCII worm:
+spinner: )}]|[{({[|]}
+# An extended ASCII boomerang:
+spinner: ╒┍┌┎╓╖┒┐┑╕╛┙┘┚╜╙┖└┕╘
+```
+
+Feel free to get creative!
+
+### `latexmk` configuration
+
+`latexmk` is configured through [`Perl`](https://www.perl.org/)
+files named `.latexmkrc` put into your projects' root directory.
+
+When `latexmk` loads a configuration it also looks up for `.latexmkrc`
+files in all parent directories to merge then together (from the
+shallowest to the deepest path).  This means that e.g. you can keep
+a configuration file in your home folder and use it as a global
+configuration for all you projects, while overwriting only specific
+options in the configuration files of each one.
 
-    # Default value:
-    work_path: null
+`latexmk` has a gazillion of options.
+We'll just skim over the most common ones here.
 
-By default each run happens in a new empty folder. Overriding this allows you to easily reach the compilation artifacts, but leaves handling cleanup and conflicts with previous runs up to you.
+First of all, one must pick the correct engine.
+Assuming you want to produce a PDF artifact, you have a few choices:
 
-## Contributing
+```perl
+$pdf_mode = 1; # create PDF with pdflatex
+# $pdf_mode = 2; # create PDF with ps2pdf (via PS)
+# $pdf_mode = 3; # create PDF with dvipdf (via DVI)
+# $pdf_mode = 4; # create PDF with lualatex
+# $pdf_mode = 5; # create PDF with xelatex
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/paolobrasolin/mnogootex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Then, if your PDF previewer is not being detected, you might need to configure it.
+Assuming you want to use evince:
 
-## License
+```perl
+$pdf_previewer = 'start evince';
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Most people won't probably need anything more than that.
+However, for further details read the documentation in the commandline with `man latexmk` or on [CTAN](https://ctan.mirror.garr.it/mirrors/ctan/support/latexmk/latexmk.txt)
 
-## Code of Conduct
+## Acknowledgements
 
-Everyone interacting in the многоꙮтех project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/paolobrasolin/mnogootex/blob/master/CODE_OF_CONDUCT.md).
+* Thanks to [@tetrapharmakon](https://github.com/tetrapharmakon) for being the first tester and user.

data/demo/.mnogootexrc

@@ -0,0 +1,4 @@
+jobs:
+  - scrarticle
+  - article
+  - book

data/demo/demo.asciicast

@@ -0,0 +1,114 @@
+{"version": 2, "width": 92, "height": 26, "timestamp": 1637333757, "env": {"SHELL": "/bin/zsh", "TERM": "alacritty"}}
+[0.017014, "o", "\u001b[?2004h$ "]
+[0.816219, "o", "m"]
+[0.880306, "o", "n"]
+[1.120106, "o", "o"]
+[1.328005, "o", "g"]
+[1.431937, "o", "o"]
+[1.560266, "o", "o"]
+[1.664007, "o", "t"]
+[1.824229, "o", "e"]
+[2.096341, "o", "x"]
+[2.208064, "o", " "]
+[2.416225, "o", "b"]
+[2.488119, "o", "u"]
+[2.528114, "o", "i"]
+[2.775867, "o", "l"]
+[2.927851, "o", "d"]
+[3.048131, "o", " "]
+[3.18416, "o", "m"]
+[3.30414, "o", "a"]
+[3.360091, "o", "i"]
+[3.463861, "o", "n"]
+[3.664082, "o", "."]
+[3.768087, "o", "t"]
+[3.872092, "o", "e"]
+[4.072065, "o", "x"]
+[4.19206, "o", "\r\n\u001b[?2004l\r"]
+[4.610511, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.630807, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.652109, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.672831, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.693597, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.71437, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.735132, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.755441, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.776142, "o", "Runners: \u001b[0;33;49m⢿\u001b[0m\u001b[0;33;49m⣽\u001b[0m\u001b[0;33;49m⣽\u001b[0m\r"]
+[4.796857, "o", "Runners: \u001b[0;33;49m⡿\u001b[0m\u001b[0;33;49m⣻\u001b[0m\u001b[0;33;49m⣻\u001b[0m\r"]
+[4.817161, "o", "Runners: \u001b[0;33;49m⣟\u001b[0m\u001b[0;33;49m⢿\u001b[0m\u001b[0;33;49m⢿\u001b[0m\r"]
+[4.837458, "o", "Runners: \u001b[0;33;49m⣯\u001b[0m\u001b[0;33;49m⡿\u001b[0m\u001b[0;33;49m⡿\u001b[0m\r"]
+[4.857789, "o", "Runners: \u001b[0;33;49m⣷\u001b[0m\u001b[0;33;49m⣟\u001b[0m\u001b[0;33;49m⣟\u001b[0m\r"]
+[4.878122, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣯\u001b[0m\u001b[0;33;49m⣯\u001b[0m\r"]
+[4.898448, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;33;49m⣷\u001b[0m\u001b[0;33;49m⣷\u001b[0m\r"]
+[4.918754, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣾\u001b[0m\r"]
+[4.939493, "o", "Runners: \u001b[0;33;49m⢿\u001b[0m\u001b[0;33;49m⣽\u001b[0m\u001b[0;33;49m⣽\u001b[0m\r"]
+[4.960303, "o", "Runners: \u001b[0;33;49m⡿\u001b[0m\u001b[0;33;49m⣻\u001b[0m\u001b[0;33;49m⣻\u001b[0m\r"]
+[4.980995, "o", "Runners: \u001b[0;33;49m⣟\u001b[0m\u001b[0;33;49m⢿\u001b[0m\u001b[0;33;49m⢿\u001b[0m\r"]
+[5.001721, "o", "Runners: \u001b[0;33;49m⣯\u001b[0m\u001b[0;33;49m⡿\u001b[0m\u001b[0;33;49m⡿\u001b[0m\r"]
+[5.022407, "o", "Runners: \u001b[0;33;49m⣷\u001b[0m\u001b[0;33;49m⣟\u001b[0m\u001b[0;33;49m⣟\u001b[0m\r"]
+[5.042661, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;33;49m⣯\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.062924, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;33;49m⣷\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.083219, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.10347, "o", "Runners: \u001b[0;33;49m⢿\u001b[0m\u001b[0;33;49m⣽\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.123727, "o", "Runners: \u001b[0;33;49m⡿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.143997, "o", "Runners: \u001b[0;33;49m⣟\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.164261, "o", "Runners: \u001b[0;33;49m⣯\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.18454, "o", "Runners: \u001b[0;33;49m⣷\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.204898, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.225157, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.245427, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.265709, "o", "Runners: \u001b[0;33;49m⢿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.285988, "o", "Runners: \u001b[0;33;49m⡿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.306276, "o", "Runners: \u001b[0;33;49m⣟\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.326587, "o", "Runners: \u001b[0;33;49m⣯\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.346862, "o", "Runners: \u001b[0;33;49m⣷\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.367137, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.387471, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.407789, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.428094, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.448427, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.468685, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.48902, "o", "Runners: \u001b[0;33;49m⢿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.509286, "o", "Runners: \u001b[0;33;49m⡿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.529559, "o", "Runners: \u001b[0;33;49m⣟\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.549834, "o", "Runners: \u001b[0;33;49m⣯\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.570114, "o", "Runners: \u001b[0;33;49m⣷\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.590495, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.610773, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.631053, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.651328, "o", "Runners: \u001b[0;33;49m⢿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.671634, "o", "Runners: \u001b[0;33;49m⡿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.691885, "o", "Runners: \u001b[0;33;49m⣟\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.712144, "o", "Runners: \u001b[0;33;49m⣯\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.732409, "o", "Runners: \u001b[0;33;49m⣷\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.752725, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.77299, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.793269, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.81354, "o", "Runners: \u001b[0;33;49m⢿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.833802, "o", "Runners: \u001b[0;33;49m⡿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.854091, "o", "Runners: \u001b[0;33;49m⣟\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.874667, "o", "Runners: \u001b[0;33;49m⣯\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.894903, "o", "Runners: \u001b[0;33;49m⣷\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.915157, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.935432, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.955706, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.975985, "o", "Runners: \u001b[0;33;49m⢿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[5.996281, "o", "Runners: \u001b[0;33;49m⡿\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[6.016565, "o", "Runners: \u001b[0;33;49m⣟\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[6.03685, "o", "Runners: \u001b[0;33;49m⣯\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[6.057124, "o", "Runners: \u001b[0;33;49m⣷\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[6.077406, "o", "Runners: \u001b[0;33;49m⣾\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[6.097789, "o", "Runners: \u001b[0;33;49m⣽\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[6.118073, "o", "Runners: \u001b[0;33;49m⣻\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r"]
+[6.138511, "o", "Runners: \u001b[0;32;49m⣯\u001b[0m\u001b[0;31;49m⣾\u001b[0m\u001b[0;31;49m⢿\u001b[0m\r\r\nOutcome:\r\n"]
+[6.138712, "o", "  \u001b[0;32;49m✔\u001b[0m scrarticle\r\n  \u001b[0;31;49m✘\u001b[0m article\r\n"]
+[6.139693, "o", "    \u001b[0;97;49mLatexmk: This is Latexmk, John Collins, 21 September 2021, version: 4.75.\u001b[0m\r\n    \u001b[0;97;49mThis is pdfTeX, Version 3.141592653-2.6-1.40.23 (TeX Live 2021) (preloaded format=latex)\u001b[0m\r\n    \u001b[0;91;49m! Undefined control sequence.\u001b[0m\r\n    \u001b[0;91;49ml.4   Let's port my \\KOMAScript\u001b[0m\r\n    \u001b[0;91;49m                               \\ article!\u001b[0m\r\n    \u001b[0;97;49mOutput written on main.dvi (1 page, 424 bytes).\u001b[0m\r\n    \u001b[0;91;49mLatexmk: Errors, so I did not complete making targets\u001b[0m\r\n  \u001b[0;31;49m✘\u001b[0m book\r\n"]
+[6.140624, "o", "    \u001b[0;97;49mLatexmk: This is Latexmk, John Collins, 21 September 2021, version: 4.75.\u001b[0m\r\n    \u001b[0;97;49mThis is pdfTeX, Version 3.141592653-2.6-1.40.23 (TeX Live 2021) (preloaded format=latex)\u001b[0m\r\n    \u001b[0;91;49m! Undefined control sequence.\u001b[0m\r\n    \u001b[0;91;49ml.3   \\abstract\u001b[0m\r\n    \u001b[0;91;49m               {Simply put, my article is awesome.}\u001b[0m\r\n    \u001b[0;91;49m! Undefined control sequence.\u001b[0m\r\n    \u001b[0;91;49ml.4   Let's port my \\KOMAScript\u001b[0m\r\n"]
+[6.140752, "o", "    \u001b[0;91;49m                               \\ article!\u001b[0m\r\n    \u001b[0;97;49mOutput written on main.dvi (1 page, 324 bytes).\u001b[0m\r\n    \u001b[0;91;49mLatexmk: Errors, so I did not complete making targets\u001b[0m\r\n"]
+[6.145564, "o", "\u001b[?2004h$ "]
+[9.623727, "o", "e"]
+[9.720091, "o", "x"]
+[9.904131, "o", "i"]
+[10.016153, "o", "t"]
+[10.496203, "o", "\r\n\u001b[?2004l\r"]
+[10.49658, "o", "exit\r\n"]

data/demo/main.tex

@@ -0,0 +1,5 @@
+\documentclass{scrarticle}
+\begin{document}
+  \abstract{Simply put, my article is awesome.}
+  Let's port my \KOMAScript\ article!
+\end{document}

data/lib/mnogootex/cfg.rb

@@ -3,12 +3,14 @@
 require 'yaml'
 require 'pathname'
 
-require 'mnogootex/core_ext'
-
 module Mnogootex
   module Cfg
-    BASENAME = '.mnogootex.yml'
-    DEFAULTS = YAML.load_file(Pathname.new(__dir__).join('defaults.yml'))
+    BASENAME = '.mnogootexrc'
+    DEFAULTS = {
+      'jobs' => [],
+      'spinner' => '⣾⣽⣻⢿⡿⣟⣯⣷',
+      'work_path' => nil,
+    }.freeze
 
     def self.load_descending(pathname:, basename:)
       pathname.realpath.descend.
@@ -25,15 +27,22 @@ module Mnogootex
     class << self
       private
 
+      def split_jobs_and_flags(args)
+        # TODO: some kind of validation?
+        flags = args.drop_while { |arg| !arg.start_with?('-') }
+        jobs = args.take_while { |arg| !arg.start_with?('-') }
+        [(jobs unless jobs.empty?), (flags unless flags.empty?)]
+      end
+
       def try_args(*args)
         main = Pathname.new(args.fetch(-1, ''))
         return unless main.file?
 
         main = main.realpath
         cfg = load_descending(pathname: main.dirname, basename: BASENAME)
-        jobs = args[0..-2].unless(&:empty?)
+        jobs, flags = split_jobs_and_flags(args[0..-2])
 
-        [jobs, main, cfg]
+        [jobs, flags, main, cfg]
       end
 
       def try_link(*args)
@@ -42,20 +51,21 @@ module Mnogootex
 
         main = link.readlink.realpath
         cfg = load_descending(pathname: main.dirname, basename: BASENAME)
-        jobs = args
+        jobs, flags = split_jobs_and_flags(args)
 
-        [jobs, main, cfg]
+        [jobs, flags, main, cfg]
       end
 
       def try_cfgs(*args)
-        yaml = Pathname.pwd.ascend.map { |p| p.join('.mnogootex.yml') }.detect(&:file?)
+        yaml = Pathname.pwd.ascend.map { |p| p.join('.mnogootexrc') }.detect(&:file?)
         return if yaml.nil?
 
         cfg = load_descending(pathname: yaml.dirname, basename: BASENAME)
-        main = yaml.dirname.join(cfg.fetch('main', '')).if(&:file?)&.realpath
-        jobs = args
+        main = yaml.dirname.join(cfg.fetch('main', ''))
+        main = main.file? ? main.realpath : nil
+        jobs, flags = split_jobs_and_flags(args)
 
-        [jobs, main, cfg]
+        [jobs, flags, main, cfg]
       end
     end
   end

data/lib/mnogootex/cli.rb

@@ -10,71 +10,54 @@ require 'mnogootex/cfg'
 
 module Mnogootex
   class CLI < Thor
-    IS_MNOGOO = (ENV['IS_MNOGOO'] == 'true')
-
-    def self.basename
-      IS_MNOGOO ? 'mnogoo' : super
+    desc 'exec [JOB ...] [FLAG ...] ROOT',
+         'Execute latexmk with FLAGs on each JOB for ROOT document'
+    def exec(*args)
+      execute_latexmk(*args, default_flags: [])
     end
 
-    desc 'cd [JOB] [MAIN]',
-         'Check into dir of JOB (or source) for MAIN (or inferred) document'
-    def cd(*args); end
-
-    desc 'open [JOB ...] [MAIN]',
-         'Open PDF of each (or every) JOB for MAIN (or inferred) document'
-    def open(*args); end
-
-    remove_command :cd, :open unless IS_MNOGOO
-
-    desc 'mnogoo',
-         'Print path of the shell wrapper script'
-    def mnogoo
-      puts Pathname.new(__dir__).join('mnogoo.sh').realpath
+    desc 'build [JOB ...] [FLAG ...] ROOT',
+         'Build each JOB for ROOT document'
+    def build(*args)
+      execute_latexmk(*args, default_flags: ['-interaction=nonstopmode'])
     end
 
-    desc 'clobber',
-         'Clean up all temporary files'
-    def clobber
-      # NOTE: this is a tad slow - using shell would improve that
-      # TODO: this does not account for custom work_path
-      tmp_dir = Pathname.new(Dir.tmpdir).join('mnogootex')
-      tmp_dir_size = Mnogootex::Utils.humanize_bytes Mnogootex::Utils.dir_size(tmp_dir)
-      print "Freeing up #{tmp_dir_size}... "
-      FileUtils.rm_r tmp_dir, secure: true if tmp_dir.directory?
-      puts 'Done.'
+    desc 'open [JOB ...] [FLAG ...] ROOT',
+         '(Build and) open the artifact of each JOB for ROOT document'
+    def open(*args)
+      execute_latexmk(*args, default_flags: ['-interaction=nonstopmode', '-pv'])
     end
 
-    desc 'go [JOB ...] [MAIN]',
-         'Run each (or every) JOB for MAIN (or inferred) document'
-    def go(*args)
-      _, main, cfg = Mnogootex::Cfg.recombobulate(*args)
-      cfg = Mnogootex::Cfg::DEFAULTS.merge cfg
-      Mnogootex::Job::Warden.new(source: main, configuration: cfg).start
+    desc 'clean [JOB ...] [FLAG ...] ROOT',
+         'Delete nonessential files of each JOB for ROOT document'
+    def clean(*args)
+      execute_latexmk(*args, default_flags: ['-c'])
     end
 
-    desc 'dir [JOB] [MAIN]',
-         'Print dir of JOB (or source) for MAIN (or inferred) document'
-    def dir(*args)
-      jobs, main, cfg = Mnogootex::Cfg.recombobulate(*args)
-
-      if jobs.empty?
-        puts main.dirname
-      else
-        jobs.map! { |hid| Mnogootex::Job::Porter.new hid: hid, source_path: main, work_path: cfg['work_path'] }
-        jobs.map!(&:target_dir)
-        puts jobs
-      end
+    desc 'clobber [JOB ...] [FLAG ...] ROOT',
+         'Delete nonessential files and artifacts of each JOB for ROOT document'
+    def clobber(*args)
+      execute_latexmk(*args, default_flags: ['-C'])
+    end
+    
+    desc 'help [COMMAND]',
+         'Describe available commands or one specific COMMAND'
+    def help(*args)
+      super
+
+      puts <<~EXTRA_HELP
+        JOBs are document class names. The default is the whole list in your configuration file.
+        FLAGs are options passed to latexmk. Please refer to `latexmk -help` for details.
+      EXTRA_HELP
     end
 
-    desc 'pdf [JOB ...] [MAIN]',
-         'Print PDF path of each (or every) JOB for MAIN (or inferred) document'
-    def pdf(*args)
-      jobs, main, cfg = Mnogootex::Cfg.recombobulate(*args)
+  private
 
-      jobs = cfg['jobs'] if jobs.empty?
-      jobs.map! { |hid| Mnogootex::Job::Porter.new hid: hid, source_path: main, work_path: cfg['work_path'] }
-      jobs.map! { |porter| porter.target_path.sub_ext('.pdf') }
-      puts jobs
+    def execute_latexmk(*args, default_flags: [])
+      jobs, flags, main, cfg = Mnogootex::Cfg.recombobulate(*args)
+      cfg = Mnogootex::Cfg::DEFAULTS.merge(cfg).merge({ 'jobs' => jobs }.compact)
+      flags = [*default_flags, *flags]
+      Mnogootex::Job::Warden.new(source: main, configuration: cfg, flags: flags).start
     end
   end
 end

data/lib/mnogootex/job/porter.rb

@@ -33,12 +33,22 @@ module Mnogootex
         providable_files = @source_path.dirname.children
         providable_files.reject!(&@work_path.method(:==))
         FileUtils.cp_r providable_files, target_dir
-        target_dir.join('.mnogootex.yml').tap { |p| p.delete if p.file? }
-        target_dir.join('.mnogootex.src').make_symlink(@source_path)
+        remove_configuration(target_dir)
+        create_link_to_source(target_dir)
       end
 
       private
 
+      def remove_configuration(folder_path)
+        path = folder_path.join('.mnogootexrc')
+        path.delete if path.file?
+      end
+
+      def create_link_to_source(folder_path)
+        path = folder_path.join('.mnogootex.src')
+        path.make_symlink(@source_path) unless path.symlink?
+      end
+
       def calc_work_path(path)
         return Pathname.new(path) unless path.nil?
 

data/lib/mnogootex/job/runner.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require 'open3'
+require 'io/wait'
 
 module Mnogootex
   module Job
     class Runner
+      POLLING_TIMEOUT = 0.02
+
       attr_reader :hid, :log_lines
 
       def initialize(cmd:, chdir:)
@@ -31,13 +34,27 @@ module Mnogootex
 
       def start_poller
         Thread.new do
-          until (line = @stream.gets).nil?
-            log_lines << line
-          end
+          polling_loop
+
           # NOTE: waits on @thread and returns its value
           @thread.value
         end
       end
+
+      def polling_loop
+        loop do
+          if @stream.wait_readable(POLLING_TIMEOUT).nil?
+            # If the stream timeouts and the thread is dead we expect no nore data.
+            # This happens on commands like `latexmk -pv` which fork other processes.
+            break unless @thread.alive?
+          else
+            # If we reach EOF, we expect no more data.
+            break if (line = @stream.gets).nil?
+
+            log_lines << line
+          end
+        end
+      end
     end
   end
 end

data/lib/mnogootex/job/warden.rb

@@ -11,9 +11,12 @@ require 'mnogootex/job/logger'
 module Mnogootex
   module Job
     class Warden
-      def initialize(source:, configuration:)
+      LATEXMK_PATH = 'latexmk'
+
+      def initialize(source:, configuration:, flags:)
         @source = source
         @configuration = configuration
+        @flags = flags
 
         @processor = nil
         @porters = []
@@ -44,7 +47,7 @@ module Mnogootex
 
       def exec_porters
         @porters.each do |porter|
-          porter.clobber
+          # porter.clobber
           porter.provide
           transformer(porter.hid, porter.target_path)
         end
@@ -54,7 +57,7 @@ module Mnogootex
         @runners = @porters.map do |porter|
           Mnogootex::Job::Runner.new(
             cmd: commandline(porter.target_path),
-            chdir: porter.target_dir
+            chdir: porter.target_dir,
           )
         end
       end
@@ -65,7 +68,7 @@ module Mnogootex
           levels: Mnogootex::Log::DEFAULT_LEVELS,
           min_level: :info,
           colorize: true,
-          indent_width: 4
+          indent_width: 4,
         )
       end
 
@@ -74,14 +77,15 @@ module Mnogootex
           spinner: @configuration['spinner'],
           processor: @processor.method(:run),
           runners: @runners,
-          porters: @porters
+          porters: @porters,
         )
       end
 
       # TODO: generalize, integrate with Runner
       def commandline(target_pathname)
         [
-          *@configuration['commandline'],
+          LATEXMK_PATH,
+          *@flags,
           target_pathname.basename.to_s
         ]
       end
@@ -91,7 +95,7 @@ module Mnogootex
         old_code = target_pathname.read
         new_code = old_code.sub(
           /\\documentclass(\[.*?\])?{.*?}/,
-          "\\documentclass{#{new_class_name}}"
+          "\\documentclass{#{new_class_name}}",
         )
         target_pathname.write(new_code)
       end

data/lib/mnogootex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mnogootex
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/spec/mnogootex/job/porter_spec.rb

@@ -76,7 +76,7 @@ describe Mnogootex::Job::Porter do
     before do
       test_dir.join('A', 'B').mkpath
       test_dir.join('A', 'main.file').write('')
-      test_dir.join('A', '.mnogootex.yml').write('')
+      test_dir.join('A', '.mnogootexrc').write('')
       test_dir.join('A', '.dotfile').write('')
       test_dir.join('A', 'B', 'ancillary.file').write('')
     end
@@ -89,9 +89,9 @@ describe Mnogootex::Job::Porter do
     end
 
     it 'ignores configuration file' do
-      test_dir.join('A', '.mnogootex.yml').unlink
+      test_dir.join('A', '.mnogootexrc').unlink
       subject.provide
-      expect(subject.target_dir.join('.mnogootex.yml')).to_not exist
+      expect(subject.target_dir.join('.mnogootexrc')).to_not exist
     end
 
     it 'creates link to source' do
@@ -108,7 +108,7 @@ describe Mnogootex::Job::Porter do
     it 'copies all source files' do
       subject.provide
       subject.target_dir.join('.mnogootex.src').unlink
-      source_path.dirname.join('.mnogootex.yml').unlink
+      source_path.dirname.join('.mnogootexrc').unlink
       # NOTE: unlinking so comparison is easier to write
       expect(relative_subtree(source_path.dirname)).
         to eq(relative_subtree(subject.target_dir))

data/spec/mnogootex/log/processor_spec.rb

@@ -172,7 +172,7 @@ describe Mnogootex::Log::Processor do
 
       expect(my_processor.run(log.lines)).to eq(
         ["    \e[0;33;49mHey, I'm warning you, dude. Stuff is gonna get bad.\e[0m\n",
-         "    \e[0;31;49mI warned you, dude. Here's an ERROR. :(\e[0m\n"]
+         "    \e[0;31;49mI warned you, dude. Here's an ERROR. :(\e[0m\n"],
       )
     end
 
@@ -185,7 +185,7 @@ describe Mnogootex::Log::Processor do
 
       expect(my_processor.run(log.lines)).to eq(
         ["    Hey, I'm warning you, dude. Stuff is gonna get bad.\n",
-         "    I warned you, dude. Here's an ERROR. :(\n"]
+         "    I warned you, dude. Here's an ERROR. :(\n"],
       )
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mnogootex
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Paolo Brasolin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-06 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,22 +175,26 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/actions/setup-ruby/action.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- demo/.mnogootexrc
+- demo/demo.asciicast
+- demo/demo.gif
+- demo/main.tex
 - exe/mnogootex
 - lib/mnogootex.rb
 - lib/mnogootex/cfg.rb
 - lib/mnogootex/cli.rb
-- lib/mnogootex/core_ext.rb
-- lib/mnogootex/defaults.yml
 - lib/mnogootex/job/logger.rb
 - lib/mnogootex/job/porter.rb
 - lib/mnogootex/job/runner.rb
@@ -202,7 +206,6 @@ files:
 - lib/mnogootex/log/matcher.rb
 - lib/mnogootex/log/matchers.yml
 - lib/mnogootex/log/processor.rb
-- lib/mnogootex/mnogoo.sh
 - lib/mnogootex/utils.rb
 - lib/mnogootex/version.rb
 - mnogootex.gemspec
@@ -212,7 +215,6 @@ files:
 - spec/mnogootex/log/processor_spec.rb
 - spec/mnogootex/utils_spec.rb
 - spec/spec_helper.rb
-- tty.gif
 homepage: https://github.com/tetrapharmakon/mnogootex
 licenses:
 - MIT

data/lib/mnogootex/core_ext.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-class Object
-  def if
-    tap { |object| break unless yield object }
-  end
-
-  def unless
-    tap { |object| break if yield object }
-  end
-end

data/lib/mnogootex/defaults.yml

@@ -1,7 +0,0 @@
-# This is the default configuration file
-spinner: ⣾⣽⣻⢿⡿⣟⣯⣷
-commandline:
-  - latexmk
-  - -pdf
-  - --interaction=nonstopmode
-work_path: null

data/lib/mnogootex/mnogoo.sh

@@ -1,21 +0,0 @@
-# Usage: source this in your bash profile as
-# [ -s "$(mnogootex mnogoo)" ] && . "$(mnogootex mnogoo)"
-
-mnogoo () {
-    if [ "$1" = cd ]; then
-        MN_PATH="$(IS_MNOGOO=true mnogootex dir "${@:2}")" || return
-        cd "$MN_PATH" || exit
-    elif [ "$1" = open ]; then
-        MN_PATH="$(IS_MNOGOO=true mnogootex pdf "${@:2}")" || return
-        if command -v open >/dev/null 2>&1; then
-            printf '%s\n' "$MN_PATH" | while read -r line; do open "$line"; done
-        elif command -v xdg-open >/dev/null 2>&1; then
-            printf '%s\n' "$MN_PATH" | while read -r line; do xdg-open "$line"; done
-        else
-            echo "No known file opener (open, xdg-open) found on your system."
-            echo "Please do chime in with suggestions: <paolo.brasolin@gmail.com>"
-        fi
-    else
-        IS_MNOGOO=true mnogootex "$@"
-    fi
-}