Default Configurations

Last Updated June 23, 2016

This is the default settings list of the static analytical tool within SideCI. Without adding anything to the repository, you can analyze and view the results in SideCI. In that case, setting values which are described in this document are applied.

Once you customize the setting values by sideci.ymlor creating the configuration files for the respective tool, those setting value will be applied.

Table of contents

SideCI currently supports the following programming languages and frameworks.

  1. Ruby / Ruby on Rails
  2. PHP
  3. JavaScript
  4. CoffeeScript
  5. TypeScript
  6. Haml
  7. SCSS
  8. Python

Ruby / Ruby on Rails

The following 4 static analytical tools are provided for Ruby / Ruby on Rails.

  1. RuboCop
  2. Reek
  3. Rails Best Practices
  4. Brakeman

RuboCop

The default settings for RuboCop is based from default.yml. Moreover, if the framework contains Rails, that will automatically be detected and the-Roption will be enabled for execution.

-Roption is an option which enables the functions for the Rails.
RuboCop > Cops > Rails

Related Links

Reek

It uses the default setting of Reek defaults.reek.

Related Links

Rails Best Practices

The default settings of the rails_best_practices are applied in some portions of the default_rails_best_practices.yml file.

RemoveUnused function that reports error detection or bugs are disabled. Similarly, the RemoveTrailingWhitespaceCheck in RuboCop and other tools are also disabled.

The default setting of vendor spec test features are disabled in the rails_best_practices and thus also disables in SideCI. To enable these, adjust the settings in the sideci.yml file.

Related Links

Brakeman

The default settings of the Brakeman are applied.

Related Links

PHP

The following 2 static analytical tools are provided for PHP.

  1. PHP CodeSniffer(PHPCS)
  2. PHP Mess Detector(PHPMD)

PHP CodeSniffer

The PHP CodeSniffer does the analysis with the following settings.
--extensions=php is enabled to detect only .php extension files
PSR2 is applied for coding standards.

The following frameworks will have own coding standards for respective frameworks. Moreover, it sets described analysis target directory.

- CakePHP
  + standard: CakePHP
  + dir: app/
- FuelPHP
  + standard: FuelPHP
  + dir: fuel/
- CodeIgniter
  + standard: CodeIgniter
  + dir: application/
- Symfony
  + standard: Symfony
  + dir: app/

PSR2uses the one which is installed by default PHP CodeSniffer.
Aside from that, the framework uses the following items.
CakePHP, FuelPHP, CodeIgniter, Symfony

To change these settings, kindly create the sideci.yml` file and add this to the top of the repository.

Related Links

PHPMD - PHP Mess Detector

The following rules are enabled by default in PHPMD.
cleancode,codesize,controversial,design,naming,unusedcode

To change the applied rules or specify your own rule setting, kindly create the sideci.yml` file and add this to the top of the repository.

Related Links

JavaScript

The following 2 static analytical tools are provided for JavaScript.

  1. JSHint
  2. ESLint

JSHint

It uses the default setting of JSHint.

Files with the .js extension are the target for analysis. Moreover, Javascript files with the .min.js extension are excluded.

To exclude files from the analysis target, kindly create the .jshintignore file and add this to the top of the repository. To change the settings, kindly create the .jshintrc file and add this to the top of the repository.

Related Links

ESLint

It uses the default setting of ESLint.

Files with the .js extension are the target for analysis. Moreover, Javascript files with the .min.js extension are excluded.

To exclude files from the analysis target, kindly create the .eslintignore file and add this to the top of the repository. To change the settings, kindly create the .eslintrc file and add this to the top of the repository.

Related Links

CoffeeScript

CofeeLint

It uses the default setting of CofeeLint.

Files with the .cofee extension are the target for analysis.

To change the settings, kindly create and list the settings in the coffeelint.json or coffeelint.json file and add this to the top of the repository.

Related Links

TypeScript

TSLint

It uses the default setting of TSLint.

Files with the .ts extension are the target for analysis.

To change the settings, kindly create the tslint.json file and add this to the top of the repository.

Related Links

Haml

HAML-Lint

It uses the default setting in Haml-Lint.

Files with.haml extensions are the target for analysis.

To change the settings, kindly create the.haml-lint.yml file and add this to the top of the repository.

You can set the options such as include_linter exclude_linter config exclude file in the sideci.yml file. Kindly create the sideci.yml file and add this to the top of the repository.

Related Links

SCSS

SCSS-Lint

It uses the default setting in SCSS-Lint.

The app/assets/stylesheets/**/*.css.scss file will be analyzed. To change the analysis target, kindly specify the file in scss_files: by .scss-lint.yml.

To change the settings, kindly create the.scss-lint.yml file and add this to the top of the repository.

Related Links

Python

Flake8

It uses the default setting.

To change the settings, kindly create the tox.ini or setup.cfg file and add this to the top of the repository.

SideCI uses Python3 by default, if you'd like to use Python2, refer Configuration with sideci.yml

Related Links
- Flake8#Configuration
- Configuration with sideci.yml

Conclusion

This document contains the default settings of SideCi for when using it without settings or customizing the analysis tools. To customize, kindly visit the related links listed in the document.

Additionally, kindly visit [Setup the code review function in sideci.yml for the list of available settings in SideCI.

Default Configurations

Last Updated June 23, 2016

This is the default settings list of the static analytical tool within SideCI. Without adding anything to the repository, you can analyze and view the results in SideCI. In that case, setting values which are described in this document are applied.

Once you customize the setting values by sideci.ymlor creating the configuration files for the respective tool, those setting value will be applied.

Table of contents

SideCI currently supports the following programming languages and frameworks.

  1. Ruby / Ruby on Rails
  2. PHP
  3. JavaScript
  4. CoffeeScript
  5. TypeScript
  6. Haml
  7. SCSS
  8. Python

Ruby / Ruby on Rails

The following 4 static analytical tools are provided for Ruby / Ruby on Rails.

  1. RuboCop
  2. Reek
  3. Rails Best Practices
  4. Brakeman

RuboCop

The default settings for RuboCop is based from default.yml. Moreover, if the framework contains Rails, that will automatically be detected and the-Roption will be enabled for execution.

-Roption is an option which enables the functions for the Rails.
RuboCop > Cops > Rails

Related Links

Reek

It uses the default setting of Reek defaults.reek.

Related Links

Rails Best Practices

The default settings of the rails_best_practices are applied in some portions of the default_rails_best_practices.yml file.

RemoveUnused function that reports error detection or bugs are disabled. Similarly, the RemoveTrailingWhitespaceCheck in RuboCop and other tools are also disabled.

The default setting of vendor spec test features are disabled in the rails_best_practices and thus also disables in SideCI. To enable these, adjust the settings in the sideci.yml file.

Related Links

Brakeman

The default settings of the Brakeman are applied.

Related Links

PHP

The following 2 static analytical tools are provided for PHP.

  1. PHP CodeSniffer(PHPCS)
  2. PHP Mess Detector(PHPMD)

PHP CodeSniffer

The PHP CodeSniffer does the analysis with the following settings.
--extensions=php is enabled to detect only .php extension files
PSR2 is applied for coding standards.

The following frameworks will have own coding standards for respective frameworks. Moreover, it sets described analysis target directory.

- CakePHP
  + standard: CakePHP
  + dir: app/
- FuelPHP
  + standard: FuelPHP
  + dir: fuel/
- CodeIgniter
  + standard: CodeIgniter
  + dir: application/
- Symfony
  + standard: Symfony
  + dir: app/

PSR2uses the one which is installed by default PHP CodeSniffer.
Aside from that, the framework uses the following items.
CakePHP, FuelPHP, CodeIgniter, Symfony

To change these settings, kindly create the sideci.yml` file and add this to the top of the repository.

Related Links

PHPMD - PHP Mess Detector

The following rules are enabled by default in PHPMD.
cleancode,codesize,controversial,design,naming,unusedcode

To change the applied rules or specify your own rule setting, kindly create the sideci.yml` file and add this to the top of the repository.

Related Links

JavaScript

The following 2 static analytical tools are provided for JavaScript.

  1. JSHint
  2. ESLint

JSHint

It uses the default setting of JSHint.

Files with the .js extension are the target for analysis. Moreover, Javascript files with the .min.js extension are excluded.

To exclude files from the analysis target, kindly create the .jshintignore file and add this to the top of the repository. To change the settings, kindly create the .jshintrc file and add this to the top of the repository.

Related Links

ESLint

It uses the default setting of ESLint.

Files with the .js extension are the target for analysis. Moreover, Javascript files with the .min.js extension are excluded.

To exclude files from the analysis target, kindly create the .eslintignore file and add this to the top of the repository. To change the settings, kindly create the .eslintrc file and add this to the top of the repository.

Related Links

CoffeeScript

CofeeLint

It uses the default setting of CofeeLint.

Files with the .cofee extension are the target for analysis.

To change the settings, kindly create and list the settings in the coffeelint.json or coffeelint.json file and add this to the top of the repository.

Related Links

TypeScript

TSLint

It uses the default setting of TSLint.

Files with the .ts extension are the target for analysis.

To change the settings, kindly create the tslint.json file and add this to the top of the repository.

Related Links

Haml

HAML-Lint

It uses the default setting in Haml-Lint.

Files with.haml extensions are the target for analysis.

To change the settings, kindly create the.haml-lint.yml file and add this to the top of the repository.

You can set the options such as include_linter exclude_linter config exclude file in the sideci.yml file. Kindly create the sideci.yml file and add this to the top of the repository.

Related Links

SCSS

SCSS-Lint

It uses the default setting in SCSS-Lint.

The app/assets/stylesheets/**/*.css.scss file will be analyzed. To change the analysis target, kindly specify the file in scss_files: by .scss-lint.yml.

To change the settings, kindly create the.scss-lint.yml file and add this to the top of the repository.

Related Links

Python

Flake8

It uses the default setting.

To change the settings, kindly create the tox.ini or setup.cfg file and add this to the top of the repository.

SideCI uses Python3 by default, if you'd like to use Python2, refer Configuration with sideci.yml

Related Links
- Flake8#Configuration
- Configuration with sideci.yml

Conclusion

This document contains the default settings of SideCi for when using it without settings or customizing the analysis tools. To customize, kindly visit the related links listed in the document.

Additionally, kindly visit [Setup the code review function in sideci.yml for the list of available settings in SideCI.