initial commit based on content from salvis.com

Author: PhilippSalvisberg

FAQ.md

@@ -0,0 +1,41 @@
+# Frequently Asked Questions
+
+## I cannot install any extension on macOS
+
+Maybe you’ve run into a SQL Developer bug on macOS. See [this blog post](https://www.salvis.com/blog/2015/05/05/cannot-install-extensions-in-sql-developer-4-on-mac-os-x/) for problem details and solution.
+
+## I cannot install any extension on Windows
+
+Have you installed SQL Developer in “C:\Program Files” or “C:\Program Files(x86)”? In this case the files are read-only for a standard Windows user.
+
+To solve the problem start SQL Developer as Administrator or install SQL Developer in an user folder. While the former requires local administrator rights, the latter is always feasible.
+
+## I’ve got errors in the extensions log after installation. What’s wrong?
+
+You are probably using an outdated version of SQL Developer. In this case you see after a restart an error message in the Extensions-Log similar to the following:
+
+![Extensions Log](images/extensions-log.png)
+
+SQL Developer 1.x, 2.x and 3.x are based on the Extension Software Development Kit (ESDK) version 1. SQL Developer 4.x requires the use of ESDK version 2. Unfortunately these versions are not compatible. So we decided to support the newest SQL Developer version only.
+
+Please update to SQL Developer 4.x or later since this is a prerequisite for this extension.
+
+## What are the limitations?
+
+See [parser limitations](parser-limitations.md) and [validator limitations](validator-limitations.md).
+
+## What has changed in the latest version?
+
+See the [release information](https://github.com/Trivadis/plsql-cop-sqldev/releases) for each version.
+
+## What is the difference between "PL/SQL Cop" and "PL/SQL Cop for SQL Developer"?
+
+*PL/SQL Cop* is a standalone command line utility. It processes SQL*Plus scripts within a directory tree and produces an HTML report and an Excel workbook. It reports metrics on file and PL/SQL unit level as well as violations of the [Trivadis PL/SQL & SQL Coding Guidelines Version 3.6](https://trivadis.github.io/plsql-and-sql-coding-guidelines/v3.6/).
+
+*PL/SQL Cop for SQL Developer* is a cost-free extension to Oracle’s SQL Developer. It processes the content of an editor window and produces a HTML report which is similar to the one of PL/SQL Cop but reduced and adapted to the scope of a single editor window. Additionally the violations of the [Trivadis PL/SQL & SQL Coding Guidelines Version 3.6](https://trivadis.github.io/plsql-and-sql-coding-guidelines/v3.6/) are presented in a dedicated tab pane linked to the editor window to support quick navigation to the corresponding code.
+
+## What are the licensing terms?
+
+The preview/trial version of PL/SQL Cop is licensed under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License. You may obtain a copy of the License at https://creativecommons.org/licenses/by-nc-nd/3.0/.
+
+![CC-BY_NC-ND](images/CC-BY-NC-ND.png)

README.md

@@ -0,0 +1,65 @@
+# PL/SQL Cop for SQL Developer
+
+## Introduction
+
+Trivadis PL/SQL Cop for SQL Developer is a free extension to check an editor content for compliance violations of the [Trivadis PL/SQL & SQL Coding Guidelines Version 3.6](https://trivadis.github.io/plsql-and-sql-coding-guidelines/v3.6/).
+
+PL/SQL Cop calculates metrics per PL/SQL unit, such as:
+
+- McCabe’s cyclomatic complexity
+- Halstead’s volume
+- The maintainability index
+- Lines
+- Commands (SQL*Plus and SQL)
+- Statements (within a PL/SQL unit)
+- etc.
+
+And aggregates them on file level.
+
+The results are presented in an additional tabbed panel. One tab shows all guideline violations to quickly navigate to the corresponding code position. The other tab contains a full HTML report, which also may be opened in your external browser.
+
+## Examples
+
+Open an Oracle PL/SQL or SQL script in a SQL Developer editor and press Ctrl-Shift-C to check your code against the Trivadis PL/SQL & SQL guidelines.
+
+![Check](images/tvdcc-sqldev-check.png)
+
+Navigate through the issues using the cursor keys to highlight the related code section in the linked editor.
+
+![Issues](images/tvdcc-sqldev-issues.png)
+
+Dock the PL/SQL Cop output window on your favorite position within SQL Developer and click on the report tab to reveal some additional metrics. Open the report in an external browser to print or save the report.
+
+![Report](images/tvdcc-sqldev-report.png)
+
+## Configure Update Center
+
+Click the “Help” menu and select “Check for Updates…”. Press the “Add” button to register the update center http://update.salvis.com/ . If you have troubles to configure the proxy settings, because your company requires some additional authentication or similar, then I suggest to download PL/SQL Cop for SQL Developer via the “Download” button below and use the “Install From Local File” option.
+
+![Update Center](images/salvis-update-center.png)
+
+## Releases
+
+You find all releases and release information [here](https://github.com/Trivadis/plsql-cop-sqldev/releases).
+
+## Issues
+Please file your bug reports, enhancement requests, questions and other support requests within [Github's issue tracker](https://help.github.com/articles/about-issues/).
+
+* [Questions](https://github.com/trivadis/plsql-cop-sqldev/issues?q=is%3Aissue+label%3Aquestion)
+* [Open enhancements](https://github.com/trivadis/plsql-cop-sqldev/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement)
+* [Open bugs](https://github.com/trivadis/plsql-cop-sqldev/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
+* [Submit new issue](https://github.com/trivadis/plsql-cop-sqldev/issues/new)
+
+## Frequently Asked Questions
+
+see [Frequently Ased Questions](FAQ.md).
+
+## Further Information
+
+Please find further information about PL/SQL Cop on the [Trivadis](https://www.trivadis.com/en/plsql-cop) website.
+
+## License
+
+PL/SQL Cop for SQL Developer is licensed under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License. You may obtain a copy of the License at https://creativecommons.org/licenses/by-nc-nd/3.0/.
+
+![CC-BY_NC-ND](images/CC-BY-NC-ND.png)