Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tunnckocore/eslint-config-charlint

Code style: Charlike. Thin layer on top of the Standard JavaScript Style v9, for more readable code.
https://github.com/tunnckocore/eslint-config-charlint

charlike charlint config eslint lint shareable-configs standard

Last synced: about 1 month ago
JSON representation

Code style: Charlike. Thin layer on top of the Standard JavaScript Style v9, for more readable code.

Host: GitHub
URL: https://github.com/tunnckocore/eslint-config-charlint
Owner: tunnckoCore
License: mit
Created: 2017-02-23T17:24:25.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-01-12T05:41:44.000Z (almost 2 years ago)
Last Synced: 2024-10-05T02:18:25.644Z (about 2 months ago)
Topics: charlike, charlint, config, eslint, lint, shareable-configs, standard
Language: JavaScript
Homepage:
Size: 375 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # eslint-config-charlint [![NPM version](https://img.shields.io/npm/v/eslint-config-charlint.svg?style=flat)](https://www.npmjs.com/package/eslint-config-charlint) [![NPM monthly downloads](https://img.shields.io/npm/dm/eslint-config-charlint.svg?style=flat)](https://npmjs.org/package/eslint-config-charlint) [![npm total downloads][downloads-img]][downloads-url]

> Code style: Charlike. Thin layer on top of the Standard JavaScript Style v9, for more readable code.

[![codeclimate][codeclimate-img]][codeclimate-url] 

[![codestyle][standard-img]][standard-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](#notes)

  * [Changes](#changes)

  * [Adds](#adds)

- [Install](#install)

- [Usage](#usage)

- [Related](#related)

- [Contributing](#contributing)

- [Building docs](#building-docs)

- [Running tests](#running-tests)

- [Author](#author)

- [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## 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](http://eslint.org/docs/rules/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](http://eslint.org/docs/rules/max-len)

- Maximum params to be 3, hence more leads to very big and complex code/functions - [max-params](http://eslint.org/docs/rules/max-params)

  * If that's your case, you are encouraged to split your code more

- Always use parens with arrow functions - [arrow-parens](http://eslint.org/docs/rules/arrow-parens)

- Maximum one statement per line, please - [max-statements-per-line](http://eslint.org/docs/rules/max-statements-per-line) 

- Maximum 10 statements per scope - [max-statements](http://eslint.org/docs/rules/max-statements)

- No nested hell - maximum 5 nested callbacks ([max-nested-callbacks](http://eslint.org/docs/rules/max-nested-callbacks)) and depth ([max-depth](http://eslint.org/docs/rules/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](http://eslint.org/docs/rules/no-extra-semi)

- No empty blocks and statements - [no-empty](http://eslint.org/docs/rules/no-empty). But allowing empty `catch (er) {}`s

- Prefer destructing of arrays and object when possible, because we're in 2017 - [prefer-destructuring](http://eslint.org/docs/rules/prefer-destructuring)

- Prefer arrow block body only if needed - [arrow-body-style](http://eslint.org/docs/rules/arrow-body-style), so

  * No `() => { return { a: 1 } }`, when you can just `() => ({ a: 1 })`

  * No `() => { return 1 }`, when `() => 1` is enough

## Install

Install with [npm](https://www.npmjs.com/)

```

$ npm install eslint-config-charlint --save

```

or install using [yarn](https://yarnpkg.com)

```

$ yarn add eslint-config-charlint

```

## Usage

This config is designed to work with the `extends` feature of [eslint][] inside

the `.eslintrc` files. You can learn more about [Shareable Configs](http://eslint.org/docs/developer-guide/shareable-configs) on the

official ESLint website.

Install it then add this to your `.eslintrc` file:

```json

{

  "extends": "charlint"

}

```

**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.

## Related

- [always-done](https://www.npmjs.com/package/always-done): Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… [more](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme "Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more")

- [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme "Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.")

- [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme "Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.")

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/eslint-config-charlint/issues/new).  

Please read the [contributing guidelines](CONTRIBUTING.md) 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](https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github) too.

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

1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section.

2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#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](.verb.md)._

## Running tests

Clone repository and run the following in that cloned directory

```

$ npm install && npm test

```

## Author

**Charlike Mike Reagent**

+ [github/tunnckoCore](https://github.com/tunnckoCore)

+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)

+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)

## License

Copyright © 2016-2017, [Charlike Mike Reagent](https://i.am.charlike.online). MIT

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 28, 2017._  

_Project scaffolded using [charlike][] cli._

[always-done]: https://github.com/hybridables/always-done

[async-done]: https://github.com/gulpjs/async-done

[base]: https://github.com/node-base/base

[charlike]: https://github.com/tunnckocore/charlike

[commitizen]: https://github.com/commitizen/cz-cli

[dezalgo]: https://github.com/npm/dezalgo

[eslint]: http://eslint.org

[once]: https://github.com/isaacs/once

[standard-version]: https://github.com/conventional-changelog/standard-version

[standard]: http://standardjs.com

[verb-generate-readme]: https://github.com/verbose/verb-generate-readme

[verb]: https://github.com/verbose/verb

[downloads-url]: https://www.npmjs.com/package/eslint-config-charlint

[downloads-img]: https://img.shields.io/npm/dt/eslint-config-charlint.svg

[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/eslint-config-charlint

[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/eslint-config-charlint.svg

[travis-url]: https://travis-ci.org/tunnckoCore/eslint-config-charlint

[travis-img]: https://img.shields.io/travis/tunnckoCore/eslint-config-charlint/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/eslint-config-charlint

[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/eslint-config-charlint/master.svg?label=windows

[coverage-url]: https://codecov.io/gh/tunnckoCore/eslint-config-charlint

[coverage-img]: https://img.shields.io/codecov/c/github/tunnckoCore/eslint-config-charlint/master.svg

[david-url]: https://david-dm.org/tunnckoCore/eslint-config-charlint

[david-img]: https://img.shields.io/david/tunnckoCore/eslint-config-charlint.svg

[standard-url]: https://github.com/tunnckoCore/eslint-config-charlint

[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg