Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@studyportals/code-style

Package Overview
Dependencies
Maintainers
18
Versions
48
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@studyportals/code-style

Default CodeClimate configurations for the Studyportals repositories

  • 1.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.2K
increased by8.91%
Maintainers
18
Weekly downloads
 
Created
Source

CodeStyle

Default CodeClimate configurations for use in Studyportals repositories.

If you want to add or update your configuration, take the .codeclimate.yml file and add it to the root of your repository.

Please send pull requests to the Tribe Leads, RobH or Frank if you think you have a new default setting for the engines.

Install

You can add CodeStyle as a dependency to your project by running the following command:

npm install @studyportals/code-style

How To Use

When you have installed the package you can simply extend from the configurations inside the CodeStyle package.

Example ESLint

"eslintConfig": {
    "extends": "./node_modules/@studyportals/code-style/.eslintrc.js",
    "parserOptions": {
        "sourceType": "module"
    }
}

Example TSLint

{
    "extends": "./node_modules/@studyportals/code-style/tslint.json"
}

By extending from the linting config files in CodeStyle you are ensuring that you are using the same configuration as we use in our CodeClimate configuration.

If you would like to use the configurations for the PHP and SCSS linters you would have to copy it from this projects source.

Linting Dependencies

In order to guarantee the same linting behaviour as in CodeClimate we added the right versions of eslint and tslint as peer dependencies to this package. Please find which version we are using right now in the table below:

LinterVersionBased on
ESLint5.7.0eslint:recommended
TSLint5.9.1tslint:recommended
SCSSLint0.52.0 (deprecated)Custom configuration
PHPmd2.5.0Custom configuration
PHPCodeSniffer2.8.1Custom configuration

FAQs

Package last updated on 19 Mar 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc