Merge pull request #3 from red-explosion/feature/update-config

Update config and README
red-explosion · Mar 15, 2024 · fe605ae · fe605ae
2 parents e0586c3 + 6560383
commit fe605ae
Show file tree

Hide file tree

Showing 4 changed files with 285 additions and 16 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,60 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that
+developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the
+project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do
+not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open source projects
+are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature
+is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PER Coding Standard](https://github.com/php-fig/per-coding-style/blob/2.0.0/spec.md)** - The easiest way to apply these conventions is to use the `composer lint` command.
+
+- **Add tests!** - This helps to ensure the codebase is easily maintable.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept
+  up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an
+  option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make
+  multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages)
+  before submitting.
+
+**Happy coding**!
diff --git a/README.md b/README.md
@@ -1,27 +1,31 @@
-# Red Explosion's config for Laravel Pint
+<p align="center"><img width="400" src="./art/logo.svg" alt="Red Explosion Logo"></p>
+
+# Laravel Pint Config
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/red-explosion/pint-config.svg?style=flat-square)](https://packagist.org/packages/red-explosion/pint-config)
 [![Total Downloads](https://img.shields.io/packagist/dt/red-explosion/pint-config.svg?style=flat-square)](https://packagist.org/packages/red-explosion/pint-config)
 
-A shareable config for Laravel Pint, an opinionated PHP code style fixer for minimalists.
+This repository contains a shareable config for Laravel Pint, an opinionated PHP code style fixer for minimalists.
 
 ## Installation
 
-You can install the package via composer:
+To get started, install package_name via the Composer package manager:
 
 ```bash
 composer require red-explosion/pint-config
 ```
 
 ## Usage
 
+To use the Red Explosion Laravel Pint config, you can use the `--config` option:
+
 ```php
 ./vendor/bin/pint --config vendor/red-explosion/pint-config/pint.json
 ```
 
-### Changelog
+## Changelog
 
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
 ## Contributing
 
@@ -34,4 +38,4 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+Our Laravel Pint config is open-sourced software licensed under the [MIT license](LICENSE.md).
diff --git a/art/logo.svg b/art/logo.svg
diff --git a/pint.json b/pint.json
@@ -1,34 +1,228 @@
 {
-    "preset": "per",
     "rules": {
         "align_multiline_comment": true,
         "array_indentation": true,
-        "array_syntax": true,
-        "combine_consecutive_issets": true,
-        "combine_consecutive_unsets": true,
+        "array_syntax": {
+            "syntax": "short"
+        },
+        "binary_operator_spaces": {
+            "default": "single_space"
+        },
+        "blank_line_after_namespace": true,
+        "blank_line_after_opening_tag": true,
+        "blank_line_before_statement": {
+            "statements": ["continue", "return"]
+        },
+        "blank_line_between_import_groups": true,
+        "blank_lines_before_namespace": true,
+        "braces_position": {
+            "control_structures_opening_brace": "same_line",
+            "functions_opening_brace": "next_line_unless_newline_at_signature_end",
+            "anonymous_functions_opening_brace": "same_line",
+            "classes_opening_brace": "next_line_unless_newline_at_signature_end",
+            "anonymous_classes_opening_brace": "next_line_unless_newline_at_signature_end",
+            "allow_single_line_empty_anonymous_classes": false,
+            "allow_single_line_anonymous_functions": false
+        },
+        "cast_spaces": true,
+        "class_attributes_separation": {
+            "elements": {
+                "const": "one",
+                "method": "one",
+                "property": "one",
+                "trait_import": "none"
+            }
+        },
+        "class_definition": {
+            "multi_line_extends_each_single_line": true,
+            "single_item_single_line": true,
+            "single_line": true
+        },
+        "clean_namespace": true,
+        "compact_nullable_type_declaration": true,
+        "concat_space": {
+            "spacing": "one"
+        },
+        "constant_case": {
+            "case": "lower"
+        },
+        "control_structure_braces": true,
+        "control_structure_continuation_position": {
+            "position": "same_line"
+        },
+        "declare_equal_normalize": true,
         "declare_parentheses": true,
         "declare_strict_types": true,
+        "elseif": true,
+        "encoding": true,
         "explicit_string_variable": true,
+        "full_opening_tag": true,
         "fully_qualified_strict_types": true,
-        "global_namespace_import": {
-            "import_classes": true,
-            "import_constants": true,
-            "import_functions": true
+        "function_declaration": true,
+        "general_phpdoc_tag_rename": true,
+        "heredoc_to_nowdoc": true,
+        "include": true,
+        "increment_style": {
+            "style": "post"
         },
-        "is_null": true,
+        "indentation_type": true,
+        "integer_literal_case": true,
         "lambda_not_used_import": true,
+        "line_ending": true,
+        "linebreak_after_opening_tag": true,
+        "list_syntax": true,
         "logical_operators": true,
-        "mb_str_functions": true,
+        "lowercase_cast": true,
+        "lowercase_keywords": true,
+        "lowercase_static_reference": true,
+        "magic_constant_casing": true,
+        "magic_method_casing": true,
+        "method_argument_space": {
+            "on_multiline": "ignore"
+        },
         "method_chaining_indentation": true,
         "modernize_strpos": true,
+        "multiline_whitespace_before_semicolons": {
+            "strategy": "no_multi_line"
+        },
+        "native_function_casing": true,
+        "native_type_declaration_casing": true,
+        "no_alias_functions": true,
+        "no_alias_language_construct_call": true,
+        "no_alternative_syntax": true,
+        "no_binary_string": true,
+        "no_blank_lines_after_class_opening": true,
+        "no_blank_lines_after_phpdoc": true,
+        "no_closing_tag": true,
         "no_empty_comment": true,
+        "no_empty_phpdoc": true,
+        "no_empty_statement": true,
+        "no_extra_blank_lines": {
+            "tokens": [
+                "extra",
+                "throw",
+                "use"
+            ]
+        },
+        "no_leading_import_slash": true,
+        "no_leading_namespace_whitespace": true,
+        "no_mixed_echo_print": {
+            "use": "echo"
+        },
+        "no_multiline_whitespace_around_double_arrow": true,
+        "no_multiple_statements_per_line": true,
+        "no_short_bool_cast": true,
+        "no_singleline_whitespace_before_semicolons": true,
+        "no_space_around_double_colon": true,
+        "no_spaces_after_function_name": true,
+        "no_spaces_around_offset": {
+            "positions": ["inside", "outside"]
+        },
+        "no_superfluous_phpdoc_tags": {
+            "allow_mixed": true,
+            "allow_unused_params": true
+        },
+        "no_trailing_comma_in_singleline": true,
+        "no_trailing_whitespace": true,
+        "no_trailing_whitespace_in_comment": true,
+        "no_unneeded_control_parentheses": {
+            "statements": ["break", "clone", "continue", "echo_print", "return", "switch_case", "yield"]
+        },
+        "no_unneeded_braces": true,
+        "no_unreachable_default_argument_value": true,
+        "no_unset_cast": true,
+        "no_unused_imports": true,
+        "no_useless_return": true,
+        "no_whitespace_before_comma_in_array": true,
+        "no_whitespace_in_blank_line": true,
+        "normalize_index_brace": true,
+        "not_operator_with_successor_space": true,
+        "nullable_type_declaration": true,
+        "nullable_type_declaration_for_default_null_value": true,
+        "object_operator_without_whitespace": true,
+        "ordered_imports": {
+            "sort_algorithm": "alpha",
+            "imports_order": ["const", "class", "function"]
+        },
+        "ordered_interfaces": true,
         "ordered_traits": true,
+        "phpdoc_align": {
+            "align": "left",
+            "spacing": {
+                "param": 2
+            }
+        },
+        "phpdoc_indent": true,
+        "phpdoc_inline_tag_normalizer": true,
+        "phpdoc_no_access": true,
+        "phpdoc_no_package": true,
+        "phpdoc_no_useless_inheritdoc": true,
+        "phpdoc_order": {
+            "order": ["param", "return", "throws"]
+        },
+        "phpdoc_scalar": true,
+        "phpdoc_separation": {
+            "groups": [
+                ["deprecated", "link", "see", "since"],
+                ["author", "copyright", "license"],
+                ["category", "package", "subpackage"],
+                ["property", "property-read", "property-write"],
+                ["param", "return"]
+            ]
+        },
+        "phpdoc_single_line_var_spacing": true,
+        "phpdoc_summary": false,
+        "phpdoc_tag_type": {
+            "tags": {
+                "inheritdoc": "inline"
+            }
+        },
+        "phpdoc_to_comment": false,
+        "phpdoc_trim": true,
+        "phpdoc_types": true,
+        "phpdoc_var_without_name": true,
+        "psr_autoloading": false,
+        "return_type_declaration": {
+            "space_before": "none"
+        },
+        "self_accessor": false,
+        "self_static_accessor": true,
+        "short_scalar_cast": true,
+        "simplified_null_return": false,
         "simplified_if_return": true,
+        "single_blank_line_at_eof": true,
+        "single_class_element_per_statement": {
+            "elements": ["const", "property"]
+        },
+        "single_import_per_statement": true,
+        "single_line_after_imports": true,
+        "single_line_comment_style": {
+            "comment_types": ["hash"]
+        },
+        "single_quote": true,
+        "single_space_around_construct": true,
+        "space_after_semicolon": true,
+        "spaces_inside_parentheses": true,
+        "standardize_not_equals": true,
+        "statement_indentation": true,
         "strict_comparison": true,
+        "switch_case_semicolon_to_colon": true,
+        "switch_case_space": true,
+        "ternary_operator_spaces": true,
         "ternary_to_null_coalescing": true,
+        "trailing_comma_in_multiline": {
+            "elements": ["arrays"]
+        },
         "trim_array_spaces": true,
+        "type_declaration_spaces": true,
+        "types_spaces": true,
+        "unary_operator_spaces": true,
         "use_arrow_functions": true,
+        "visibility_required": {
+            "elements": ["method", "property"]
+        },
         "void_return": true,
+        "whitespace_after_comma_in_array": true,
         "yoda_style": {
             "always_move_variable": false,
             "equal": false,