Merge pull request #358 from PHPCSStandards/develop

Release PHPCSExtra 1.3.1

Author: jrfnl

.gitattributes

@@ -8,6 +8,7 @@
 .coveralls.yml           export-ignore
 .gitattributes           export-ignore
 .gitignore               export-ignore
+.markdownlint-cli2.yaml  export-ignore
 .remarkignore            export-ignore
 .remarkrc                export-ignore
 .yamllint.yml            export-ignore

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,7 @@
 ---
 name: "\U0001F41B Bug report for sniffs"
 about: I got unexpected behavior and think it is a bug.
+title: ''
 
 ---
 
@@ -73,4 +74,5 @@ You should be able to get the version numbers using the `composer info` command.
 
 
 ## Tested Against `develop` branch?
+
 - [ ] I have verified the issue still exists in the `develop` branch of PHPCSExtra.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,8 @@
 ---
 name: "\U0001F680 Feature request"
 about: I have a suggestion (and may want to implement it).
+title: ''
+
 ---
 
 ## Is your feature request related to a problem?

.github/release-checklist.md

@@ -7,6 +7,8 @@ PR for tracking changes for the x.x.x release. Target release date: **DOW MONTH
 ### General
 
 - [ ] Verify, and if necessary, update the allowed version ranges for various dependencies in the `composer.json` - PR #xxx
+- [ ] Go through changelog PHPCS looking for updates to the Tokenizer.
+    Review if there are sniffs which need updating in relation to the Tokenizer changes (support for new PHP syntaxes, bugs fixed etc).
 - [ ] Add changelog for the release - PR #xxx
     :pencil2: Remember to add a release link at the bottom!
 - [ ] Update sniff list in `README` (if applicable) - PR #xxx.
@@ -24,5 +26,6 @@ PR for tracking changes for the x.x.x release. Target release date: **DOW MONTH
 - [ ] Fast-forward `develop` to be equal to `stable`
 
 ### Publicize
+
 - [ ] Toot about the release.
 - [ ] Tweet about the release.

.github/workflows/basics.yml

@@ -136,6 +136,10 @@ jobs:
     with:
       phpstanVersion: '2.x'
 
+  markdownlint:
+    name: 'Lint Markdown'
+    uses: PHPCSStandards/.github/.github/workflows/reusable-markdownlint.yml@main
+
   remark:
     name: 'QA Markdown'
     uses: PHPCSStandards/.github/.github/workflows/reusable-remark.yml@main

.github/workflows/label-merge-conflicts.yml

@@ -0,0 +1,28 @@
+name: Check PRs for merge conflicts
+
+on:
+  # Check for new conflicts due to merges.
+  push:
+    branches:
+      - stable
+      - develop
+  # Check conflicts in new PRs and for resolved conflicts due to an open PR being updated.
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+jobs:
+  check-prs:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'PHPCSStandards'
+
+    name: Check PRs for merge conflicts
+
+    steps:
+      - name: Check PRs for merge conflicts
+        uses: eps1lon/actions-label-merge-conflict@v3
+        with:
+          dirtyLabel: "Status: has merge conflict"
+          repoToken: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -19,6 +19,41 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  lint:
+    if: ${{ github.ref != 'refs/heads/develop' }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php: ['5.4', '7.0', '7.4', '8.0', '8.4', '8.5']
+
+    name: "Lint: PHP ${{ matrix.php }}"
+
+    continue-on-error: ${{ matrix.php == '8.5' }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          ini-file: 'development'
+          coverage: none
+          tools: cs2pr
+
+      - name: Install Composer dependencies
+        uses: "ramsey/composer-install@v3"
+        with:
+          # For the PHP "nightly", we need to install with ignore platform reqs as not all dependencies may allow it yet.
+          composer-options: ${{ matrix.php == '8.5' && '--ignore-platform-req=php+' || '' }}
+          # Bust the cache at least once a month - output format: YYYY-MM.
+          custom-cache-suffix: $(date -u "+%Y-%m")
+
+      - name: "Lint against parse errors"
+        run: composer lint -- --checkstyle | cs2pr
+
   #### TEST STAGE ####
   test:
     if: ${{ github.ref != 'refs/heads/develop' }}
@@ -35,7 +70,7 @@ jobs:
         php: ['5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.5']
         phpcs_version: ['lowest', 'dev-master']
 
-    name: "Test${{ matrix.phpcs_version == 'dev-master' && ' + Lint' || '' }}: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}"
+    name: "Test: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}"
 
     continue-on-error: ${{ matrix.php == '8.5' }}
 
@@ -74,6 +109,8 @@ jobs:
       - name: Install Composer dependencies
         uses: "ramsey/composer-install@v3"
         with:
+          # For the PHP "nightly", we need to install with ignore platform reqs as not all dependencies may allow it yet.
+          composer-options: ${{ matrix.php == '8.5' && '--ignore-platform-req=php+' || '' }}
           # Bust the cache at least once a month - output format: YYYY-MM.
           custom-cache-suffix: $(date -u "+%Y-%m")
 
@@ -84,10 +121,6 @@ jobs:
           squizlabs/php_codesniffer
           phpcsstandards/phpcsutils
 
-      - name: Lint against parse errors
-        if: matrix.phpcs_version == 'dev-master'
-        run: composer lint
-
       - name: Run the unit tests
         run: composer test
 
@@ -108,7 +141,7 @@ jobs:
         php: ['5.4', '8.4']
         phpcs_version: ['lowest', 'dev-master']
 
-    name: "Coverage${{ matrix.phpcs_version == 'dev-master' && ' + Lint' || '' }}: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}"
+    name: "Coverage: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}"
 
     steps:
       - name: Checkout code
@@ -131,7 +164,6 @@ jobs:
           php-version: ${{ matrix.php }}
           ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
           coverage: xdebug
-          tools: cs2pr
 
       - name: "Composer: set PHPCS version for tests (master)"
         if: ${{ matrix.phpcs_version != 'lowest' }}
@@ -156,10 +188,6 @@ jobs:
           squizlabs/php_codesniffer
           phpcsstandards/phpcsutils
 
-      - name: Lint against parse errors
-        if: matrix.phpcs_version == 'dev-master'
-        run: composer lint -- --checkstyle | cs2pr
-
       - name: Run the unit tests with code coverage
         run: composer coverage
 

.gitignore

@@ -1,4 +1,5 @@
 build/
+node_modules/
 vendor/
 /composer.lock
 /.phpcs.xml

.markdownlint-cli2.yaml

@@ -0,0 +1,114 @@
+#
+# Configuration file for MarkdownLint-CLI2.
+#
+# Example file with all options:
+# https://github.com/DavidAnson/markdownlint-cli2/blob/main/test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
+#
+
+# Do not fix any fixable errors.
+fix: false
+
+# Define glob expressions to use (only valid at root).
+globs:
+  - "**/*.md"
+  - ".github/**/*.md"
+
+# Show found files on stdout (only valid at root)
+showFound: true
+
+# Define glob expressions to ignore.
+ignores:
+  - "node_modules/"
+  - "vendor/"
+
+# Disable inline config comments.
+noInlineConfig: true
+
+# Disable progress on stdout (only valid at root).
+noProgress: false
+
+# Adjust the configuration for some built-in rules.
+# For full information on the options and defaults, see:
+# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+config:
+  ######################
+  # Disable a few rules.
+  ######################
+  # MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines.
+  MD031: false
+  # MD032/blanks-around-lists - Lists should be surrounded by blank lines.
+  MD032: false
+
+  ##############################
+  # Customize a few other rules.
+  ##############################
+  # MD003/heading-style/header-style - Heading style.
+  MD003:
+    # Heading style - Always use hashes.
+    style: "atx"
+
+  # MD004/ul-style - Unordered list style.
+  MD004:
+    # List style - each level has a different, but consistent symbol.
+    style: "sublist"
+
+  # MD007/ul-indent - Unordered list indentation.
+  MD007:
+    indent: 4
+    # Whether to indent the first level of the list.
+    start_indented: false
+
+  # MD012/no-multiple-blanks - Multiple consecutive blank lines.
+  MD012:
+    maximum: 2
+
+  # MD013/line-length - Line length.
+  MD013:
+    # Number of characters. No need for being too fussy.
+    line_length: 1000
+    # Number of characters for headings.
+    heading_line_length: 100
+    # Number of characters for code blocks.
+    code_block_line_length: 100
+    # Stern length checking (applies to tables, code blocks etc which have their own max line length).
+    stern: true
+
+  # MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content.
+  MD024:
+    # Only check sibling headings.
+    siblings_only: true
+
+  # MD033/no-inline-html - Inline HTML.
+  MD033:
+    # Allowed elements.
+    allowed_elements:
+      - div
+      - details
+      - summary
+      - b
+      - code
+      - ul
+      - li
+
+  # MD044/proper-names - Proper names should have the correct capitalization.
+  MD044:
+    # List of proper names.
+    names: ["PHPCSUtils", "PHP", "PHP_CodeSniffer", "CodeSniffer", "PHPUnit"]
+    # Include code blocks.
+    code_blocks: false
+
+  # MD046/code-block-style - Code block style
+  MD046:
+    style: "fenced"
+
+  # MD048/code-fence-style - Code fence style
+  MD048:
+    style: "backtick"
+
+  # MD049/emphasis-style - Emphasis style should be consistent
+  MD049:
+    style: "underscore"
+
+  # MD050/strong-style - Strong style should be consistent
+  MD050:
+    style: "asterisk"