Merge tag 'upstream/20160302'

[perltidy.git] / TODO

diff --git a/TODO b/TODO
index 8eaabd68ac248c0196261ad30995240f6ae16a8a..396c5d0a405c30c829871465952c491b0aeb2378 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,30 +1,11 @@
 Perltidy TODO List
-    This is a partial "wish-list" of features to add and things to do. All
-    of these are of interest, but there is no particular schedule for
-    implementing them.
+    This is a partial "wish-list" of features to add and things to do. For
+    the latest list of bugs and feature requests at CPAN see:
 
-  Improved Vertical Alignment
-    There are many opportunities for improving vertical alignment.
-
-  improved ?: formatting
-    An indentation level should be associated with ?: statements. This would
-    make nested ?: statements more readable.
-
-  improved internal if/unless formatting
-    Consider giving internal if/unless statements an additional level of
-    indentation. This would avoid running out of indentation levels.
-    Suggested by Jeff Armstorng. For example, we would like the 'ands' in
-    the following statement to be indented more than the if:
+    https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy
 
-        return $ship->chargeWeapons("phaser-canon")
-          if $encounter->description eq 'klingon'
-          and $ship->firepower >= $encounter->firepower
-          and $location->status ne 'neutral';
-
-  enable -ole under Windows
-    This only works under unix (or cygwin) at present. It doesn't work for
-    Windows versions, such as Active State, because they change line endings
-    that they don't like.
+  Improved Vertical Alignment
+    There are still many opportunities for improving vertical alignment.
 
   Documentation
     A FAQ is needed to explain some of the more subtle formatting issues,
@@ -39,12 +20,20 @@ Perltidy TODO List
     multi-line quotes. Then code needs to be written to scan for and markup
     identifiers.
 
-  Automatic style detection
-    It would be nice to write a program to read a sample of perl code and
-    write an approximate .perltidyrc file for that style.
-
 Things which have been suggested but will not be done
   Recursive file processing
-    A -r flag might be nice, but this is probably best handled by an
-    exterior shell script.
+    A -r flag might be nice, but this is best handled by an exterior shell
+    script.
+
+  Make perltidy support the syntax of module XXX
+    This generally won't be done unless the module is part of the core perl
+    distribution because it is such an open-ended problem. Compounding the
+    problem is the fact that perltidy often is invoked within an editor on
+    small snippets of code, so it must to work correctly without seeing any
+    particular 'use xxx' statement. Therefore, any syntax changes that
+    conflict with standard Perl syntax can't easily be handled.
+
+    However, an effort is being made to make perltidy generally more
+    tolerant of extensions to perl syntax. Also, the pre- and post-filter
+    capabilities of the Tidy.pm module may help.