User Tools

Site Tools


en:devmon:guidelines:tidy

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
en:devmon:guidelines:tidy [2021/08/19 22:54] – [Tidy Code] adminw1k1en:devmon:guidelines:tidy [2021/08/22 14:35] (current) – [Tidy Document] adminw1k1
Line 68: Line 68:
  
   * Autoformat   * Autoformat
 +
 +=== Current Best Practice with autoformat === 
 +  * 78 char per line
 +  * (stating at pos 0)
  
 === Installation ===  === Installation === 
Line 74: Line 78:
 cpanm install Text::Autoformat cpanm install Text::Autoformat
 </code> </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>
 +
 +
 +
 +
en/devmon/guidelines/tidy.1629406459.txt.gz · Last modified: 2021/08/19 22:54 by adminw1k1