{"id":16811701,"url":"https://github.com/theoludwig/eslint-config-conventions","last_synced_at":"2026-04-21T08:09:51.271Z","repository":{"id":44903571,"uuid":"461225605","full_name":"theoludwig/eslint-config-conventions","owner":"theoludwig","description":"ESLint shareable config to enforce strict conventions and good code quality.","archived":false,"fork":false,"pushed_at":"2026-04-13T12:30:30.000Z","size":1342,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2026-04-13T14:24:13.367Z","etag":null,"topics":["code","conventions","eslint","eslintconfig","linter","quality","strict"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/eslint-config-conventions","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/theoludwig.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-02-19T15:05:59.000Z","updated_at":"2026-04-13T12:29:56.000Z","dependencies_parsed_at":"2023-02-19T12:45:28.269Z","dependency_job_id":"a0e4aa1f-33d7-4f01-992b-f94b3756479f","html_url":"https://github.com/theoludwig/eslint-config-conventions","commit_stats":{"total_commits":126,"total_committers":2,"mean_commits":63.0,"dds":"0.30952380952380953","last_synced_commit":"12f37d01b3c3b6fe474e88d05ada6c336a5a0e39"},"previous_names":["divlo/eslint-config-conventions"],"tags_count":60,"template":false,"template_full_name":null,"purl":"pkg:github/theoludwig/eslint-config-conventions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theoludwig%2Feslint-config-conventions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theoludwig%2Feslint-config-conventions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theoludwig%2Feslint-config-conventions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theoludwig%2Feslint-config-conventions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theoludwig","download_url":"https://codeload.github.com/theoludwig/eslint-config-conventions/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theoludwig%2Feslint-config-conventions/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32082833,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T06:27:27.065Z","status":"ssl_error","status_checked_at":"2026-04-21T06:27:21.250Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","conventions","eslint","eslintconfig","linter","quality","strict"],"created_at":"2024-10-13T10:19:31.825Z","updated_at":"2026-04-21T08:09:51.265Z","avatar_url":"https://github.com/theoludwig.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eeslint-config-conventions\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e\u003ca href=\"https://eslint.org/docs/developer-guide/shareable-configs\"\u003eESLint shareable config\u003c/a\u003e to enforce strict conventions and good code quality.\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"./CONTRIBUTING.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat\" alt=\"CONTRIBUTING\" /\u003e\u003c/a\u003e\n  \u003ca href=\"./LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/licence-MIT-blue.svg\" alt=\"Licence MIT\"/\u003e\u003c/a\u003e\n  \u003ca href=\"./CODE_OF_CONDUCT.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg\" alt=\"Contributor Covenant\" /\u003e\u003c/a\u003e\n  \u003cbr /\u003e\n  \u003ca href=\"https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml\"\u003e\u003cimg src=\"https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop\" alt=\"lint action\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml\"\u003e\u003cimg src=\"https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop\" alt=\"test action\" /\u003e\u003c/a\u003e\n  \u003cbr /\u003e\n  \u003ca href=\"https://conventionalcommits.org\"\u003e\u003cimg src=\"https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg\" alt=\"Conventional Commits\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/semantic-release/semantic-release\"\u003e\u003cimg src=\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\" alt=\"semantic-release\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/eslint-config-conventions\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/eslint-config-conventions.svg\" alt=\"npm version\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## About\n\n**eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality. It supports both **JavaScript** and **TypeScript**.\n\nThis configuration is mostly **for catching bugs** and **code-quality** so it is recommended to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration.\n\nMore information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html).\n\n## Getting Started\n\n### Prerequisites\n\n[Node.js](https://nodejs.org/) \u003e= 20.11.0\n\n### Installation\n\n```sh\nnpm install --save-dev \\\n  eslint@^9.22.0 \\\n  eslint-plugin-promise@^7.2.1 \\\n  eslint-plugin-unicorn@^63.0.0 \\\n  eslint-plugin-import-x@^4.6.1 \\\n  globals@^17.0.0 \\\n  typescript@^5.9.3 \\\n  typescript-eslint@^8.32.0 \\\n  eslint-config-conventions@latest\n```\n\nDependencies are:\n\n- [ESLint](https://github.com/eslint/eslint)\n- [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins)\n  - [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise)\n  - [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)\n  - [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x)\n- [globals](https://github.com/sindresorhus/globals)\n- [TypeScript](https://github.com/Microsoft/TypeScript)\n- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint): tooling which enables ESLint to support TypeScript.\n- This package: `eslint-config-conventions`\n\n### Configuration\n\n#### `eslint.config.js`\n\n```js\nimport { defineConfig } from \"eslint/config\"\nimport configConventions from \"eslint-config-conventions\"\n\nexport default defineConfig(...configConventions, {\n  files: [\"**/*.ts\", \"**/*.tsx\"],\n  languageOptions: {\n    parser: typescriptESLint.parser,\n    parserOptions: {\n      projectService: true,\n      tsconfigRootDir: import.meta.dirname,\n    },\n  },\n})\n```\n\n#### Configuration with [Prettier](https://prettier.io/) (recommended)\n\n```sh\nnpm install --save-dev prettier\n\n# Create an empty config file to let editors and other tools know you are using Prettier\n# You can personalize it with your own rules\necho \"{}\" \u003e .prettierrc.json\n```\n\nThat's all! No need to update the `eslint.config.js` configuration.\n\nWe discourage usage of [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier), as `eslint-config-conventions` doesn't include any stylistic rules, and including these packages has several drawbacks (listed in [Integrating with Linters](https://prettier.io/docs/en/integrating-with-linters.html)) and brings no benefits for this configuration.\n\n#### `package.json`\n\n```json\n{\n  \"scripts\": {\n    \"lint:eslint\": \"eslint . --max-warnings 0\",\n    \"lint:prettier\": \"prettier . --check\"\n  }\n}\n```\n\n### Usage\n\n```sh\nnode --run lint:eslint\n# or to apply automatic fixes to code\nnode --run lint:eslint -- --fix\n\n# Validate code formatting in all supported languages by Prettier\nnode --run lint:prettier\n```\n\n### `.oxlintrc.json` (if using [oxlint](https://oxc.rs/))\n\n```json\n{\n  \"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n  \"extends\": [\"node_modules/eslint-config-conventions/.oxlintrc.json\"],\n  \"options\": {\n    \"typeAware\": true,\n    \"typeCheck\": true,\n    \"denyWarnings\": true,\n    \"reportUnusedDisableDirectives\": \"error\"\n  }\n}\n```\n\n## Contributing\n\nAnyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.\n\nThe steps to contribute can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheoludwig%2Feslint-config-conventions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheoludwig%2Feslint-config-conventions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheoludwig%2Feslint-config-conventions/lists"}