{"id":25850592,"url":"https://github.com/scorum/javascript","last_synced_at":"2025-08-12T14:36:30.103Z","repository":{"id":57139398,"uuid":"267829752","full_name":"scorum/javascript","owner":"scorum","description":"👮 Javascript style guide","archived":false,"fork":false,"pushed_at":"2022-06-28T08:42:21.000Z","size":26,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-17T10:02:27.286Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scorum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-29T10:23:59.000Z","updated_at":"2021-10-28T13:56:31.000Z","dependencies_parsed_at":"2022-08-24T14:23:39.241Z","dependency_job_id":null,"html_url":"https://github.com/scorum/javascript","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scorum%2Fjavascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scorum%2Fjavascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scorum%2Fjavascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scorum%2Fjavascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scorum","download_url":"https://codeload.github.com/scorum/javascript/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241098505,"owners_count":19909343,"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":[],"created_at":"2025-03-01T12:24:36.284Z","updated_at":"2025-03-01T12:24:37.560Z","avatar_url":"https://github.com/scorum.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scorum JavaScript Style Guide\n\n[![Build Status](https://github.com/scorum/javascript/workflows/Node%20CI/badge.svg)](https://github.com/scorum/javascript/actions)\n\nShared ESLint config for Scorum projects\n\n## Principles\n\nOur lint rules are to help us write bug-free, readable and maintainable code.\nRules are usually added because the patterns they are checking for have been proven to be problematic\nand frequently come up in code reviews.\nThe intention is to save both authors and reviewers time by providing the author early feedback at the time of writing.\n\n## Installation\n\n### Required Dependencies\n\nRequired dependencies for ALL configs\n\n```bash\n# dependencies only for all configs\n\nnpm install --save-dev eslint eslint-config-scorum\n```\n\n### Base Dependencies\n\nAdditionall dependencies for `base` config\n\n```bash\n# dependencies only for base config\n\nnpm install --save-dev eslint babel-eslint eslint-config-scorum eslint-plugin-import\n```\n\n### React Dependencies\n\nAdditionall dependencies for `react` config\n\n```bash\n# dependencies only for react config\n\nnpm install --save-dev eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y\n```\n\n### Ramda Dependencies\n\nAdditionall dependencies for `ramda` config\n\n```bash\n# dependencies only for ramda config\n\nnpm install --save-dev eslint-plugin-ramda\n```\n\n### Jest Dependencies\n\nAdditionall dependencies for `jest` config\n\n```bash\n# dependencies only for jest config\n\nnpm install --save-dev eslint-plugin-ramda\n```\n\n### Prettier Dependencies\n\nAdditionall dependencies for `prettier` config\n\n```bash\n# dependencies only for prettier config\n\nnpm install --save-dev prettier eslint-plugin-prettier\n```\n\n## Usage\n\nCreate an `.eslintrc` file that extends this config. For more configuration options, check out the [ESLint docs](https://eslint.org/docs/user-guide/configuring).\n\n### Base\n\n```json\n{\n  \"extends\": \"scorum\"\n}\n```\n\n### React\n\n```json\n{\n  \"extends\": \"scorum/react\"\n}\n```\n\n### Node\n\n```json\n{\n  \"extends\": \"scorum/node\"\n}\n```\n\n### Server\n\nServer config includes `base` and `node` configs\n\n```json\n{\n  \"extends\": \"scorum/server\"\n}\n```\n\n### Client\n\nThis config for vanilla JS (includes `base` config)\n\n```json\n{\n  \"extends\": \"scorum/client\"\n}\n```\n\n### Jest\n\n```json\n{\n  \"extends\": \"scorum/jest\"\n}\n```\n\n### Ramda\n\n```json\n{\n  \"extends\": \"scorum/ramda\"\n}\n```\n\n### Prettier (react support)\n\n```json\n{\n  \"extends\": [\n    \"scorum/prettier\",\n    \"scorum/prettier/react\",\n  ]\n}\n```\n\n### Override rules\n\nIf you need to override or turn off rules:\n\nIf you need to override a rule, your `.eslintrc.json` file should look like the example below. All shared rules will be used, but `eqeqeq` will be turned off.\n\n```json\n{\n  \"extends\": \"scorum\",\n  \"rules\": {\n    \"eqeqeq\": \"off\"\n  },\n  \"env\": {},\n  \"globals\": {},\n  \"rules\": {}\n}\n```\n\n### ToDo\n\n* [ ] Add automatically bumping package version [release-it](https://github.com/release-it/release-it/blob/master/docs/github-releases.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscorum%2Fjavascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscorum%2Fjavascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscorum%2Fjavascript/lists"}