Skip to content

Commit

Permalink
Update test.yml and phpcs.dist.xml
Browse files Browse the repository at this point in the history
  • Loading branch information
@nielslange
nielslange committed Oct 14, 2024
1 parent 2580104 commit 01310b5
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 101 deletions.
52 changes: 12 additions & 40 deletions .github/workflows/test.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,56 +3,28 @@ name: Run PHPCS, PHPLint, Psalm and Cypress
on: [pull_request, push]

jobs:
PHPCS:
PHP_Tools:
runs-on: ubuntu-latest
strategy:
matrix:
tool: [PHPCS, PHPLint, Psalm]
steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Install Composer dependencies
uses: ramsey/composer-install@v1

- name: Show PHPCS sniffs
run: ./vendor/bin/phpcs -i

- name: Show PHPCS version
run: ./vendor/bin/phpcs --version

- name: Run PHP_CodeSniffer
run: composer phpcs

PHPLint:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Install Composer dependencies
uses: ramsey/composer-install@v1

- name: Show PHPLint version info
run: ./vendor/bin/phplint --version

- name: Run PHPLint
run: composer phplint

Psalm:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Set up PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'

- name: Install Composer dependencies
uses: ramsey/composer-install@v1

- name: Show PHPCS sniffs
run: ./vendor/bin/phpcs -i

- name: Show version info
run: ./vendor/bin/psalm --version
- name: Show ${matrix.tool} version info
run: ./vendor/bin/${{ matrix.tool,, }} --version

- name: Run Psalm
run: composer psalm
- name: Run ${matrix.tool}
run: composer ${{ matrix.tool,, }}

Cypress:
runs-on: ubuntu-latest
Expand Down
122 changes: 61 additions & 61 deletions phpcs.dist.xml
View file
Original file line number Diff line number Diff line change
@@ -1,77 +1,77 @@
<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="SMNTCS Custom Logo Link Coding Standards" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">

<!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
<!-- See https://github.com/WordPress/WordPress-Coding-Standards/blob/develop/.phpcs.xml.dist -->
<!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
<!-- See https://github.com/WordPress/WordPress-Coding-Standards/blob/develop/.phpcs.xml.dist -->

<!-- Set a description for this ruleset. -->
<description>Coding standards used for checking the SMNTCS Custom Logo Link plugin.</description>
<!-- Set a description for this ruleset. -->
<description>Coding standards used for checking the SMNTCS Custom Logo Link plugin.</description>

<!-- Check the entire theme. -->
<file>.</file>
<!-- Check the entire theme. -->
<file>.</file>

<!-- Exclude patterns. -->
<exclude-pattern>/vendor/*</exclude-pattern>
<exclude-pattern>/node_modules/*</exclude-pattern>
<!-- Exclude patterns. -->
<exclude-pattern>/vendor/*</exclude-pattern>
<exclude-pattern>/node_modules/*</exclude-pattern>

<!-- Additional arguments. -->
<arg value="sp"/>
<arg name="basepath" value="."/>
<arg name="parallel" value="8"/>
<arg name="cache"/>
<arg name="extensions" value="php"/>
<!-- Additional arguments. -->
<arg value="sp"/>
<arg name="basepath" value="."/>
<arg name="parallel" value="8"/>
<arg name="cache"/>
<arg name="extensions" value="php"/>

<!-- Include the WordPress rulesets. -->
<rule ref="WordPress-Extra"/>
<rule ref="WordPress-Docs"/>
<!-- Include the WordPress rulesets. -->
<rule ref="WordPress-Extra"/>
<rule ref="WordPress-Docs"/>

<!-- We want to allow exceptions for the filename naming, since we are working with a theme. -->
<!-- See https://github.com/WordPress/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#themes-allow-filename-exceptions -->
<rule ref="WordPress.Files.FileName">
<properties>
<property name="is_theme" value="false"/>
</properties>
</rule>
<!-- We want to allow exceptions for the filename naming, since we are working with a theme. -->
<!-- See https://github.com/WordPress/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#themes-allow-filename-exceptions -->
<rule ref="WordPress.Files.FileName">
<properties>
<property name="is_theme" value="false"/>
</properties>
</rule>

<!-- Allow multiple parameters on one line for multi-line function calls. -->
<rule ref="PEAR.Functions.FunctionCallSignature">
<properties>
<property name="allowMultipleArguments" value="true" />
</properties>
</rule>
<!-- Allow multiple parameters on one line for multi-line function calls. -->
<rule ref="PEAR.Functions.FunctionCallSignature">
<properties>
<property name="allowMultipleArguments" value="true" />
</properties>
</rule>

<!-- Improve code readablilty by allowing the artguments after function call. -->
<rule ref="PEAR.Functions.FunctionCallSignature">
<exclude name="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket"/>
<exclude name="PEAR.Functions.FunctionCallSignature.CloseBracketLine"/>
</rule>
<!-- Improve code readablilty by allowing the artguments after function call. -->
<rule ref="PEAR.Functions.FunctionCallSignature">
<exclude name="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket"/>
<exclude name="PEAR.Functions.FunctionCallSignature.CloseBracketLine"/>
</rule>

<!-- Check valid textdomain. -->
<rule ref="WordPress.WP.I18n">
<properties>
<property name="text_domain" type="array">
<element value="smntcs-custom-logo-link"/>
</property>
</properties>
</rule>
<!-- Check valid textdomain. -->
<rule ref="WordPress.WP.I18n">
<properties>
<property name="text_domain" type="array">
<element value="smntcs-custom-logo-link"/>
</property>
</properties>
</rule>

<rule ref="WordPress-Extra">
<!-- _e() and _ex() are considered safe for core translations. -->
<exclude name="WordPress.Security.EscapeOutput.UnsafePrintingFunction"/>
</rule>
<rule ref="WordPress-Extra">
<!-- _e() and _ex() are considered safe for core translations. -->
<exclude name="WordPress.Security.EscapeOutput.UnsafePrintingFunction"/>
</rule>

<rule ref="WordPress.Security.EscapeOutput">
<properties>
<property name="customAutoEscapedFunctions" type="array">
<!-- i18n functions are considered safe for core translations. -->
<element value="__"/>
<element value="_x"/>
<element value="_n"/>
<element value="_nx"/>
<element value="number_format_i18n"/>
<element value="date_i18n"/>
</property>
</properties>
</rule>
<rule ref="WordPress.Security.EscapeOutput">
<properties>
<property name="customAutoEscapedFunctions" type="array">
<!-- i18n functions are considered safe for core translations. -->
<element value="__"/>
<element value="_x"/>
<element value="_n"/>
<element value="_nx"/>
<element value="number_format_i18n"/>
<element value="date_i18n"/>
</property>
</properties>
</rule>

</ruleset>

0 comments on commit 01310b5

Please sign in to comment.