PL/SQL & SQL Formatter Settings

Introduction

This repository provides formatter settings for the coding style rules of the Trivadis PL/SQL & SQL Coding Guidelines.

Settings are primarily provided for

• Oracle SQLcl, Version 23.1.0
• Oracle SQL Developer, Version 23.1.0

These settings have been defined and tested with the product versions mentioned above. They might not work in other versions.

JDK 11 is required for SQLDev and SQLcl. The standalone tvdformat.jar works with JDK 11 or newer.

See releases for settings supporting older versions.

Deviating Settings

Please note that these settings do not comply with rule 5. Line breaks are placed after a comma and not before. All other rules are followed. However, you can easily change this in the preferences.

Installation

Common

Clone this repository or download the ZIP file and extract it.

SQLcl

See sqlcl/README.md.

Standalone Formatter

See standalone/README.md

SQL Developer

1. Start SQL Developer
2. Open Preferences
3. Select Code Editor -> Format -> Advanced Format
4. Press Import...
5. Select trivadis_advanced_format.xml
6. Press Open
7. Select Code Editor -> Format -> Advanced Format -> Custom Format
8. Press Import...
9. Select trivadis_custom_format.arbori
10. Press Open
11. Press OK to save the settings

Git pre-commit Hook

See hook/README.md.

Nice to Know

Lightweight Formatter

The Arbori program implements a lightweight formatter which accepts different coding styles. The primary scope of the formatter is the following SQL statements:

• create function
• create package
• create package body
• create procedure
• create trigger
• create type
• create type body
• create view (including the subquery part of create materialized view)
• delete
• insert
• merge
• select
• update

Other statements like create table or create tablespace are basically left as is. There are some exceptions like adding line breaks after reaching the maximum line length and changing the case of keywords and identifiers. But that's it.

If you need a heavyweight formatter to enforce the conformity of your code, you will need to use the default Arbori program provided by the SQL Developer team.

In any case, you can use our SQLcl JavaScript format.js, the standalone formatter or the Git pre-commit hook to format your code.

Disable Formatter

The formatter is enabled by default. You can disable the formatter with a single-line or multi-line comment containing @formatter:off. From that point on, whitespace are kept as is. To re-enable the formatter use @formatter:on.

The marker comments are case sensitive.

Here's an example showing the code after calling the formatter:

-- @formatter:off
select decode(dummy, 'X', 1 
                   , 'Y', 2
                   , 'Z', 3
                        , 0) /* @formatter:on */
  from dual;

Arbori

SQL Developer uses its own parse tree query language called Arbori for its advanced formatter configuration. Here is some additional information that might be useful if you plan to tweak the behavior of the formatter yourself.

Links

• SQL Developer 22.2 User Guide, Code Editor: Format
• Formatting Code With SQL Developer
• Formatter Callback Functions
• Arbori Starter Manual
• Semantic Analysis with Arbori
• Arbori Semantic Actions
• Custom Formatting in SQLDev 4.2
• Formula for Formatting
• Custom Syntax Coloring
• Arbori 20.2
• Java Script Conditions

Thank you, Vadim Tropashko for providing this valuable information.

JavaScript Global Variables

To get the most out of the dynamic JavaScript actions from an Arbori program, you should know the following global variables and their corresponding Java class.

Settings for other Products

Formatter settings are also provided for the following products:

Please refer to the vendor's documentation for instructions on how to import these settings.

License

The Trivadis PL/SQL & SQL Formatter Settings are licensed under the Apache License, Version 2.0. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.