Differences

This shows you the differences between two versions of the page.

--- en:devmon:guidelines:tidy [2021/08/19 06:49] – [usage] adminw1k1
+++ en:devmon:guidelines:tidy [2021/08/22 14:35] (current) – [Tidy Document] adminw1k1
@@ Line 5: / Line 5: @@
 ==== Tidy Code ====
-easier to keep code clean, you can follow this guide
+To keep the code clean, follow this guide (but dont worry if you dont!)
-=== Objective ===
+=== Tools===
   *Tidy perl code, ... (perltidy)
   *Follow best practice (perlcritic)
@@ Line 13: / Line 13: @@
 === Installation ===
-Cpan minus (cpanm) install latest package, but this can break be in conflict with OS package manager. Make a backup if you can first.
+Cpan minus (cpanm) install the latest package, but this can break be in conflict with OS package manager.
 <code>
@@ Line 59: / Line 59: @@
   * use warning;
   * use utf8;
+==== Tidy Document ====
+To keep clean the other documents that are not code, follow this guide (but dont worry if you dont!)
+=== Tools===
+  * Autoformat
+=== Current Best Practice with autoformat ===
+  * 78 char per line
+  * (stating at pos 0)
+=== Installation ===
+Cpan minus (cpanm) install the latest package, but this can break be in conflict with OS package manager.
+<code>
+cpanm install Text::Autoformat
+</code>
+Create the following script: (I named it: autoformat.pl)
+<code>
+#!/usr/bin/perl -w
+# Minimal use: read from STDIN, format to STDOUT...
+use strict;
+use Text::Autoformat;
+my $str = do { local $/; <STDIN> };
+my $out = autoformat $str, {left=>0, right=>78, all=>1};
+print $out;
+</code>
+And now you can format any text or markdown (this will not rendered in a Markdown reader, but Markdown files becomes more readable when they are read "without" a Markdown reader. (like basic vi , less and other standard tools)
+Make your script exectutable
+<code>
+chmod +x autoformat.pl
+</code>
+And test it!
+<code>
+autoformat.pl < unformated.txt > formated.txt
+autoformat.pl < unformated.md > formated.md
+</code>