Skip to main content

Extendable codestyle checker and fixer

Project description

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

  1. PHP (phpcs)

  2. Python (pep8 and pylint)

  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
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
  -ff, --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. pep8

  7. autopep8

  8. pylint

  9. csscomb

  10. htmlcs

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.18.tar.gz (23.6 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for codestyle-0.0.18.tar.gz
Algorithm Hash digest
SHA256 c51208084a4bf664e3180652a95ef8597ddadbfd63ee86197380e3b14b40c3ec
MD5 01ac044f2f7403f4360763cbe1fd7f2d
BLAKE2b-256 647e5e30ce6de30c158c5e8ac66eb824e14716f8c9d1da858164a145c06dc80f

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