Merge branch '4.x' of https://github.com/filips123/PHP_CodeSniffer_New into short-type-hints

Author: filips123

.cspell.json

@@ -3,8 +3,8 @@
     "dictionaries": ["php"],
     "allowCompoundWords": true,
     "ignorePaths": [
-        "src/Standards/*/Tests/*/*.{inc,js,css}",
-        "src/Standards/*/Tests/*/*.{inc,js,css}.fixed"
+        "src/Standards/*/Tests/*/*.inc",
+        "src/Standards/*/Tests/*/*.inc.fixed"
     ],
     "ignoreRegExpList": ["email", "^\\s+\\*\\s+@(author|copyright)\\s+.*$"],
     "words": [
@@ -28,9 +28,7 @@
         "dnumber",
         "docblock",
         "encapsed",
-        "gjslint",
         "groupid",
-        "gsjlint",
         "hashbang",
         "heredoc",
         "hgblame",
@@ -43,6 +41,7 @@
         "mins",
         "nekudotayim",
         "nowdoc",
+        "numeronym",
         "paamayim",
         "pcre",
         "php's",

.gitattributes

@@ -1,9 +1,38 @@
-.travis.yml export-ignore
-package.xml export-ignore
-phpunit.xml.dist export-ignore
-php5-testingConfig.ini export-ignore
-php7-testingConfig.ini export-ignore
+#
+# Exclude these files from release archives.
+# This will also make them unavailable when using Composer with `--prefer-dist`.
+# If you develop for this repo using Composer, use `--prefer-source`.
+# https://www.reddit.com/r/PHP/comments/2jzp6k/i_dont_need_your_tests_in_my_production/
+# https://blog.madewithlove.be/post/gitattributes/
+#
+.github/                              export-ignore
+scripts/                              export-ignore
+src/Standards/**/Tests/               export-ignore
+tests/Core/**/                        export-ignore
+tests/EndToEndBash/**/                export-ignore
+.cspell.json                          export-ignore
+.gitattributes                        export-ignore
+.gitignore                            export-ignore
+.markdownlint-cli2.yaml               export-ignore
+.remarkignore                         export-ignore
+.remarkrc                             export-ignore
+.shellcheckrc                         export-ignore
+.yamllint.yml                         export-ignore
+CHANGELOG-0.x.md                      export-ignore
+CHANGELOG-1.x.md                      export-ignore
+CHANGELOG-2.x.md                      export-ignore
+phpcs.xml.dist                        export-ignore
+phpstan.neon.dist                     export-ignore
+phpunit.xml.dist                      export-ignore
+phpunit-lte9.xml.dist                 export-ignore
+tests/Core/AbstractWriterTestCase.php export-ignore
+tests/Core/ErrorSuppressionTest.php   export-ignore
+tests/Core/StatusWriterTestHelper.php export-ignore
 
+#
 # Declare files that should always have CRLF line endings on checkout.
+#
 *WinTest.inc text eol=crlf
 *WinTest.php text eol=crlf
+src/Standards/Generic/Tests/Files/LineEndingsUnitTest*.inc text eol=crlf
+tests/Core/Fixer/Fixtures/GenerateDiffTest-WindowsLineEndings.inc text eol=crlf

.github/CONTRIBUTING.md

@@ -2,44 +2,70 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: ''
+labels: ['Status: triage', 'Type: bug']
 assignees: ''
 
 ---
 
-**Describe the bug**
+<!--
+Before reporting a sniff related bug, please check the error code using `phpcs -s`.
+
+If the error code starts with anything other than `Generic`, `PEAR`, `PSR1`,
+`PSR2`, `PSR12`, `Squiz` or `Zend`, the error is likely coming from an
+PHP_CodeSniffer standard.
+
+Please report bugs for externally maintained sniffs to the appropriate external
+standard repository (not here).
+-->
+
+## Describe the bug
+
 A clear and concise description of what the bug is.
 
-**Code sample**
+### Code sample
 ```php
-echo "A short code snippet that can be used to reproduce the bug";
+echo 'A short code snippet that can be used to reproduce the bug.';
+echo 'Do NOT paste screenshots of code!";
 ```
 
-**Custom ruleset**
+### Custom ruleset
 ```xml
 <?xml version="1.0"?>
 <ruleset name="My Custom Standard">
-  <description>If you are using a custom ruleset, please enter it here.</description>
+  <description>If you are using a custom ruleset, please enter the relevant part here.</description>
 </ruleset>
 ```
 
-**To reproduce**
+### To reproduce
 Steps to reproduce the behavior:
 1. Create a file called `test.php` with the code sample above...
 2. Run `phpcs test.php ...`
 3. See error message displayed
-```
+```text
 PHPCS output here
 ```
 
-**Expected behavior**
+## Expected behavior
+
 A clear and concise description of what you expected to happen.
 
-**Versions (please complete the following information):**
- - OS: [e.g., Windows 10, MacOS 10.15]
- - PHP: [e.g., 7.2, 7.4]
- - PHPCS: [e.g., 3.5.5, master]
- - Standard: [e.g., PSR2, PSR12, Squiz]
+## Versions (please complete the following information)
+
+|                                          |                                                                                                                |
+|-----------------------------|---------------------------------------------------------------------------- |
+| Operating System            | (e.g., Windows 10, MacOS 10.15)                                                           |
+| PHP version                      | (e.g., 7.2, 8.1)                                                                                          |
+| PHP_CodeSniffer version | (e.g., 3.13.4, 4.x)                                                                                  |
+| Standard                          | (e.g., PSR2, PSR12, Squiz, custom)                                                          |
+| Install type                       | (e.g. Composer (global/local), PHAR, git clone, other (please expand)) |
+
+## Additional context
 
-**Additional context**
 Add any other context about the problem here.
+
+## Please confirm
+
+- [ ] I have searched the issue list and am not opening a duplicate issue.
+- [ ] I have read the [Contribution Guidelines](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/.github/CONTRIBUTING.md) and this is not a [support question](https://github.com/PHPCSStandards/PHP_CodeSniffer/discussions).
+- [ ] I confirm that this bug is a bug in PHP_CodeSniffer and not in one of the external standards.
+- [ ] I have verified the issue still exists in the `4.x` branch of PHP_CodeSniffer.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Community Support
+    url: https://github.com/PHPCSStandards/PHP_CodeSniffer/discussions?discussions_q=-category%3AAnnouncements
+    about: Support questions belong in Discussions, not in the issue tracker.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: I have a suggestion (and may want to implement it).
+title: ''
+labels: ['Status: triage', 'Type: enhancement']
+assignees: ''
+
+---
+
+## Is your feature request related to a problem?
+<!-- Please provide a clear and concise description of what the feature is which you'd like to see implemented. -->
+
+## Describe the solution you'd like
+<!--
+A clear and concise description of what you want to happen.
+
+Please include some code samples of what should be flagged and preferably also some
+code samples of what should *not* be flagged.
+-->
+
+## Additional context (optional)
+<!-- Add any other context or screenshots about the feature request here. -->
+
+- [ ] I have read the [Contribution Guidelines](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/.github/CONTRIBUTING.md) and this is not a [support question](https://github.com/PHPCSStandards/PHP_CodeSniffer/discussions).
+- [ ] I intend to create a pull request to implement this feature.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,33 @@
+# Checklists for branch management of majors
+
+Note: these lists may be incomplete and should be regarded as a starting point to be updated/enhanced each time new insights present themselves.
+
+
+## Stop support for old major
+
+- [ ] Remove "old major" from workflows in the **oldest major still supported**.
+    I.e. when support for 3.x will be stopped, `3.x` should be removed from the workflows in the `4.x` branch (not from the 3.x branch).
+- [ ] Update target branch in the `.github/dependabot.yml` file in the **oldest major still supported** to be that oldest major.
+- [ ] Update target branch (`BASE`) in the `.github/workflows/happy-new-year.yml` file in the **oldest major still supported** to be that oldest major.
+
+
+## Start branch for next major
+
+- [ ] Add "next major" to workflows in the **oldest major still supported**.
+    I.e. when a new 5.x branch will be created while 3.x still has minimal support, this change should be made in the `3.x` branch (otherwise in the 4.x branch).
+- [ ] Create x.x branch.
+
+In the new branch:
+- [ ] Change `Config::VERSION` to next major version number.
+- [ ] Change `Config::STABILITY` to `alpha`.
+- [ ] Create CHANGELOG-x.x.md file for the new major.
+- [ ] Add CHANGELOG for the _major before last_ to the `.gitattributes` `export-ignore`s.
+- [ ] Update branch references for the badges in the README.
+- [ ] Update installation instructions (`^4.0`) in the README.
+- [ ] Update branch reference/instructions in the issue and PR templates.
+- [ ] Update branch reference in the `bug_report.md` issue template.
+- [ ] Update branch reference in the `CONTRIBUTING` file ("Getting Started" section).
+    => For the previous four items, see 1433a86bd4bd3480048d485983e7f16f8e8ec981 as an example.
+- [ ] If the next major includes a PHP version drop, that should be the one of the first commits
+    Example: a7a27b9413106cf4bf10514d6ce93658899ec279
+    Also update relevant files from 19724954edc7997125040fbf84eddffca99d674f

.github/branch-management-for-majors.md

@@ -0,0 +1,16 @@
+# PHP_CodeSniffer Community CC List
+
+<!--
+This list will be used on select tickets to ping the wider PHP_CodeSniffer community for input.
+
+If you want to be on this list, feel free to submit a PR to add yourself.
+If you want to be removed from the list, dito, submit a PR to remove yourself and it will be merged without questions.
+
+PRs adding/removing other people to/from the list will only be merged if the people being added/removed leave a comment on the PR consenting to it.
+
+When updating the list, please list GitHub handles in alphabetical order.
+
+For more context, see https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/227
+-->
+
+/cc @asispts @dingo-d @fredden @GaryJones @greg0ire @kukulich @michalbundyra @Ocramius @sirbrillig @stronk7 @weierophinney @wimg

.github/community-cc-list.md

@@ -0,0 +1,44 @@
+# Dependabot configuration.
+#
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  # Handle updates for the default branch.
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "cron"
+      cronjob: "10 22 5,20 * *" # At 22:10, every 5th and 20th day of the month.
+    target-branch: "3.x"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "GH Actions:"
+    labels:
+      - "Type: chores/QA"
+    groups:
+      action-runners:
+        applies-to: version-updates
+        update-types:
+          - "minor"
+          - "patch"
+
+  # Handle updates for the orphan gh-pages branch.
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "cron"
+      cronjob: "10 22 5,20 * *" # At 22:10, every 5th and 20th day of the month.
+    target-branch: "gh-pages"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "GH Pages/Actions:"
+    labels:
+      - "Type: chores/QA"
+    groups:
+      action-runners:
+        applies-to: version-updates
+        update-types:
+          - "minor"
+          - "patch"

.github/dependabot.yml

@@ -0,0 +1,97 @@
+version: 1
+appendOnly: true
+labels:
+  - label: "Status: triage"
+    draft: false
+    author-can-merge: false
+
+  - label: "Core Component: Config & CLI options"
+    draft: false
+    files:
+      - "src/Config.php$"
+  - label: "Core Component: Ruleset"
+    draft: false
+    files:
+      - "src/Ruleset.php$"
+  - label: "Core Component: File"
+    draft: false
+    files:
+      - "src/Files/.*"
+  - label: "Core Component: Fixer"
+    draft: false
+    files:
+      - "src/Fixer.php$"
+  - label: "Core Component: Generators"
+    draft: false
+    files:
+      - "src/Generators/.*"
+  - label: "Core Component: Reports"
+    draft: false
+    files:
+      - "src/Reports/.*"
+  - label: "Core Component: Tokenizer"
+    draft: false
+    files:
+      - "src/Tokenizers/.*"
+  - label: "Core Component: Utils"
+    draft: false
+    files:
+      - "src/Util/.*"
+
+  - label: "Focus: Comments/Docblocks"
+    draft: false
+    files:
+      - "src/Standards/.*/Sniffs/Commenting/"
+  - label: "Focus: Fixer Conflicts"
+    draft: false
+    body: ".* fixer conflict.*"
+
+  - label: "Standard: Generic"
+    draft: false
+    files:
+      - "src/Standards/Generic/(Docs|Sniffs)/.*"
+  - label: "Standard: PEAR"
+    draft: false
+    files:
+      - "src/Standards/PEAR/(Docs|Sniffs)/.*"
+  - label: "Standard: PSR1"
+    draft: false
+    files:
+      - "src/Standards/PSR1/(Docs|Sniffs)/.*"
+  - label: "Standard: PSR2"
+    draft: false
+    files:
+      - "src/Standards/PSR2/(Docs|Sniffs)/.*"
+  - label: "Standard: PSR12"
+    draft: false
+    files:
+      - "src/Standards/PSR12/(Docs|Sniffs)/.*"
+  - label: "Standard: Squiz"
+    draft: false
+    files:
+      - "src/Standards/Squiz/(Docs|Sniffs)/.*"
+  - label: "Standard: Zend"
+    draft: false
+    files:
+      - "src/Standards/Zend/(Docs|Sniffs)/.*"
+
+  - label: "Type: breaking change"
+    draft: false
+    body: '[Xx]\] Breaking change'
+  - label: "Type: bug"
+    draft: false
+    body: '[Xx]\] Bug fix'
+  - label: "Type: enhancement"
+    draft: false
+    body: '[Xx]\] New feature'
+  - label: "Type: documentation"
+    draft: false
+    body: '[Xx]\] Documentation improvement'
+  - label: "Type: documentation"
+    draft: false
+    files:
+      - 'src/Standards/.*/Docs/[A-Za-z0-9-]*/.*Standard.xml$'
+  - label: "Type: documentation"
+    draft: false
+    files:
+      - "*.md$"