Light

novusvetus / action-php_codesniffer Goto Github PK

View Code? Open in Web Editor NEW

9.0 2.0 0.0 3.36 MB

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

License: BSD 3-Clause "New" or "Revised" License

TypeScript 95.81% JavaScript 4.19%

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

action-php_codesniffer's Introduction

GitHub Action to run PHP_CodeSniffer

Overview

This action runs PHP_CodeSniffer.

Usage

Add a file like this to .github/workflows/phpcs.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

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

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. If you would like to make contributions to this repository, feel free to create a fork and submit a pull request.

Links

action-php_codesniffer's People

Contributors

Stargazers

Watchers

action-php_codesniffer's Issues

Write a better ReadMe

The README.md is very short and has mistakes in the example.

[BUG] Scanning files from last commit

Hi there,

I have implemented your action on one of our symfony test project, and I noticed that action process files only from last commit. So when I updated CR with some new commits, it look for php at this commit and check only this case.

Is there any option to check every file on CR branch not only from last commit?

Thx.

Bring the repo to the new structure and add some workflows.

Bring the repo to the new structure and add some workflows.

Fix potential security vulnerabilities with tmpl in the dependencies.

Upgrade tmpl to version 1.0.5 or later.

Rename the action

The name isn't very well. Rename the action to "PHP_CodeSniffer" for the marketplace.

Fix diff errors to find changed files.

The changed files helper doesn't find all changed files.

[FEATURE] Check all files

Is your feature request related to a problem? Please describe.
Currently only changed files are checked.

Describe the solution you'd like
Add an option to choose whether only changed files should be checked as currently or always all.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.