https://github.com/charonlab/coding-standard

https://github.com/charonlab/coding-standard

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/charonlab/coding-standard
• Owner: charonlab
• License: mit
• Created: 2024-01-09T22:53:19.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-03-24T10:05:08.000Z (10 months ago)
• Last Synced: 2024-11-10T23:18:58.005Z (2 months ago)
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# CharonLab Coding Standard

## Installation

1. Install via composer

    ```bash

    composer require --dev charonlab/coding-standard

    ```

2. Create the `phpcs.xml.dist` file in root path of you repository

    ```xml

    

    

        

        

        

        

        

        

        

        

        

        

        

        src

        test

        

        

        

    

    ```

3. Add composer scripts into your `composer.json`

    ```json lines

    {

      "scripts": {

        "cs": "phpcs",

        "cs-fix": "phpcbf -vpw"

      }

    }

    ```

## Usage

- To run checks only:

  ```bash

  composer run cs

  ```

- To automatically fix violations coding standards:

  ```bash

  composer run cs-fix

  ```

## License

The MIT License (MIT). Please see [License](LICENSE) for more information.