Skip to content

Latest commit

 

History

History
176 lines (125 loc) · 7.7 KB

.verb.md

File metadata and controls

176 lines (125 loc) · 7.7 KB
Raw

{%= name %} {%= badge('npm') %} {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]

{%= description %}

code-style-charlike [![codeclimate][codeclimate-img]][codeclimate-url] [![linux build][travis-img]][travis-url] [![windows build][appveyor-img]][appveyor-url] [![codecov][coverage-img]][coverage-url] [![dependency status][david-img]][david-url]

Table of Contents

Notes

This config extends [standard][] v9 javascript style and just add few more rules to it, which leads to more readable code. Most of the rules here, are already suggested in the Standard repo, but they are just proposals, so they may or may not be included in the v9 or v10 version of the Standard. I just want one very stable place with all needed things included. Don't want separate CLI too, since we have ESLint CLI which works great.

Status: Locked

  • Does not accepts changes - everyone can sit on top of it, like this sits on top of Standard
  • Meant to be used as config, won't include CLI - probably, not make much sense
  • This isn't a CLI tool - we have ESLint CLI already

Changes

Most noticeable change is that we

  • Disallow computed property spacing, this foo[ 'bar' ] is just too ugly - computed-property-spacing
    • Standard allows both styles, through the eslint-plugin-standard option called either

Adds

In addition we have few more rules

  • Maximum line length should always be strictly 80, we ignore comments - max-len
  • Maximum params to be 3, hence more leads to very big and complex code/functions - max-params
    • If that's your case, you are encouraged to split your code more
  • Always use parens with arrow functions - arrow-parens
  • Maximum one statement per line, please - max-statements-per-line
  • Maximum 10 statements per scope - max-statements
  • No nested hell - maximum 5 nested callbacks (max-nested-callbacks) and depth (max-depth)
    • If that's your case, reogranize code, increase or disable with eslint style comments
  • No extra semi - hence, we use style without any semicolons - no-extra-semi
  • No empty blocks and statements - no-empty. But allowing empty catch (er) {}s
  • Prefer destructing of arrays and objects when possible, because we're in 2017 - prefer-destructuring
  • Prefer arrow block body only if needed - arrow-body-style, so
    • No () => { return { a: 1 } }, when you can just () => ({ a: 1 })
    • No () => { return 1 }, when () => 1 is enough

Badge

Since this is just thin layer on top of the Standard, I don't think we should release our own badge. But in another hand - we are a bit different, so preferebly just call it code style charlike.

So in case you use the charlike style in your projects or just want to support and promote it, then include this badge in your README file.

code-style-charlike

Code for the badge above:

<!-- somewhere at the top -->
[![code-style-charlike][charlike-img]][charlike-url]

<!-- somewhere at the bottom -->
[charlike-img]: https://img.shields.io/badge/code%20style-charlike-536dfe.svg
[charlike-url]: https://github.com/tunnckoCore/eslint-config-charlike

Install

Install with npm

$ npm install {%= name %} --save

or install using yarn

$ yarn add {%= name %}

Usage

This config is designed to work with the extends feature of [eslint][] inside the .eslintrc files. You can learn more about Shareable Configs on the official ESLint website.

Install it then add this to your .eslintrc file:

{
  "extends": "charlike"
}

Note: We omitted the eslint-config- prefix since it is automatically assumed by ESLint. You can override settings from the shareable config by adding them directly into your .eslintrc file.

{% if (verb.related && verb.related.list && verb.related.list.length) { %}

Related

{%= related(verb.related.list, {words: 20}) %} {% } %}

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

  1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
  2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
  3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
  4. Do NOT bump the version in package.json. For that we use npm run release, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

{%= includeEither('authors', 'author') %}

License

{%= copyright({ start: 2016, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= license %}

{%= include('footer') %}
Project scaffolded using [charlike][] cli.

{%= reflinks(verb.reflinks) %}

[downloads-url]: https://www.npmjs.com/package/{%= name %} [downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg

[codeclimate-url]: https://codeclimate.com/github/{%= repository %} [codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg

[travis-url]: https://travis-ci.org/{%= repository %} [travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %} [appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows

[coverage-url]: https://codecov.io/gh/{%= repository %} [coverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg

[david-url]: https://david-dm.org/{%= repository %} [david-img]: https://img.shields.io/david/{%= repository %}.svg