Giter VIP home page Giter VIP logo

styleguide's Introduction

Styleguide

Reference for our different styleguide in various languages

Please try your utmost to follow them.

As a rule of thumb, leave no errors, try to avoid warnings.

If anything stays, comment it so that the next developer does not waste time if no rule is edited.

Javascript

How to use :

npm i -D lrqdo/styleguide babel-eslint

Add an .eslintrc file in the root of your project, that extends default rules :

{
    "extends": "./node_modules/styleguide/javascript/linters/.eslintrc"
}

Scss

We are using https://github.com/brigade/scss-lint/#installation for linting.

gem install scss_lint

For SublimeText you can use this plugin : https://packagecontrol.io/packages/SublimeLinter-contrib-scss-lint

Atom : https://atom.io/packages/linter-scss-lint

Unfortunately scss-lint does not support inheritance in configuration files, and is not likely to support it in the future (sds/scss-lint#516). And by default, scss-lint looks for the configuration file in the root of your current directory. This is why, for conveniency, the scss-lint.yml file is copied to the root of front-web : https://github.com/lrqdo/front-web/blob/master/package.json#L13

styleguide's People

Contributors

bbecquet avatar cochery avatar fpetitit avatar rik avatar sinewyk avatar sophiemdl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.