Guidelines

The definitive Quero Education code-style guide.

This project is intended to centralize and standardize the code guidelines of our many projects with different stacks.
Checkout all of our available guidelines and linter configurations:

• Javascript (base)
  • Typescript
  • React
  • Vue
• CSS
• Ruby

Usage

Javascript

All of our javascript code-style guides extends from eslint-config-base. In order to use a specific eslint-config you need to install it and add it to your .eslintrc.js. Example:

$ npm install --save-dev @quero/eslint-config-base @quero/eslint-config-typescript

  'extends': [
    '@quero/eslint-config-typescript',
  ],

CSS

Smiliar to javascript, just install it and add the stylelint-config-base to your .stylelintrc.js:

$ npm install --save-dev @quero/stylelint-config-base

module.exports = {
  extends: '@quero/stylelint-config-base',
};

Ruby

Add the Rubocop gem configuration to the project.

Contributing

We encourage you to open a PR/issue if you want to add or change a rule on one of our linters.
Before releasing your changes, check the CONTRIBUTING.md to bump the version correctly.