Abandoned

This project was initially started to replace version 1 of detox, which was written in C, with a version written in PHP. I choose PHP because it is my primary development language these days, both professionally and personally.

I also wanted to leverage modern libraries, to help with transliterating characters, and maybe simplify the process for all. Unfortunately, truly broken filenames, e.g. invalid bytes in a UTF-8 character, cannot be handled like this, and repeatedly broke the foundation I was trying to use. In the end, I opted to do a refresh in C, migrating the legacy codebase to modern practices.

For that reason, I am abandoning this project, and archiving the repository.

Thank you.

---

The original README follows below.

Warning

Detox is in the middle of a major rewrite.

This code in this repository is half-finished and not ready for production.

Mission of v2.x

The mission of this rewrite is to update detox to make it easier to use and easier to maintain.

Simplify

• The choice to use config files and translation tables was complete over-engineering. This problem can be solved with a few command line switches.

Language

• I haven't written C seriously in well over two decades; supporting a C-based project is not happening at this point in my life, when my professional development is all done in PHP.

Code Reuse

• Write the filters in a way that allows them to be used in other projects.

Focus

• Modern Linux supports UTF-8 at the command line. There isn't a strong reason to transliterate UTF-8 characters to ASCII under normal circumstances.
• There is, however, a compelling reason to replace characters that have special meaning on the typical Linux command line. Characters like $, :, (, ), [, ] are all problematic more or less.

Requirements

• composer
• git
• php (7.2.5 or higher)

Installation

git clone https://github.com/dharple/detox-php.git
cd detox-php
composer check-platform-reqs

If everything looks good after the previous check, install the project dependencies:

composer install --no-dev -o

If you have box installed globally, you can use that to build the utility:

box compile
box compile -c box-inline.json

Otherwise, we provide our own:

bin/compile
bin/compile-inline

Finally, install the resulting PHAR file to /usr/local/bin:

sudo cp dist/detox.phar /usr/local/bin/detox
sudo cp dist/inline-detox.phar /usr/local/bin/inline-detox

Contact

Doug Harple detox.dharple@gmail.com