{"id":15043797,"url":"https://github.com/rainbowatcher/eslint-config","last_synced_at":"2026-03-16T08:01:58.508Z","repository":{"id":132598993,"uuid":"609136581","full_name":"rainbowatcher/eslint-config","owner":"rainbowatcher","description":"rainbowatcher/eslint-config","archived":false,"fork":false,"pushed_at":"2025-06-27T08:01:30.000Z","size":2128,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-27T09:19:10.989Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/rainbowatcher.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2023-03-03T13:03:08.000Z","updated_at":"2025-06-20T01:34:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"fa991453-c7c0-4296-a4e6-81245d145cb0","html_url":"https://github.com/rainbowatcher/eslint-config","commit_stats":null,"previous_names":[],"tags_count":92,"template":false,"template_full_name":null,"purl":"pkg:github/rainbowatcher/eslint-config","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainbowatcher%2Feslint-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainbowatcher%2Feslint-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainbowatcher%2Feslint-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainbowatcher%2Feslint-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rainbowatcher","download_url":"https://codeload.github.com/rainbowatcher/eslint-config/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainbowatcher%2Feslint-config/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263415758,"owners_count":23463104,"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":"2024-09-24T20:49:36.803Z","updated_at":"2026-03-16T08:01:53.448Z","avatar_url":"https://github.com/rainbowatcher.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm](https://img.shields.io/npm/v/@rainbowatcher/eslint-config?color=16a34a\u0026label=latest)](https://npmjs.com/package/@rainbowatcher/eslint-config)\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/rainbowatcher/eslint-config/ci.yml?color=16a34a)\n![npm download](https://img.shields.io/github/license/rainbowatcher/eslint-config?color=16a34a)\n![GitHub repo size](https://img.shields.io/github/repo-size/rainbowatcher/eslint-config?color=16a34a)\n\n# @rainbowatcher/eslint-config\n\n## Features\n\n- Opinionated\n- Auto fix for formatting, Double quotes, no semi colon\n- Designed to work with TypeScript, JSX, Vue, JSON, YAML, Toml, Markdown, etc. Out-of-box.\n\nWe use double quotes, because Strings in many other backend languages that are using double quotes, It can reduce the discomfort when switching languages and make coding smoother.\n\n## Usage\n\n### 1. Run init setup script\n\n```bash\nnpx @rainbowatcher/eslint-config\n```\n\nfinally it will generate a file like follow\n\n```js\n// eslint.config.js\nimport { defineConfig } from \"@rainbowatcher/eslint-config\"\n\nexport default defineConfig({\n    gitignore: true,\n    json: true,\n    markdown: true,\n    style: true,\n    typescript: true,\n    vue: true,\n    yaml: true,\n    // ...\n})\n```\n\n### 2. Add script in package.json\n\nFor example:\n\n```json\n{\n    \"scripts\": {\n        \"lint\": \"eslint .\"\n    }\n}\n```\n\n### 3. Config Editor for auto fix\n\n#### VS Code\n\nInstall [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and create `.vscode/settings.json` based on your project root\n\n```jsonc\n{\n    // recommend turn prettier disable when style option is enable\n    \"prettier.enable\": false,\n    \"editor.formatOnSave\": false,\n    \"editor.codeActionsOnSave\": {\n        \"source.organizeImports\": \"never\",\n        \"source.fixAll.eslint\": true\n    },\n    \"eslint.validate\": [\n        \"javascript\",\n        \"javascriptreact\",\n        \"json\",\n        \"json5\",\n        \"jsonc\",\n        \"markdown\",\n        \"toml\",\n        \"typescript\",\n        \"typescriptreact\",\n        \"vue\",\n        \"yaml\",\n    ],\n}\n```\n\n#### Zed\n\ncreate `.zed/settings.json` based on your project root\n\n```jsonc\n{\n    \"formatter\": {\n        \"code_actions\": {\n            \"source.fixAll.eslint\": true,\n        },\n    },\n    \"languages\": {\n        \"Markdown\": {\n            \"format_on_save\": \"on\"\n        }\n    },\n    \"language_servers\": [\"eslint\", \"vtsls\"],\n    \"language_server_options\": {\n        \"eslint\": {\n            \"language_ids\": [\n                \"javascript\",\n                \"javascriptreact\",\n                \"json\",\n                \"json5\",\n                \"jsonc\",\n                \"markdown\",\n                \"toml\",\n                \"typescript\",\n                \"typescriptreact\",\n                \"vue\",\n                \"yaml\",\n            ],\n        }\n    }\n}\n```\n\n## Options\n\n```ts\n/**\n * there has no default value for each properties, all properties are optional and be set by defineConfig\n */\nexport type Options = {\n    /**\n     * enable eslint for css\n     */\n    css?: boolean\n\n    /**\n     * enable git ignore intergration\n     */\n    gitignore?: boolean\n\n    /**\n     * enable lint for graphql\n     */\n    graphql?: boolean\n\n    /**\n     * enable lint for json\n     */\n    json?: boolean\n\n    /**\n     * enable lint for jsx\n     */\n    jsx?: boolean\n\n    /**\n     * enable lint for markdown\n     */\n    markdown?: boolean\n\n    /**\n     * enable stylistic rules\n     */\n    style?: boolean | StyleOptions\n\n    /**\n     * enable lint for toml\n     */\n    toml?: boolean\n\n    /**\n     * enable lint for typescript\n     */\n    typescript?: boolean | TypescriptOptions\n\n    /**\n     * enable lint for unocss\n     */\n    unocss?: boolean\n\n    /**\n     * enable eslint for vue\n     */\n    vue?: boolean\n\n    /**\n     * enable lint for yaml\n     */\n    yaml?: boolean\n}\n\nexport type TypescriptOptions = {\n    tsconfigPath: string\n    typeAware?: boolean\n}\n\nexport type StyleOptions = {\n    semi?: boolean\n    singleQuote?: boolean\n    tabWidth?: number\n    trailingComma?: \"all\" | \"none\"\n    useTabs?: boolean\n}\n```\n\n## Plan\n\nWe will consider referencing the following projects:\n\n1. [antfu/eslint-config](https://github.com/antfu/eslint-config)\n2. [eslint-config-standard](https://github.com/standard/eslint-config-standard)\n3. [eslint-config-xo](https://github.com/xojs/eslint-config-xo)\n4. [eslint-config-alloy](https://github.com/AlloyTeam/eslint-config-alloy)\n\n## Development\n\n1. Clone this repository\n2. Install dependencies by using `pnpm install`\n3. Add rules and test cases, then run tests by using `pnpm test`\n\n## License\n\n[MIT](./LICENSE) License \u0026copy; 2023-PRESENT [Rainbow Watcher](https://github.com/rainbowatcher)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frainbowatcher%2Feslint-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frainbowatcher%2Feslint-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frainbowatcher%2Feslint-config/lists"}