{"id":13822990,"url":"https://github.com/nuxt-modules/eslint","last_synced_at":"2025-05-07T16:07:09.597Z","repository":{"id":34136519,"uuid":"170352976","full_name":"nuxt-modules/eslint","owner":"nuxt-modules","description":"ESLint module for Nuxt.js","archived":false,"fork":false,"pushed_at":"2024-04-30T00:25:16.000Z","size":1066,"stargazers_count":142,"open_issues_count":12,"forks_count":15,"subscribers_count":16,"default_branch":"main","last_synced_at":"2024-05-02T05:54:59.864Z","etag":null,"topics":["eslint","nuxt","nuxt-module","nuxtjs"],"latest_commit_sha":null,"homepage":"","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/nuxt-modules.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}},"created_at":"2019-02-12T16:37:28.000Z","updated_at":"2024-05-06T14:24:26.070Z","dependencies_parsed_at":"2023-01-15T04:50:51.612Z","dependency_job_id":"834f21c7-9fec-4fef-a396-f95175c6eec9","html_url":"https://github.com/nuxt-modules/eslint","commit_stats":{"total_commits":125,"total_committers":9,"mean_commits":13.88888888888889,"dds":0.496,"last_synced_commit":"d292435783ee625ba578522535dfa4f29e1c6925"},"previous_names":["nuxt-community/eslint-module"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Feslint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Feslint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Feslint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Feslint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuxt-modules","download_url":"https://codeload.github.com/nuxt-modules/eslint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233352225,"owners_count":18663259,"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":["eslint","nuxt","nuxt-module","nuxtjs"],"created_at":"2024-08-04T08:02:28.019Z","updated_at":"2025-01-10T13:34:05.405Z","avatar_url":"https://github.com/nuxt-modules.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# @nuxtjs/eslint-module\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]\n[![Codecov][codecov-src]][codecov-href]\n[![License][license-src]][license-href]\n\n\u003e ESLint module for Nuxt\n\n[📖 **Release Notes**](./CHANGELOG.md)\n\n---\n\n**Note:** This branch is for **Nuxt 3** or **Nuxt Bridge** compatible module.\nCheckout the [`nuxt2` branch](https://github.com/nuxt-community/eslint-module/tree/nuxt2) for **Nuxt 2** support.\n\n---\n\n## Requirements\n\nYou need to ensure that you have `eslint \u003e= 7` installed:\n\nWith `pnpm`\n\n```bash\npnpm add -D eslint\n```\n\nOr, with `yarn`\n\n```bash\nyarn add -D eslint\n```\n\nOr, with `npm`\n\n```bash\nnpm install -D eslint\n```\n\n## Setup\n\n1. Add `@nuxtjs/eslint-module` dependency to your project\n\nWith `pnpm`\n\n```bash\npnpm add -D @nuxtjs/eslint-module\n```\n\nOr, with `yarn`\n\n```bash\nyarn add -D @nuxtjs/eslint-module\n```\n\nOr, with `npm`\n\n```bash\nnpm install -D @nuxtjs/eslint-module\n```\n\n2. Add `@nuxtjs/eslint-module` to the `modules` section of `nuxt.config.ts`\n\n```js\nexport default defineNuxtConfig({\n  modules: [\n    // Simple usage\n    '@nuxtjs/eslint-module',\n\n    // With options\n    ['@nuxtjs/eslint-module', { /* module options */ }]\n  ]\n})\n```\n\n### Using top level options\n\n```js\nexport default defineNuxtConfig({\n  modules: [\n    '@nuxtjs/eslint-module'\n  ],\n  eslint: {\n    /* module options */\n  }\n})\n```\n\n## Options\n\nYou can pass [eslint options](https://eslint.org/docs/latest/integrate/nodejs-api#-new-eslintoptions).\n\nNote that the config option you provide will be passed to the `ESLint` class.\nThis is a different set of options than what you'd specify in `package.json` or `.eslintrc`.\nSee the [eslint docs](https://eslint.org/docs/latest/integrate/nodejs-api#-new-eslintoptions) for more details.\n\n### `cache`\n\n- Type: `Boolean`\n- Default: `true`\n\n**Note**: The cache is enabled by default to decrease execution time.\n\n### `include`\n\n- Type: `String|Array[String]`\n- Default: `[nuxt.options.srcDir.'/**/*.{js,jsx,ts,tsx,vue}']`\n\nSpecify directories, files, or globs.\n\n### `exclude`\n\n- Type: `Array[String]`\n- Default: `['**/node_modules/**', nuxt.options.buildDir]`\n\nSpecify the files and/or directories to exclude.\n\n### `eslintPath`\n\n- Type: `String`\n- Default: `eslint`\n\nPath to `eslint` instance that will be used for linting.\n\n### `formatter`\n\n- Type: `String|Function`\n- Default: `'stylish'`\n\nAccepts a function that will have one argument: an array of eslint messages (object).\nThe function must return the output as a string.\nYou can use official [eslint formatters](https://eslint.org/docs/user-guide/formatters/).\n\n### `lintOnStart`\n\n- Type: `Boolean`\n- Default: `true`\n\nCheck all matching files on project startup, too slow, turn on discreetly.\n\n### `emitWarning`\n\n- Type: `Boolean`\n- Default: `true`\n\nThe warnings found will be printed.\n\n### `emitError`\n\n- Type: `Boolean`\n- Default: `true`\n\nThe errors found will be printed.\n\n### `failOnWarning`\n\n- Type: `Boolean`\n- Default: `false`\n\nWill cause the module build to fail if there are any warnings, based on `emitWarning`.\n\n### `failOnError`\n\n- Type: `Boolean`\n- Default: `false`\n\nWill cause the module build to fail if there are any errors, based on `emitError`.\n\n## Contributing\n\nYou can contribute to this module online with CodeSandBox:\n\n[![Edit @nuxtjs/robots](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/nuxt-community/eslint-module/?fontsize=14\u0026hidenavigation=1\u0026theme=dark)\n\nOr locally:\n\n1. Clone this repository\n2. Install dependencies using `pnpm install`\n3. Prepare development server using `pnpm dev:prepare`\n4. Build module using `pnpm build`\n5. Launch playground using `pnpm dev`\n\n## License\n\n[MIT License](./LICENSE)\n\nCopyright (c) Nuxt Community\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/eslint-module/latest.svg\n[npm-version-href]: https://npmjs.com/package/@nuxtjs/eslint-module\n\n[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/eslint-module.svg\n[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/eslint-module\n\n[github-actions-ci-src]: https://github.com/nuxt-community/eslint-module/workflows/ci/badge.svg\n[github-actions-ci-href]: https://github.com/nuxt-community/eslint-module/actions?query=workflow%3Aci\n\n[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/eslint-module.svg\n[codecov-href]: https://codecov.io/gh/nuxt-community/eslint-module\n\n[license-src]: https://img.shields.io/npm/l/@nuxtjs/eslint-module.svg\n[license-href]: https://npmjs.com/package/@nuxtjs/eslint-module\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt-modules%2Feslint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuxt-modules%2Feslint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt-modules%2Feslint/lists"}