Merge pull request #119 from Trivadis/feature/issue-111-formatter

Feature/issue 111 formatter

Author: PhilippSalvisberg

.gitignore

@@ -19,3 +19,6 @@
 
 # temporary files
 ~$SQL-and-SQL-Coding-Guidelines.doc
+
+# Visual Studio Code project folder
+.vscode

docs/3-coding-style/coding-style.md

@@ -20,24 +20,24 @@ Rule | Description
 
 ``` sql
 procedure set_salary(in_employee_id in employees.employee_id%type) is
-   cursor c_employees(p_employee_id in employees.employee_id%type) is 
+   cursor c_employees(p_employee_id in employees.employee_id%type) is
       select last_name
             ,first_name
             ,salary
         from employees
        where employee_id = p_employee_id
        order by last_name
-               ,first_name;
+            ,first_name;
 
-   r_employee     c_employees%rowtype;
-   l_new_salary   employees.salary%type;
+   r_employee   c_employees%rowtype;
+   l_new_salary employees.salary%type;
 begin
-   open  c_employees(p_employee_id => in_employee_id);
+   open c_employees(p_employee_id => in_employee_id);
    fetch c_employees into r_employee;
    close c_employees;
 
-   new_salary (in_employee_id => in_employee_id
-              ,out_salary     => l_new_salary);
+   new_salary(in_employee_id => in_employee_id
+             ,out_salary     => l_new_salary);
 
    -- Check whether salary has changed
    if r_employee.salary <> l_new_salary then

docs/4-language-usage/1-general/g-1010.md

@@ -11,7 +11,7 @@ It's a good alternative for comments to indicate the start and end of a named pr
 
 ``` sql
 begin
-   begin 
+   begin
       null;
    end;
 
@@ -27,7 +27,7 @@ end;
 ``` sql
 begin
    <<prepare_data>>
-   begin 
+   begin
       null;
    end prepare_data;
 

docs/4-language-usage/1-general/g-1020.md

@@ -14,13 +14,13 @@ Use a label directly in front of loops and nested anonymous blocks:
 
 ``` sql
 declare
-   i integer;
+   i            integer;
    co_min_value constant integer := 1;
    co_max_value constant integer := 10;
    co_increment constant integer := 1;
 begin
    <<prepare_data>>
-   begin 
+   begin
       null;
    end;
 
@@ -31,19 +31,19 @@ begin
 
    i := co_min_value;
    <<while_loop>>
-   while (i <= co_max_value) 
-   loop 
-      i := i + co_increment; 
+   while (i <= co_max_value)
+   loop
+      i := i + co_increment;
    end loop;
 
    <<basic_loop>>
-   loop 
+   loop
       exit basic_loop;
    end loop;
 
    <<for_loop>>
    for i in co_min_value..co_max_value
-   loop 
+   loop
       sys.dbms_output.put_line(i);
    end loop;
 end;
@@ -54,13 +54,13 @@ end;
 
 ``` sql
 declare
-   i integer;
+   i            integer;
    co_min_value constant integer := 1;
    co_max_value constant integer := 10;
    co_increment constant integer := 1;
 begin
    <<prepare_data>>
-   begin 
+   begin
       null;
    end prepare_data;
 
@@ -71,20 +71,20 @@ begin
 
    i := co_min_value;
    <<while_loop>>
-   while (i <= co_max_value) 
-   loop 
-      i := i + co_increment; 
+   while (i <= co_max_value)
+   loop
+      i := i + co_increment;
    end loop while_loop;
 
    <<basic_loop>>
-   loop 
+   loop
       exit basic_loop;
    end loop basic_loop;
 
    <<for_loop>>
    for i in co_min_value..co_max_value
-   loop 
-     sys.dbms_output.put_line(i);
+   loop
+      sys.dbms_output.put_line(i);
    end loop for_loop;
 end;
 /

docs/4-language-usage/1-general/g-1030.md

@@ -12,18 +12,20 @@ Unused variables decrease the maintainability and readability of your code.
 ``` sql
 create or replace package body my_package is
    procedure my_proc is
-      l_last_name  employees.last_name%type;
-      l_first_name employees.first_name%type;
+      l_last_name      employees.last_name%type;
+      l_first_name     employees.first_name%type;
       co_department_id constant departments.department_id%type := 10;
-      e_good exception;
+      e_good           exception;
    begin
       select e.last_name
         into l_last_name
         from employees e
        where e.department_id = co_department_id;
    exception
-      when no_data_found then null; -- handle_no_data_found;
-      when too_many_rows then null; -- handle_too_many_rows;
+      when no_data_found then
+         null; -- handle_no_data_found;
+      when too_many_rows then
+         null; -- handle_too_many_rows;
    end my_proc;
 end my_package;
 /
@@ -34,9 +36,9 @@ end my_package;
 ``` sql
 create or replace package body my_package is
    procedure my_proc is
-      l_last_name  employees.last_name%type;
+      l_last_name      employees.last_name%type;
       co_department_id constant departments.department_id%type := 10;
-      e_good exception;
+      e_good           exception;
    begin
       select e.last_name
         into l_last_name
@@ -45,8 +47,10 @@ create or replace package body my_package is
 
       raise e_good;
    exception
-      when no_data_found then null; -- handle_no_data_found;
-      when too_many_rows then null; -- handle_too_many_rows;
+      when no_data_found then
+         null; -- handle_no_data_found;
+      when too_many_rows then
+         null; -- handle_too_many_rows;
    end my_proc;
 end my_package;
 /

docs/4-language-usage/1-general/g-1040.md

@@ -13,38 +13,40 @@ Any part of your code, which is no longer used or cannot be reached, should be e
 declare
    co_dept_purchasing constant departments.department_id%type := 30;
 begin
-   if 2=3 then
+   if 2 = 3 then
       null; -- some dead code here
    end if;
-   
+
    null; -- some enabled code here
-   
+
    <<my_loop>>
    loop
-      exit my_loop;    
+      exit my_loop;
       null; -- some dead code here
    end loop my_loop;
 
    null; -- some other enabled code here
 
-   case 
+   case
       when 1 = 1 and 'x' = 'y' then
          null; -- some dead code here
       else
          null; -- some further enabled code here
    end case;
-   
+
    <<my_loop2>>
-   for r_emp in (select last_name
-                   from employees
-                  where department_id = co_dept_purchasing
-                     or commission_pct is not null 
-                    and 5=6) 
-                -- "or commission_pct is not null" is dead code 
+   for r_emp in (
+      select last_name
+        from employees
+       where department_id = co_dept_purchasing
+          or commission_pct is not null
+         and 5 = 6
+   ) 
+   -- "or commission_pct is not null" is dead code 
    loop
       sys.dbms_output.put_line(r_emp.last_name);
    end loop my_loop2;
-   
+
    return;
    null; -- some dead code here
 end;
@@ -62,10 +64,12 @@ begin
    null; -- some further enabled code here
 
    <<my_loop2>>
-   for r_emp in (select last_name
-                   from employees
-                  where department_id = co_dept_admin
-                     or commission_pct is not null) 
+   for r_emp in (
+      select last_name
+        from employees
+       where department_id = co_dept_admin
+          or commission_pct is not null
+   )
    loop
       sys.dbms_output.put_line(r_emp.last_name);
    end loop my_loop2;

docs/4-language-usage/1-general/g-1050.md

@@ -21,14 +21,14 @@ begin
      into l_job
      from employees e
     where e.manager_id is null;
-   
+
    if l_job = 'AD_PRES' then
       null;
    end if;
 exception
-   when no_data_found then 
+   when no_data_found then
       null; -- handle_no_data_found;
-   when too_many_rows then 
+   when too_many_rows then
       null; -- handle_too_many_rows; 
 end;
 /
@@ -54,9 +54,9 @@ begin
       null;
    end if;
 exception
-   when no_data_found then 
+   when no_data_found then
       null; -- handle_no_data_found;
-   when too_many_rows then 
+   when too_many_rows then
       null; -- handle_too_many_rows; 
 end;
 /

docs/4-language-usage/1-general/g-1060.md

@@ -13,11 +13,13 @@ Instead of using `rowid` for later reference to the original row one should use
 
 ``` sql
 begin
-   insert into employees_log (employee_id
-                             ,last_name
-                             ,first_name
-                             ,rid)
-   select employee_id 
+   insert into employees_log (
+      employee_id
+     ,last_name
+     ,first_name
+     ,rid
+   )
+   select employee_id
          ,last_name
          ,first_name
          ,rowid
@@ -31,9 +33,9 @@ end;
 ``` sql
 begin
    insert into employees_log (employee_id
-                             ,last_name
-                             ,first_name)
-   select employee_id 
+     ,last_name
+     ,first_name)
+   select employee_id
          ,last_name
          ,first_name
      from employees;

docs/4-language-usage/1-general/g-1080.md

@@ -14,21 +14,22 @@ This rule ignores operators `+`, `*` and `||`, and expressions: `1=1`, `1<>1`, `
 ``` sql
 select emp.first_name
       ,emp.last_name
-      ,emp.salary 
+      ,emp.salary
       ,emp.hire_date
   from employees emp
- where emp.salary > 3000 or emp.salary > 3000
- order by emp.last_name, emp.first_name;
+ where emp.salary > 3000
+    or emp.salary > 3000
+ order by emp.last_name,emp.first_name;
 ```
 
 ## Example (good)
 
 ``` sql
 select emp.first_name
       ,emp.last_name
-      ,emp.salary 
+      ,emp.salary
       ,emp.hire_date
   from employees emp
  where emp.salary > 3000
- order by emp.last_name, emp.first_name;
+ order by emp.last_name,emp.first_name;
 ```

docs/4-language-usage/2-variables-and-types/1-general/g-2110.md

@@ -20,8 +20,10 @@ create or replace package body my_package is
         from employees e
        where rownum = co_first_row;
    exception
-      when no_data_found then null; -- handle no_data_found
-      when too_many_rows then null; -- handle too_many_rows (impossible)
+      when no_data_found then
+         null; -- handle no_data_found
+      when too_many_rows then
+         null; -- handle too_many_rows (impossible)
    end my_proc;
 end my_package;
 /
@@ -40,8 +42,10 @@ create or replace package body my_package is
         from employees e
        where rownum = co_first_row;
    exception
-      when no_data_found then null; -- handle no_data_found
-      when too_many_rows then null; -- handle too_many_rows (impossible)
+      when no_data_found then
+         null; -- handle no_data_found
+      when too_many_rows then
+         null; -- handle too_many_rows (impossible)
    end my_proc;
 end my_package;
 /