Merge pull request #12850 from nupplaphil/feat/phpstorm_editorconfig

Adapt .editorconfig for PHPStorm
2023-02-27 15:05:00 -05:00 · 2023-02-27 15:05:00 -05:00 · 1d6f5c33a1
parent 61deaec4be ea550f6b02
commit 1d6f5c33a1
7 changed files with 82 additions and 21 deletions
--- a/.codecov.yml
+++ b/.codecov.yml
@ -1,7 +1,7 @@
 codecov:
  branch: develop
  ci:
-    - drone.friendi.ca
+    - ci.friendi.ca

 coverage:
  precision: 2
--- a/.editorconfig
+++ b/.editorconfig
@ -6,9 +6,27 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-trim_trailing_whitespaces = true
 indent_style = tab
+trim_trailing_whitespace = true
+insert_final_newline = true
 quote_type = single
+max_line_length = off

 [*.js]
-quote_type = double
+quote_type = double
+ij_javascript_use_double_quotes = true
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.xml]
+indent_style = space
+indent_size = 2
+
+[*.json]
+indent_style = space
+indent_size = 2
+
+[composer.json]
+indent_style = tab
--- a/composer.json
+++ b/composer.json
@ -132,7 +132,13 @@
 		"test": "phpunit",
 		"lint": "find . -name \\*.php -not -path './vendor/*' -not -path './view/asset/*' -print0 | xargs -0 -n1 php -l",
 		"cs:install": "@composer install --working-dir=bin/dev/php-cs-fixer",
-		"cs:check": ["@cs:install", "bin/dev/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff"],
-		"cs:fix": ["@cs:install", "bin/dev/php-cs-fixer/vendor/bin/php-cs-fixer fix"]
+		"cs:check": [
+			"@cs:install",
+			"bin/dev/php-cs-fixer/vendor/bin/php-cs-fixer fix --dry-run --diff"
+		],
+		"cs:fix": [
+			"@cs:install",
+			"bin/dev/php-cs-fixer/vendor/bin/php-cs-fixer fix"
+		]
 	}
 }
--- a/docblox.dist.xml
+++ b/docblox.dist.xml
@ -10,4 +10,3 @@
    <directory>.</directory>
  </files>
 </docblox>
-
--- a/mods/README.md
+++ b/mods/README.md
@ -4,12 +4,12 @@ Friendica mods files
 ## `bookmarklet-share2friendica`

 Browser bookmarklet to share any page with your Friendica account.
-Please see `bookmarklet-share2friendica/README.md` for detailed instruction. 
+Please see `bookmarklet-share2friendica/README.md` for detailed instruction.

 ## `fpostit`

 Node-agnostic Friendica bookmarklet by Devlon Duthie.
-Unmaintained and unsupported. 
+Unmaintained and unsupported.

 ## `home.css` and `home.html`

@ -30,7 +30,11 @@ Please check software documentation to know how modify these examples to make th
 ## `sample-systemd.timer` and `sample-systemd.service`

 Sample systemd unit files to start worker.php periodically.
-		
+
 Please place them in the correct location for your system, typically this is `/etc/systemd/system/friendicaworker.timer` and `/etc/systemd/system/friendicaworker.service`.
 Please report problems and improvements to `!helpers@forum.friendi.ca` and `@utzer@social.yl.ms` or open an issue in [the Github Friendica page](https://github.com/friendica/friendica/issues).
 This is for usage of systemd instead of cron to start the worker periodically, the solution is a work-in-progress and can surely be improved.
+
+## `phpstorm-code-style.xml`
+
+PHP Storm Code Style settings, used for this codebase
--- a/mods/phpstorm-code-style.xml
+++ b/mods/phpstorm-code-style.xml
@ -0,0 +1,34 @@
+<code_scheme name="Default" version="173">
+  <Markdown>
+    <option name="WRAP_TEXT_IF_LONG" value="false" />
+    <option name="WRAP_TEXT_INSIDE_BLOCKQUOTES" value="false" />
+  </Markdown>
+  <PHPCodeStyleSettings>
+    <option name="ALIGN_KEY_VALUE_PAIRS" value="true" />
+    <option name="ALIGN_PHPDOC_PARAM_NAMES" value="true" />
+    <option name="ALIGN_PHPDOC_COMMENTS" value="true" />
+    <option name="ALIGN_ASSIGNMENTS" value="true" />
+    <option name="COMMA_AFTER_LAST_ARRAY_ELEMENT" value="true" />
+    <option name="PHPDOC_BLANK_LINE_BEFORE_TAGS" value="true" />
+    <option name="PHPDOC_BLANK_LINES_AROUND_PARAMETERS" value="true" />
+    <option name="PHPDOC_WRAP_LONG_LINES" value="true" />
+    <option name="LOWER_CASE_BOOLEAN_CONST" value="true" />
+    <option name="LOWER_CASE_NULL_CONST" value="true" />
+    <option name="ELSE_IF_STYLE" value="SEPARATE" />
+    <option name="VARIABLE_NAMING_STYLE" value="CAMEL_CASE" />
+    <option name="ALIGN_CLASS_CONSTANTS" value="true" />
+    <option name="FORCE_SHORT_DECLARATION_ARRAY_STYLE" value="true" />
+  </PHPCodeStyleSettings>
+  <codeStyleSettings language="PHP">
+    <option name="KEEP_FIRST_COLUMN_COMMENT" value="false" />
+    <option name="ALIGN_MULTILINE_CHAINED_METHODS" value="true" />
+    <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
+    <option name="ALIGN_MULTILINE_BINARY_OPERATION" value="true" />
+    <option name="ALIGN_MULTILINE_ARRAY_INITIALIZER_EXPRESSION" value="true" />
+    <option name="METHOD_CALL_CHAIN_WRAP" value="1" />
+    <option name="ARRAY_INITIALIZER_WRAP" value="1" />
+    <indentOptions>
+      <option name="USE_TAB_CHARACTER" value="true" />
+    </indentOptions>
+  </codeStyleSettings>
+</code_scheme>
--- a/ruleset.xml
+++ b/ruleset.xml
@ -1,15 +1,15 @@
 <?xml version="1.0"?>
 <ruleset name="Friendica">
-    <description>Friendica Coding Standards: PSR2 with tabs instead of spaces</description>
-    <arg name="tab-width" value="4"/>
-    <rule ref="PSR2">
-        <exclude name="Generic.WhiteSpace.DisallowTabIndent"/>
-    </rule>
-    <rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/>
-    <rule ref="Generic.WhiteSpace.ScopeIndent">
-        <properties>
-            <property name="indent" value="4"/>
-            <property name="tabIndent" value="true"/>
-        </properties>
-    </rule>
+  <description>Friendica Coding Standards: PSR2 with tabs instead of spaces</description>
+  <arg name="tab-width" value="4"/>
+  <rule ref="PSR2">
+    <exclude name="Generic.WhiteSpace.DisallowTabIndent"/>
+  </rule>
+  <rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/>
+  <rule ref="Generic.WhiteSpace.ScopeIndent">
+    <properties>
+      <property name="indent" value="4"/>
+      <property name="tabIndent" value="true"/>
+    </properties>
+  </rule>
 </ruleset>