` and `` tags (half the normal indentation)
-- Special handling for lines with multiple closing tags
-
-### Embedded Perl Formatting
-
-The formatter uses perltidy to format embedded Perl code blocks (enclosed in `<%` and `%>` tags). This ensures that your Perl code follows consistent formatting rules.
-
-### Perltidy Output Files
-
-When using the `--perltidy-output-dir` option, the formatter saves both the original and formatted Perl code for each embedded Perl block to separate files:
-
-- `perl_block_N_original.pl`: The original Perl code before formatting
-- `perl_block_N_formatted.pl`: The formatted Perl code after perltidy processing
-
-## Example
-
-### Input
-
-```perl
-
-<%
-# This is a test of pure Perl code with minimal indentation
-if ($status) {
- $c->desktopBackupRecordStatus($backup_rec, 'pre-backup', $status);
- return ($c->l('bac_OPERATION_STATUS_REPORT').$c->l('bac_ERR_PRE_BACKUP'));
+<%
+my $x=1;
+if($x){
+say"hi";
}
-
-my $clvl = $c->stash('compressionlevel');
-my $cmd = "/bin/tar --create --file=- --directory / @{$c->stash('exclude')} "
- . "@{$c->stash('directories')} | /usr/bin/gzip $clvl ";
%>
-
```
-### Output
-
-```perl
-
- <%
- # This is a test of pure Perl code with minimal indentation
- if ($status) {
- $c->desktopBackupRecordStatus($backup_rec, 'pre-backup', $status);
- return ($c->l('bac_OPERATION_STATUS_REPORT') . $c->l('bac_ERR_PRE_BACKUP'));
- }
- my $clvl = $c->stash('compressionlevel');
- my $cmd = "/bin/tar --create --file=- --directory / @{$c->stash('exclude')} "
- . "@{$c->stash('directories')} | /usr/bin/gzip $clvl ";
- %>
-
+Becomes (with --indent 4):
```
+<%
+my $x = 1;
+if ($x) {
+ say "hi";
+}
+%>
+```
+
+## Options
+
+- -w, --write: Overwrite files in place (writes a .bak backup)
+- -o, --out FILE: Write formatted output to FILE (single input or --stdin)
+- --check: Exit non-zero if any file would change
+- --diff: Print unified diff
+- --stdin / --stdout: Pipe mode
+- --perltidy PATH: Path to perltidy executable
+- --indent N: Indent width (spaces; default 2)
+- --eol lf|crlf|preserve: End-of-line handling (default lf)
+- --no-space-in-delims: Do not normalize spacing inside <% %> delimiters
+- --perl-keyword-spacing: Aggressively insert a space after common Perl keywords
+- --self-test: Run internal sanity checks and perltidy probe
+- --log-level error|info|debug: Logging verbosity (or use --verbose)
+- --version: Print version
+
+## File selection
+
+By default, mojofmt processes:
+- .ep
+- .htm.ep
+- .html.ep
+
+Directories are walked recursively; only matching files are formatted.
+
+## Tips and caveats
+
+- perltidy recommended: For best results on complex Perl inside templates, install perltidy. mojofmt falls back to a brace-aware indenter for extended blocks, but won’t do token-level Perl formatting without perltidy.
+- Extended block detection: Only triggers when the opening <% (or <%-) and closing %> (or -%>) are on their own lines. Inline <% ... %> on the same line are handled by the inline path.
+- Raw blocks: Content inside pre/script/style/textarea is not changed.
+- Chomp markers: Left/right chomps (<%- and -%>) are preserved and not moved.
+- Idempotent: Running mojofmt repeatedly should not keep changing the file (self-test checks this).
+- EOLs: Use --eol preserve to retain original line endings.
## Troubleshooting
-If you encounter issues with perltidy, the formatter will fall back to a simple indentation-based formatter for Perl code. Enable debug logging with the `--debug` flag to see detailed information about the formatting process.
+- perltidy non-zero exit N in debug logs:
+ - mojofmt wraps extended blocks in do { ... } for perltidy; if it still fails, run perltidy manually on the wrapper to see the error.
+ - Ensure perltidy is on PATH or pass --perltidy /path/to/perltidy.
+- Extended block didn’t reformat:
+ - Confirm the delimiters are on their own lines (no code on the <% / %> lines).
+ - Run with --log-level debug to see whether perltidy or the naive indenter handled the block.
+- Spaces around Perl keywords:
+ - Off by default. Enable with --perl-keyword-spacing if you want if(...)->if (...), my$->my $, return(...)->return (...), etc.
+
+## Development
+
+Run self-tests:
+- ./mojofmt.py --self-test
+- Use --log-level debug for detailed logs
+
+Format from stdin to stdout:
+- python3 mojofmt.py --stdin --stdout < in.ep > out.ep
+
+Generate a diff without writing:
+- python3 mojofmt.py --diff path/to/file.html.ep
+
+## Contributing
+
+- Open an issue or pull request with a clear description and a minimal repro template
+- Please include before/after snippets and your command-line flags
+- If you modify formatting rules, add/adjust a self-test where possible
## License
-This software is provided as-is, without any warranties or conditions of any kind.
\ No newline at end of file
+See LICENSE file in this repository. If you don’t have one yet, consider MIT or Apache-2.0.
+
+## Acknowledgments
+
+- Mojolicious and Mojo::Template for the EP syntax
+- Perl::Tidy for robust Perl formatting
\ No newline at end of file