Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
230 changes: 228 additions & 2 deletions phpstorm/PHPQA_Code_Style_Scheme.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
<code_scheme name="Default" version="173">
<code_scheme name="PHPQA" version="173">
<DBN-PSQL>
<case-options enabled="false">
<option name="KEYWORD_CASE" value="lower" />
<option name="FUNCTION_CASE" value="lower" />
<option name="PARAMETER_CASE" value="lower" />
<option name="DATATYPE_CASE" value="lower" />
<option name="OBJECT_CASE" value="preserve" />
</case-options>
<formatting-settings enabled="false" />
</DBN-PSQL>
<DBN-SQL>
<case-options enabled="false">
<option name="KEYWORD_CASE" value="lower" />
<option name="FUNCTION_CASE" value="lower" />
<option name="PARAMETER_CASE" value="lower" />
<option name="DATATYPE_CASE" value="lower" />
<option name="OBJECT_CASE" value="preserve" />
</case-options>
<formatting-settings enabled="false">
<option name="STATEMENT_SPACING" value="one_line" />
<option name="CLAUSE_CHOP_DOWN" value="chop_down_if_statement_long" />
<option name="ITERATION_ELEMENTS_WRAPPING" value="chop_down_if_not_single" />
</formatting-settings>
</DBN-SQL>
<PHPCodeStyleSettings>
<option name="ALIGN_KEY_VALUE_PAIRS" value="true" />
<option name="ALIGN_PHPDOC_PARAM_NAMES" value="true" />
Expand All @@ -11,13 +35,36 @@
<option name="LOWER_CASE_BOOLEAN_CONST" value="true" />
<option name="LOWER_CASE_NULL_CONST" value="true" />
<option name="ELSE_IF_STYLE" value="COMBINE" />
<option name="FIELDS_DEFAULT_VISIBILITY" value="protected" />
<option name="VARIABLE_NAMING_STYLE" value="CAMEL_CASE" />
<option name="BLANK_LINES_BEFORE_RETURN_STATEMENT" value="1" />
<option name="KEEP_RPAREN_AND_LBRACE_ON_ONE_LINE" value="true" />
<option name="ALIGN_CLASS_CONSTANTS" value="true" />
<option name="FORCE_SHORT_DECLARATION_ARRAY_STYLE" value="true" />
</PHPCodeStyleSettings>
<DBN-PSQL>
<case-options enabled="false">
<option name="KEYWORD_CASE" value="lower" />
<option name="FUNCTION_CASE" value="lower" />
<option name="PARAMETER_CASE" value="lower" />
<option name="DATATYPE_CASE" value="lower" />
<option name="OBJECT_CASE" value="preserve" />
</case-options>
<formatting-settings enabled="false" />
</DBN-PSQL>
<DBN-SQL>
<case-options enabled="false">
<option name="KEYWORD_CASE" value="lower" />
<option name="FUNCTION_CASE" value="lower" />
<option name="PARAMETER_CASE" value="lower" />
<option name="DATATYPE_CASE" value="lower" />
<option name="OBJECT_CASE" value="preserve" />
</case-options>
<formatting-settings enabled="false">
<option name="STATEMENT_SPACING" value="one_line" />
<option name="CLAUSE_CHOP_DOWN" value="chop_down_if_statement_long" />
<option name="ITERATION_ELEMENTS_WRAPPING" value="chop_down_if_not_single" />
</formatting-settings>
</DBN-SQL>
<codeStyleSettings language="PHP">
<option name="BLANK_LINES_AFTER_PACKAGE" value="1" />
<option name="ALIGN_MULTILINE_CHAINED_METHODS" value="true" />
Expand Down Expand Up @@ -48,5 +95,184 @@
<option name="WHILE_BRACE_FORCE" value="3" />
<option name="FOR_BRACE_FORCE" value="3" />
<option name="WRAP_ON_TYPING" value="0" />
<arrangement>
<groups />
<rules>
<section>
<rule>
<match>
<CONST>true</CONST>
</match>
</rule>
</section>
<section>
<rule>
<match>
<AND>
<FIELD>true</FIELD>
<PUBLIC>true</PUBLIC>
</AND>
</match>
</rule>
</section>
<section>
<rule>
<match>
<AND>
<FIELD>true</FIELD>
<PROTECTED>true</PROTECTED>
</AND>
</match>
</rule>
</section>
<section>
<rule>
<match>
<AND>
<FIELD>true</FIELD>
<PRIVATE>true</PRIVATE>
</AND>
</match>
</rule>
</section>
<section>
<rule>
<match>
<CONSTRUCTOR>true</CONSTRUCTOR>
</match>
</rule>
</section>
<section start_comment="//PHP Unit helper methods" end_comment="//PHP Unit helper methods end">
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<NAME>setupAfterContainer</NAME>
<PUBLIC>true</PUBLIC>
</AND>
</match>
</rule>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<NAME>setUpBeforeClass</NAME>
<PUBLIC>true</PUBLIC>
<STATIC>true</STATIC>
</AND>
</match>
</rule>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<NAME>setUp</NAME>
<PUBLIC>true</PUBLIC>
</AND>
</match>
</rule>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<NAME>tearDown</NAME>
<PUBLIC>true</PUBLIC>
</AND>
</match>
</rule>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<NAME>tearDownAfterClass</NAME>
<PUBLIC>true</PUBLIC>
<STATIC>true</STATIC>
</AND>
</match>
</rule>
</section>
<section start_comment="//PHP Unit Tests" end_comment="//PHP Unit Tests end">
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<NAME>itThrows.*</NAME>
<PUBLIC>true</PUBLIC>
</AND>
</match>
</rule>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<NAME>itCan.*</NAME>
<PUBLIC>true</PUBLIC>
</AND>
</match>
<order>BY_NAME</order>
</rule>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<NAME>itWill.*</NAME>
<PUBLIC>true</PUBLIC>
</AND>
</match>
</rule>
</section>
<section>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<PUBLIC>true</PUBLIC>
</AND>
</match>
</rule>
</section>
<section>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<PROTECTED>true</PROTECTED>
</AND>
</match>
</rule>
</section>
<section>
<rule>
<match>
<AND>
<METHOD>true</METHOD>
<PRIVATE>true</PRIVATE>
</AND>
</match>
</rule>
</section>
<section>
<rule>
<match>
<TRAIT>true</TRAIT>
</match>
</rule>
</section>
<section>
<rule>
<match>
<INTERFACE>true</INTERFACE>
</match>
</rule>
</section>
<section>
<rule>
<match>
<CLASS>true</CLASS>
</match>
</rule>
</section>
</rules>
</arrangement>
</codeStyleSettings>
</code_scheme>
11 changes: 8 additions & 3 deletions phpstorm/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# PHPQA Coding Standard PHPStorm Configs

In this folder you have 2 files that both acheive the same things
In this folder you have 2 files that both acheive the same things, and one that does something different

First is a settings export that just contains code style. We might extend this with other relevant settings
## Code Styles

The second is just the code style edit itself.
The first [jar file](./settings-code-style.jar) is a settings export that just contains code style.
The [XML file](./PHPQA_Code_Style_Scheme.xml) is just the code style edit itself.

## Template Settings

The second [jar file](./fileTemplates.jar) is a templates export file. It will set sane defaults for PHP and Bash files


## Importing Settings
Expand Down
Binary file added phpstorm/fileTemplates.jar
Binary file not shown.