{"id":15365614,"url":"https://github.com/tunnckocore/eslint-config-charlike","last_synced_at":"2025-09-11T21:40:53.822Z","repository":{"id":40945154,"uuid":"83374404","full_name":"tunnckoCore/eslint-config-charlike","owner":"tunnckoCore","description":"Code style: Charlike. Self preferences on top of the Standard Style. They may or may not be included in next releases.","archived":false,"fork":false,"pushed_at":"2022-06-22T08:32:46.000Z","size":386,"stargazers_count":2,"open_issues_count":15,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T18:55:24.251Z","etag":null,"topics":["code","codestyle","config","eslint","javascript","lint","preference","shareable-configs","standard","standardjs","style"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tunnckoCore.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-28T01:16:51.000Z","updated_at":"2019-07-16T07:46:16.000Z","dependencies_parsed_at":"2022-09-12T22:30:43.592Z","dependency_job_id":null,"html_url":"https://github.com/tunnckoCore/eslint-config-charlike","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Feslint-config-charlike","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Feslint-config-charlike/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Feslint-config-charlike/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Feslint-config-charlike/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tunnckoCore","download_url":"https://codeload.github.com/tunnckoCore/eslint-config-charlike/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247492901,"owners_count":20947606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code","codestyle","config","eslint","javascript","lint","preference","shareable-configs","standard","standardjs","style"],"created_at":"2024-10-01T13:15:16.716Z","updated_at":"2025-04-06T14:22:55.810Z","avatar_url":"https://github.com/tunnckoCore.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# eslint-config-charlike [![NPM version](https://img.shields.io/npm/v/eslint-config-charlike.svg?style=flat)](https://www.npmjs.com/package/eslint-config-charlike) [![NPM monthly downloads](https://img.shields.io/npm/dm/eslint-config-charlike.svg?style=flat)](https://npmjs.org/package/eslint-config-charlike) [![npm total downloads][downloads-img]][downloads-url]\n\n\u003e Code style: Charlike. Self preferences on top of Standard Style v9 release. They may or may not be included in next releases.\n\n[![code-style-charlike][charlike-img]][charlike-url]\n[![codeclimate][codeclimate-img]][codeclimate-url] \n[![linux build][travis-img]][travis-url] \n[![windows build][appveyor-img]][appveyor-url] \n[![codecov][coverage-img]][coverage-url] \n[![dependency status][david-img]][david-url]\n\n## Table of Contents\n- [Notes](#notes)\n  * [Changes](#changes)\n  * [Adds](#adds)\n  * [Badge](#badge)\n- [Install](#install)\n- [Usage](#usage)\n- [Related](#related)\n- [Contributing](#contributing)\n- [Building docs](#building-docs)\n- [Running tests](#running-tests)\n- [Author](#author)\n- [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Notes\n\nThis config extends **[standard][] v9 javascript style** and just add few more rules to it,\nwhich leads to more readable code. Most of the rules here, are already suggested in the\nStandard repo, but they are just proposals, so they may or may not be included in the v9 or v10 version\nof the Standard. I just want one very stable place with all needed things included. Don't want \nseparate CLI too, since we have ESLint CLI which works great.\n\n**Status: Locked**\n- Does not accepts changes - everyone can sit on top of it, like this sits on top of Standard\n- Meant to be used as _config_, won't include CLI - probably, not make much sense\n- This isn't a CLI tool - we have ESLint CLI already\n\n### Changes\nMost noticeable change is that we\n\n- Disallow computed property spacing, this `foo[ 'bar' ]` is just too ugly - [computed-property-spacing](http://eslint.org/docs/rules/computed-property-spacing)\n  * Standard allows both styles, through the `eslint-plugin-standard` option called `either`\n\n### Adds\n\nIn addition we have few more rules\n\n- Maximum line length should always be strictly 80, we ignore comments - [max-len](http://eslint.org/docs/rules/max-len)\n- Maximum params to be 3, hence more leads to very big and complex code/functions - [max-params](http://eslint.org/docs/rules/max-params)\n  * If that's your case, you are encouraged to split your code more\n- Always use parens with arrow functions - [arrow-parens](http://eslint.org/docs/rules/arrow-parens)\n- Maximum one statement per line, please - [max-statements-per-line](http://eslint.org/docs/rules/max-statements-per-line) \n- Maximum 10 statements per scope - [max-statements](http://eslint.org/docs/rules/max-statements)\n- 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))\n  * If that's your case, reogranize code, increase or disable with eslint style comments\n- No extra semi - hence, we use style without **any** semicolons - [no-extra-semi](http://eslint.org/docs/rules/no-extra-semi)\n- No empty blocks and statements - [no-empty](http://eslint.org/docs/rules/no-empty). But allowing empty `catch (er) {}`s\n- Prefer destructing of arrays and objects when possible, because we're in 2017 - [prefer-destructuring](http://eslint.org/docs/rules/prefer-destructuring)\n- Prefer arrow block body only if needed - [arrow-body-style](http://eslint.org/docs/rules/arrow-body-style), so\n  * No `() =\u003e { return { a: 1 } }`, when you can just `() =\u003e ({ a: 1 })`\n  * No `() =\u003e { return 1 }`, when `() =\u003e 1` is enough\n\n### Badge\n\nSince this is just _thin_ layer on top of **the Standard**, I don't think we should release our own badge. But in \nanother hand - we are a bit different, so preferebly just call it `code style charlike`.\n\nSo in case you use the charlike style in your projects or just want to support and promote it, then \ninclude this badge in your README file.\n\n[![code-style-charlike][charlike-img]][charlike-url]\n\n[charlike-img]: https://img.shields.io/badge/code%20style-charlike-536dfe.svg\n[charlike-url]: https://github.com/tunnckoCore/eslint-config-charlike\n\nCode for the badge above:\n\n```md\n\u003c!-- somewhere at the top --\u003e\n[![code-style-charlike][charlike-img]][charlike-url]\n\n\u003c!-- somewhere at the bottom --\u003e\n[charlike-img]: https://img.shields.io/badge/code%20style-charlike-536dfe.svg\n[charlike-url]: https://github.com/tunnckoCore/eslint-config-charlike\n\n```\n\n## Install\nInstall with [npm](https://www.npmjs.com/)\n\n```\n$ npm install eslint-config-charlike --save\n```\n\nor install using [yarn](https://yarnpkg.com)\n\n```\n$ yarn add eslint-config-charlike\n```\n\n## Usage\n\nThis config is designed to work with the `extends` feature of [eslint][] inside\nthe `.eslintrc` files. You can learn more about [Shareable Configs](http://eslint.org/docs/developer-guide/shareable-configs) on the\nofficial ESLint website.\n\nInstall it then add this to your `.eslintrc` file:\n\n```json\n{\n  \"extends\": \"charlike\"\n}\n```\n\n**Note**: We omitted the `eslint-config-` prefix since it is automatically assumed by ESLint.\nYou can override settings from the shareable config by adding them directly into your `.eslintrc` file.\n\n## Related\n- [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\")\n- [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.\")\n- [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.\")\n\n## Contributing\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/eslint-config-charlike/issues/new).  \nPlease read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.  \nIf 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\u0026utm_medium=button\u0026utm_term=tunnckocore\u0026utm_campaign=github) too.\n\n**In short:** If you want to contribute to that project, please follow these things\n\n1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See [\"Building docs\"](#building-docs) section.\n2. Ensure anything is okey by installing the dependencies and run the tests. See [\"Running tests\"](#running-tests) section.\n3. 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.\n4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.\n\nThanks a lot! :)\n\n## Building docs\nDocumentation 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\n\n```\n$ npm install verbose/verb#dev verb-generate-readme --global \u0026\u0026 verb\n```\n\n_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._\n\n## Running tests\nClone repository and run the following in that cloned directory\n\n```\n$ npm install \u0026\u0026 npm test\n```\n\n## Author\n**Charlike Mike Reagent**\n\n+ [github/tunnckoCore](https://github.com/tunnckoCore)\n+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)\n+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)\n\n## License\nCopyright © 2016-2017, [Charlike Mike Reagent](https://i.am.charlike.online). MIT\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.2, on February 28, 2017._  \n_Project scaffolded using [charlike][] cli._\n\n[always-done]: https://github.com/hybridables/always-done\n[async-done]: https://github.com/gulpjs/async-done\n[base]: https://github.com/node-base/base\n[charlike]: https://github.com/tunnckocore/charlike\n[commitizen]: https://github.com/commitizen/cz-cli\n[dezalgo]: https://github.com/npm/dezalgo\n[eslint]: http://eslint.org\n[once]: https://github.com/isaacs/once\n[standard-version]: https://github.com/conventional-changelog/standard-version\n[standard]: http://standardjs.com\n[verb-generate-readme]: https://github.com/verbose/verb-generate-readme\n[verb]: https://github.com/verbose/verb\n\n[downloads-url]: https://www.npmjs.com/package/eslint-config-charlike\n[downloads-img]: https://img.shields.io/npm/dt/eslint-config-charlike.svg\n\n[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/eslint-config-charlike\n[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/eslint-config-charlike.svg\n\n[travis-url]: https://travis-ci.org/tunnckoCore/eslint-config-charlike\n[travis-img]: https://img.shields.io/travis/tunnckoCore/eslint-config-charlike/master.svg?label=linux\n\n[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/eslint-config-charlike\n[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/eslint-config-charlike/master.svg?label=windows\n\n[coverage-url]: https://codecov.io/gh/tunnckoCore/eslint-config-charlike\n[coverage-img]: https://img.shields.io/codecov/c/github/tunnckoCore/eslint-config-charlike/master.svg\n\n[david-url]: https://david-dm.org/tunnckoCore/eslint-config-charlike\n[david-img]: https://img.shields.io/david/tunnckoCore/eslint-config-charlike.svg\n\n[charlike-img]: https://img.shields.io/badge/code%20style-charlike-536dfe.svg\n[charlike-url]: https://github.com/tunnckoCore/eslint-config-charlike\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunnckocore%2Feslint-config-charlike","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftunnckocore%2Feslint-config-charlike","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunnckocore%2Feslint-config-charlike/lists"}