Pretty - Revision history

Dkearns: s/LibertyEiffel/Liberty Eiffel/

2016-06-22T02:06:43Z

s/LibertyEiffel/Liberty Eiffel/

← Older revision		Revision as of 04:06, 22 June 2016
Line 1:		Line 1:
	[[Category:Tool]]		[[Category:Tool]]

−	<TT>pretty</TT> is the ~~LibertyEiffel~~ pretty-printer (code beautifier) for Eiffel source files. In a normal installation, it is invoked by the command <b><TT>[[se]] pretty</TT></b>.	+	<TT>pretty</TT> is the Liberty Eiffel pretty-printer (code beautifier) for Eiffel source files. In a normal installation, it is invoked by the command <b><TT>[[se]] pretty</TT></b>.

	== Synopsis ==		== Synopsis ==
Line 26:		Line 26:
	\|-		\|-
	\| valign="top" \| <code>-version</code>		\| valign="top" \| <code>-version</code>
−	\| Display the ~~LibertyEiffel~~ version number.	+	\| Display the Liberty Eiffel version number.
	\|}		\|}

Dkearns: Document -flymake_mode

2016-06-14T17:00:01Z

Document -flymake_mode

@@ Line 13: / Line 13: @@
 There are four modes of pretty reformatting: ''-zen'', ''-default'', ''-end'' and ''-parano'' mode. Only one mode can be selected and ''-default'' is the default mode.
-=== Options for pretty reformatting ===
+=== Options ===
 {| cellspacing="4" cellpadding="0" width="100%"
@@ Line 25: / Line 27: @@
 | valign="top" | <code>-version</code>
 | Display the LibertyEiffel version number.
 |-
 | valign="top" | <code>-zen</code>
 | Produce as little as possible (i.e. very compact output). No end mark comment for routines, no end comments for statements (if, inspect, debug, ...).

Hzwakenberg at 18:44, 5 September 2014

2014-09-05T18:44:27Z

← Older revision		Revision as of 20:44, 5 September 2014
Line 1:		Line 1:
−	[[Category:Smarteiffel]]
	[[Category:Tool]]		[[Category:Tool]]

−	<TT>pretty</TT> is the ~~SmartEiffel~~ pretty-printer (code beautifier) for Eiffel source files. In a normal installation, it is invoked by the command <b><TT>[[se]] pretty</TT></b>.	+	<TT>pretty</TT> is the LibertyEiffel pretty-printer (code beautifier) for Eiffel source files. In a normal installation, it is invoked by the command <b><TT>[[se]] pretty</TT></b>.

	== Synopsis ==		== Synopsis ==
Line 25:		Line 24:
	\|-		\|-
	\| valign="top" \| <code>-version</code>		\| valign="top" \| <code>-version</code>
−	\| Display the ~~SmartEiffel~~ version number.	+	\| Display the LibertyEiffel version number.
	\|-		\|-
	\| valign="top" \| <code>-zen</code>		\| valign="top" \| <code>-zen</code>

Ramack at 21:11, 4 March 2013

2013-03-04T21:11:36Z

← Older revision		Revision as of 23:11, 4 March 2013
Line 1:		Line 1:
		+	[[Category:Smarteiffel]]
−	<!-- translation hint: see http://smarteiffel.loria.fr/man/pretty.html -->
		+	[[Category:Tool]]

	<TT>pretty</TT> is the SmartEiffel pretty-printer (code beautifier) for Eiffel source files. In a normal installation, it is invoked by the command <b><TT>[[se]] pretty</TT></b>.		<TT>pretty</TT> is the SmartEiffel pretty-printer (code beautifier) for Eiffel source files. In a normal installation, it is invoked by the command <b><TT>[[se]] pretty</TT></b>.

Ramack: 3 revisions: initial import from SamrtEiffel Wiki - The Grand SmartEiffel Book

2013-03-03T21:46:27Z

3 revisions: initial import from SamrtEiffel Wiki - The Grand SmartEiffel Book

New page

<TT>pretty</TT> is the SmartEiffel pretty-printer (code beautifier) for Eiffel source files. In a normal installation, it is invoked by the command <b><TT>[[se]] pretty</TT></b>.

== Synopsis ==

* <code>se pretty [options] <source_file></code>

The <code>source_file</code> argument must be some existing Eiffel source file path as for example <code>"integer.e"</code> or <code>"lib/kernel/integer.e"</code>.

One can specify more than one file name at a time in order to apply the pretty command to all the specified files. All the corresponding files are rewritten in a pretty way.

There are four modes of pretty reformatting: ''-zen'', ''-default'', ''-end'' and ''-parano'' mode. Only one mode can be selected and ''-default'' is the default mode.

=== Options for pretty reformatting ===

{| cellspacing="4" cellpadding="0" width="100%"
|-
| width="20%" valign="top" | <code>-help</code>
| Display a short summary of the command line syntax, as well as a complete list of <code>pretty</code>'s options.
|-
| valign="top" | <code>-verbose</code>
| Display (an enormous amount of) information during the process: a complete list of files loaded, and so on.
|-
| valign="top" | <code>-version</code>
| Display the SmartEiffel version number.
|-
| valign="top" | <code>-zen</code>
| Produce as little as possible (i.e. very compact output). No end mark comment for routines, no end comments for statements (if, inspect, debug, ...).
|-
| valign="top" | <code>-default</code>
| The default mode. This is close to what we are using for our library.
|-
| valign="top" | <code>-end</code>
| The same format as <code>-default</code> but add end mark comments for all routines.
|-
| valign="top" | <code>-parano</code>
| Same format as <code>-end</code> but add end mark comments for all statements (if, inspect, debug, ...).
|-
| valign="top" | <code>-no_warning</code>
| Suppress output for all warning messages (error messages are still printed).
|}

== Security and Backup File ==

For the security of your sources files, a backup file is created before writing the new file. The backup file name is <code>"foo.bak"</code> when source file name is <code>"foo.e"</code>. The backup file is written in the same directory as the source file.

If an old backup file already exists before pretty printing, the pretty command exits with an error message.

To be sure that the pretty-printing is correct, the output file is parsed again. Even if the second parsing gives no errors, backup file is '''not''' removed. Thus you can recompile and test your Eiffel program to check that the beautified files did not break anything, before removing the backup files yourself.

Cadrian: /* Options for pretty printing */ typo

2006-05-24T12:11:37Z

Options for pretty printing: typo

← Older revision		Revision as of 14:11, 24 May 2006
Line 37:		Line 37:
	\| valign="top" \| <code>-parano</code>		\| valign="top" \| <code>-parano</code>
	\| Same printing as <code>-end</code> but also print end mark comments for all statements (if, inspect, debug, ...).		\| Same printing as <code>-end</code> but also print end mark comments for all statements (if, inspect, debug, ...).
		+	\|-
−	\|- valign="top" \| <code>-no_warning</code>
		+	\| valign="top" \| <code>-no_warning</code>
	\| Suppress output for all warning messages (error messages are still printed).		\| Suppress output for all warning messages (error messages are still printed).
	\|}		\|}

Cadrian: from the old page

2006-05-24T12:07:18Z

from the old page

New page

<TT>pretty</TT> is the SmartEiffel pretty-printer (code beautifier) for Eiffel source files. In a normal installation, it is invoked by the command <b><TT>[[se]] pretty</TT></b>.

== Synopsis ==

* <code>se pretty [options] <source_file></code>

The <code>source_file</code> argument must be some existing Eiffel source file path as for example <code>"integer.e"</code> or <code>"lib/kernel/integer.e"</code>.

One can specify more than one file name at a time in order to apply the pretty command on all the specified files. All the corresponding files are reprinted in a pretty way.

There are four modes of pretty-printing: ''-zen'', ''-default'', ''-end'' and ''-parano'' mode. Only one mode can be selected and the mode ''-default'' is the default mode.

=== Options for pretty printing ===

{| cellspacing="4" cellpadding="0" width="100%"
|-
| width="20%" valign="top" | <code>-help</code>
| Display a short summary of the command line syntax, as well as a complete list of <code>pretty</code>'s options.
|-
| valign="top" | <code>-verbose</code>
| Display (an enormous amount of) information during the process: a complete list of files loaded, and so on.
|-
| valign="top" | <code>-version</code>
| Display the SmartEiffel version number.
|-
| valign="top" | <code>-zen</code>
| Print as few as possible (i.e. very compact output). No end mark comment for routines, no end comments for statements (if, inspect, debug, ...).
|-
| valign="top" | <code>-default</code>
| The default mode. This is close to what we are using for our library.
|-
| valign="top" | <code>-end</code>
| The same printing as <code>-default</code> but also print end mark comments for all routines.
|-
| valign="top" | <code>-parano</code>
| Same printing as <code>-end</code> but also print end mark comments for all statements (if, inspect, debug, ...).
|- valign="top" | <code>-no_warning</code>
| Suppress output for all warning messages (error messages are still printed).
|}

== Security and Backup File ==

For the security of your sources files, a backup file is created before writing the new file. The backup file name is <code>"foo.bak"</code> when source file name is <code>"foo.e"</code>. The backup file is written in the same directory as the source file.

If an old backup file already exists before pretty printing, the pretty command exits with an error message.

To be sure that the pretty-printing is correct, the output file is parsed again. Even if the second parsing gives no errors, backup file is '''not''' removed. Thus you can recompile and test your Eiffel program to check that the beautified files did not break anything, before removing the backup files yourself.