Skip to main content

Extendable codestyle checker and fixer

Project description

https://travis-ci.org/webpp-studio/codestyle.svg?branch=master

This script checks and auto fixes codestyle for all supported languages:

  1. PHP (phpcs)

  2. Python (flake8)

  3. Javascript (jscs and jshint)

  4. CSS (csscomb)

  5. HTML (htmlcs) - without in place fix support

Installation

# First install the pip, npm and pear package managers
# Example for debian
sudo apt-get install python-pip npm php-pear

# Install codestyle and dependencies
pip install codestyle
npm install -g jshint jscs-fixer csscomb htmlcs walk brace-expansion
pear install PHP_CodeSniffer

Usage

usage: codestyle [-h] [-i] [-ff] [-c] [-s standard-dir]
                      [-l language name]
                      target [target ...]

Check and fix code style

positional arguments:
  target                files for checking

optional arguments:
  -h, --help            show this help message and exit
  -i, --try-fix         auto fix codestyle errors
  -I --fix-only       fix possible errors without extra checking
  -c, --compact         Show compact output
  -s standard-dir, --standard standard-dir
                        path to the coding standard directory
  -l language name, --language language name
                        force set language for check

Example

# check all supported files in directory recursive
codestyle /path/to/project/dir

# check set of files
codestyle test.js test.php test.py

# check file and try to fix errors
codestyle -i test.js

# check project with compact output (no detail errors information)
codestyle -c /path/to/project/dir

# check all project and save full report to file
codestyle /path/to/project &> report.txt

Dependencies

  1. phpcs

  2. phpcbf

  3. jshint (global nodejs package)

  4. jscs-fixer (global nodejs package)

  5. jscs (global nodejs package)

  6. flake8

  7. csscomb (NodeJS)

  8. htmlcs (NodeJS)

  9. walk (NodeJS)

  10. brace-expansion (NodeJS)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codestyle-0.0.27.tar.gz (27.4 kB view details)

Uploaded Source

File details

Details for the file codestyle-0.0.27.tar.gz.

File metadata

  • Download URL: codestyle-0.0.27.tar.gz
  • Upload date:
  • Size: 27.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for codestyle-0.0.27.tar.gz
Algorithm Hash digest
SHA256 9dfa065e109319a5a2919d764620d3e615f73b97f28fbe88907b01826c5a32c7
MD5 7002d53a3930444b57cc19b01f9ab061
BLAKE2b-256 9c398d2d5023ce4736965a32aab0fc93351c71c2d0359a363d777b834c90b84f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page