Javascript: Branding

Created on 28 Mar 2015  ·  35Comments  ·  Source: airbnb/javascript

What I like about JS standard is not only its simplicity (no config), but also branding. But Standard is just a bunch of opinions – it's far from this guide in terms of comprehensiveness.

But yes, I'm a visual thinker – and I do buy stuff by their looks :) But I guess so do many other developers and designers. Just as a good readme with a green travis badge looks reassuring, so does a well-known logo.

How about developing something similar to this:

js-standard-style

enhancement

Most helpful comment

This is the way to go folks:

Code Style

Here's the code:

[![Code Style](https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

You can thank @amio for this one! 😄

All 35 comments

It could have the AirBnB logo and a simple slogan like

“coded in JavaScript style”

You've got great designers out there, telling by https://www.airbnb.com :)

I do believe "JS Standard Code Style" should be used here instead of the other one which actually is "JS Opinionated Code Style"

Interesting. I wonder if it'd be nice to make a general style badge that's extensible in a way so it's easy to tell based on the readme what style the repo follows whether it's Airbnb, Crockford, jQuery, idiomatic or Standard. I want to think about this some more and will try to follow up later this week.

@hshoff, one option is to use http://shields.io/:

 

 

@nkbt how about naming it

“Quality JS code style”

IMO “airbnb” isn't a name which conveys a meaning. Using “JS Standard” code style feels cool – like it's the right thing to do. But using “google” code style, “airbnb” code style, “facebook” code style – or whatever – feels dull. There's no feeling behind it, no subconcious association.

 

 

Think about it:

– doesn't that feel reassuring?

By the way, the NPM package _quality_ is free :)

Whether we just want to put the readme there, or a zero-conf tool like http://npm.im/standard.

code style - Airbnb

@tomekwi, agree, using Airbnb in a shield tells almost nothing how "much standard" it is. And it apparently is the most standard code style according to different code style surveys.

quality imho is kind of misleading for js code style guide (but still less so as standard).

@gaearon, what do you think?

code style - Airbnb

@goatslacker I know this is your brand's color. But it looks like red, and red in a badge has a bad connotation.

How about a neutral blue – the same http://shields.io uses for stable semver version numbers?

code style: airbnb

It also stands out nicely. See for yourselves.

@nkbt agreed – but airbnb/javascript is more than a code style guide. It's a mixture of best practices, explanations, benchmarks and code style.

So using Quality JS would mean not only following a certain style guide, but also following best practices and being concious of various JS caveats.

I'd be wary of any adjectives. I don't think right answer to standard is to label something quality. Somebody else will then create awesome, great, and it all becomes meaningless.

If we have any actual data proving this is the most widespread style, I'd be tempted to call it community. Still, airbnb looks absolutely fine to me.

If we have any actual data proving this is the most widespread style, I'd be tempted to call it community.

Seems reasonable – looking at http://sideeffect.kr/popularconvention/#javascript, it seems like airbnb matches all conventions measured as most popular. And look at the number of stars :)

@goatslacker @hshoff @nkbt @gaearon, here’s my suggestion – to keep the discussion going:

And another variation – “compatible” with the current repo name, so to speak:

Here's a screenshot of our branding from http://airbnb.io
airbnb open source logo thing

@justjake love a mostly reasonable :+1:

:+1: to that as well! It’s a longish name, but way better than “airbnb style”.

The problem with “airbnb style” is simple. The name is no longer valid when you fork the project. And it looks like forking is common and encouraged.

should we rebrand to Mostly Reasonable Style?

The Mostly Reasonable Guide to Writing JavaScript Like a Boss

or TMRGTWJSLAB for short.

@goatslacker :smile:

@justjake :+1:

@justjake: :+1: Personally, I like mostly reasonable. It would also be nice to have zero-config. (I've used standard a few times, despite not liking it, out of laziness). If we had a cli mr, that linted the current directory like standard, that would rock. Also, mostly-reasonable, is available on npm.

I took a look at Standard Plus and considered forking their stuff to copy the standard interface. It seems pretty easy to do, but I personally have low interest in taking on that work in my spare time.

It's crazy easy, I will gladly do it. It just uses eslint. Although, it would be nice first if we:

  • [ ] change our name to mostly-reasonable

  • [ ] update eslint-config-mostly-reasonable to actually match the style guide.

    • [ ] I personally am a fan of auto-generating it with #480. Although I think we should go one step further and generate the eslint config off that.
  • [ ] create an ES5 eslint config, and have eslint-config-mostly-reasonable be ES5 or maybe 6, then have eslint-config-mostly-reasonable/es5 eslint-config-mostly-reasonable/es6 and eslint-config-mostly-reasonable/react.

You don't know me at all, but as someone who is interested in a code convention or style... to me the "Standard Code Style" made me feel that it was what I was looking for. Made me feel secure and comfortable, the one.

So I vote for it.

Also I agree with all the rules proposed on it so..

We were discussing this in https://github.com/airbnb/javascript/pull/455#issuecomment-128103763, here's the quick recap:

We started by talking about the name/branding of the package (related to https://github.com/airbnb/javascript/issues/263) and @ljharb brought up the wonderful idea of using scoped npm packages. So the one-liner command would become:

npm install @airbnb/javascript --save-dev

Hopefully scoped packages catches on so if your team (Super Cool Co.) forks the guide and publishes your own package it would be:

npm install @supercoolco/javascript --save-dev

Which I think is a nice benefit of the scoped package route and encourages teams to use our guide as a starting point for their team's style guide.

@airbnb/javascript will be the one-step install package.

Oh, thanks hshoff

Fair enough! Good to have this thing closed. 😃

Hm. Why this popped up in my notifications, huh?

Anyway. Just to join the thread with few words - i already added badges code style: airbnb at @tunnckoCore. Same as the StandardJS badge, but airbnb instead of standard. It's that simple. No need for logo or anything special. Everyone knows AirBnB and that AirBnB's is the top (in any means like downloads and etc) and always will be. StandardJS is as i remember around 100-200 rules, absolutely nothing to compare to AirBnB full guide and times more rules (for the good).

I realize this is closed, but here is what I'm planning on using

airbnb-style

[![airbnb-style](https://img.shields.io/badge/eslint-airbnb-4B32C3.svg)](https://github.com/airbnb/javascript)]

airbnb word with the "eslint" purple.

In case anyone else is looking for a cute badge (I was)

Make sense. But why purple? ;d The only reason i set it to bright green is consistency on the first line of my badges - trying always to be green (code style, build, codecov, deps).

Because that's the purple that eslint uses was my thinking. All of my badges are already not the same color so I figured I'd pick something that has some meaning.

This is the way to go folks:

Code Style

Here's the code:

[![Code Style](https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb)](https://github.com/airbnb/javascript)

You can thank @amio for this one! 😄

@leo @amio i've updated your post to include a more accurate airbnb color code :-)

Yup, i'm already using that color in few places.

Adding it next to the gitter badge would trigger a wave? ;p Let's do it.

Btw, there is also an logo :P Append icon=airbnb :)

https://badgen.net/badge/style/Airbnb/ff5a5f?icon=airbnb
https://badgen.net/badge/code%20style/airbnb/ff5a5f?icon=airbnb
https://badgen.net/badge/code%20style/Airbnb/ff5a5f?icon=airbnb
https://badgen.net/badge/eslint/airbnb/ff5a5f?icon=airbnb

@olstenlarck and i've updated yours to use the correct capitalization of Airbnb (never AirBnB)

Hm, didn't know that, thanks.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

molily picture molily  ·  37Comments

CWSpear picture CWSpear  ·  167Comments

martpie picture martpie  ·  28Comments

JacksonGariety picture JacksonGariety  ·  43Comments

SimenB picture SimenB  ·  34Comments