https://github.com/novusvetus/action-php_codesniffer

GitHub PHP_CodeSniffer action. This workflow check the PHP, CSS and Javascript files for the wanted coding standards.
https://github.com/novusvetus/action-php_codesniffer

codechecker codequality codereview codesniffer css github github-actions hacktoberfest javascript marketplace marketplace-released php php7 php8 phpcodesniffer workflow workflows

Last synced: 9 days ago
JSON representation

GitHub PHP_CodeSniffer action. This workflow check the PHP, CSS and Javascript files for the wanted coding standards.

• Host: GitHub
• URL: https://github.com/novusvetus/action-php_codesniffer
• Owner: Novusvetus
• License: bsd-3-clause
• Created: 2021-08-29T20:26:43.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T04:11:00.000Z (7 months ago)
• Last Synced: 2024-10-13T13:09:35.951Z (24 days ago)
• Topics: codechecker, codequality, codereview, codesniffer, css, github, github-actions, hacktoberfest, javascript, marketplace, marketplace-released, php, php7, php8, phpcodesniffer, workflow, workflows
• Language: TypeScript
• Homepage:
• Size: 3.28 MB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# GitHub Action to run PHP_CodeSniffer

## Overview

This action runs [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).

## Usage

Add a file like this to `.github/workflows/phpcs.yml`:

```yml

name: "CI"

on:

  push:

    paths:

      - "**.php"

      - "phpcs.xml"

      - ".github/workflows/phpcs.yml"

  pull_request:

    paths:

      - "**.php"

      - "phpcs.xml"

      - ".github/workflows/phpcs.yml"

jobs:

  phpcs:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

        with:

          fetch-depth: 0 # important!

      - name: Install PHP_CodeSniffer

        run: |

          curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar

          php phpcs.phar --version

      - uses: Novusvetus/[email protected]

        with:

          files: "**.php"

          scan_all: true

          phpcs_path: php phpcs.phar

          standard: phpcs.xml

```

You also will need either to pick a build code style standard or create `phpcs.xml` file.

## License ##

3-clause BSD license

See [License](LICENSE)

## Bugtracker ##

Bugs are tracked in the issues section of this repository on GitHub.

Please read over existing issues before submitting an issue to ensure yours is unique.

[Create a new issue](../../issues/new)

 - Describe the steps to reproduce your issue.

 - Describe the expected and the actual outcome.

 - Describe your environment as detailed as possible.

## Development and contribution ##

Feature requests can also be made by [creating a new issue](../../issues/new).

If you would like to make contributions to this repository, feel free to [create a fork](../../fork) and submit a pull request.

## Links ##

* [ReindeerWeb](https://www.reindeer-web.de)

* [Novusvetus](https://www.novusvetus.de)

* [License](./LICENSE)

* [Contributing](./CONTRIBUTING.md)