Introduce EditorConfig

[szepeviktor]

• The contributed code is licensed under GPL v2.0
• Contributor Licence Agreement (CLA) is signed
• util/update-modules has been ran
• Documentation updated
• Test suite update

[svetasmirnova]

@szepeviktor, what is the status of your PR? Are you still working on it and want to keep it draft?

[szepeviktor]

Finishing it right away.

[szepeviktor]

Using consistent (by simply counting spaces) indentation is a no-go for perl code.
I've just installed cpanminus and issued cpanm Perl::Tidy

Parenthesis spacing is so chaotic in the code that I'm unable to select a style.
https://perltidy.sourceforge.net/tutorial.html#bt--pt--sbt:-Container-tightness
Should it be -pt=0 or -pt=1 or -pt=2? Please help me.

For example

perltidy -b -i=3 -l=120 -pt=1 bin/pt-visual-explain
git diff -- bin/pt-visual-explain

[svetasmirnova]

Percona Toolkit is based on Maatikit product. Here are the coding standards for Maatkit: https://code.google.com/archive/p/maatkit/wikis/CodingStandards.wiki. They were not fully followed in recent years but I believe we can restore them.

Here is example config for perltidy:
Example .perltidyrc file:

-l=78 # Max line width is 78 cols 
-i=3 # Indent level is 4 cols 
-ci=3 # Continuation indent is 4 cols 
-b # In-place update
#-st # Output to STDOUT 
-se # Errors to STDERR 
-vt=2 # Maximal vertical tightness 
-cti=0 # No extra indentation for closing brackets 
-pt=1 # Medium parenthesis tightness 
-bt=1 # Medium brace tightness 
-sbt=1 # Medium square bracket tightness 
-bbt=1 # Medium block brace tightness 
-nsfs # No space before semicolons 
-nolq # Don't outdent long quoted strings 
-wbb="% + - * / x != == >= <= =~ !~ < > | & >= < = **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x=" 

[szepeviktor]

Thank you.
I will run perltidy on all perl files and that is the end of this PR.

-b
-l=100 # Max line width
-i=3 # Indent level
-ci=3 # Continuation indent
-se # Errors to STDERR
-vt=2 # Maximal vertical tightness
-cti=0 # No extra indentation for closing brackets
-pt=1 # Medium parenthesis tightness
-bt=1 # Medium brace tightness
-sbt=1 # Medium square bracket tightness
-bbt=1 # Medium block brace tightness
-nsfs # No space before semicolons
-nolq # Don't outdent long quoted strings
-wbb="% + - * / x != == >= <= =~ !~ < > | & >= < = **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="

[szepeviktor]

git ls-files -- 'lib/**.pm' | xargs -t -L 1 -- perltidy

perltidy makes artistic indentations go away

- sub _d {
-    my ($package, undef, $line) = caller 0;
-    @_ = map { (my $temp = $_) =~ s/\n/\n# /g; $temp; }
-         map { defined $_ ? $_ : 'undef' }
-         @_;
-    print STDERR "# $package:$line $PID ", join(' ', @_), "\n";
- }

+    sub _d {
+       my ( $package, undef, $line ) = caller 0;
+       @_ = map { ( my $temp = $_ ) =~ s/\n/\n# /g; $temp; }
+          map { defined $_ ? $_ : 'undef' } @_;
+       print STDERR "# $package:$line $PID ", join( ' ', @_ ), "\n";
+    }

[szepeviktor]

I have modified line length and added -b to overwrite files (in the above comment).

@svetasmirnova This is above my pay grade.
What do you think?

[svetasmirnova]

@szepeviktor I think it does not make sense to format code just in sake to make it compatible with perltidy. Let's have only 3 spaces in the config and don't do other formatting. We can always add additional configuration rules into .editorconfig later.

[szepeviktor]

Done.