Skip to main content

Extendable codestyle checker and fixer

Project description

# Codestyle checker

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)

## 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] [-c] [-s standard-dir] 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
-c, --compact Show compact output
-s standard-dir, --standard standard-dir
Path to the coding standard directory
```

## 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 --try-fix test.js

# check project with compact output (no detail errors information)
codestyle --compact /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)
7. pep8
8. autopep8
9. pylint
10. csscomb

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for codestyle-0.0.9.tar.gz
Algorithm Hash digest
SHA256 303b874e560bb16ca4fe6c272ef98c62287add429a14aed5235b70415ddd147f
MD5 064cb3a1c1b08075479108e750cd804f
BLAKE2b-256 e6c4aaad8e4697dd5cbbbd8d8894c5476f20795bde97cc533edd25e7188e5f9a

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