{"id":19733,"library":"eslint-plugin-eggache","title":"eslint-plugin-eggache","description":"Custom ESLint plugin for enforcing best practices in Egg.js applications. Version 2.0.0, stable maintenance. It provides rules to catch common mistakes like overriding module.exports/exports, unexpected keys in plugin.js, and leftover .only in tests. Differentiates from generic ESLint rules by being specifically tailored to Egg.js conventions. Released under the Egg.js organization.","status":"active","version":"2.0.0","language":"javascript","source_language":"en","source_url":"ssh://git@github.com/eggjs/eslint-plugin-eggache","tags":["javascript"],"install":[{"cmd":"npm install eslint-plugin-eggache","lang":"bash","label":"npm"},{"cmd":"yarn add eslint-plugin-eggache","lang":"bash","label":"yarn"},{"cmd":"pnpm add eslint-plugin-eggache","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency for ESLint plugin functionality","package":"eslint","optional":false}],"imports":[{"note":"ESLint plugins are specified as names in config, not imported directly.","wrong":"require('eslint-plugin-eggache')","symbol":"plugin","correct":"module.exports.plugins = ['eggache']"},{"note":"Must prefix with 'plugin:' when using extends.","wrong":"extends: ['eggache/recommended']","symbol":"config with extends","correct":"extends: ['plugin:eggache/recommended']"},{"note":"Rules must be prefixed with the plugin name.","wrong":"'no-override-exports': ['error']","symbol":"rule 'no-override-exports'","correct":"'eggache/no-override-exports': ['error']"}],"quickstart":{"code":"// .eslintrc.cjs\nmodule.exports = {\n  plugins: ['eggache'],\n  extends: ['plugin:eggache/recommended'],\n  rules: {\n    'eggache/no-only-tests': 'error',\n  },\n};","lang":"javascript","description":"Basic ESLint configuration enabling eggache plugin with recommended rules and custom no-only-tests rule."},"warnings":[{"fix":"Run npm i eslint-plugin-eggache --save-dev","message":"Plugin must be installed as dev dependency: npm i eslint-plugin-eggache --save-dev","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Use extends: ['plugin:eggache/recommended']","message":"When using extends, must prefix with 'plugin:': extends: ['plugin:eggache/recommended']","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Use 'eggache/no-override-exports' in rules object","message":"Rule names must be prefixed with plugin name: 'eggache/no-override-exports'","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Use 'eggache/no-override-exports': ['error', true] to enable for all files","message":"The no-override-exports rule by default only checks config files; set option true to check all files.","severity":"gotcha","affected_versions":">=0.0.0"}],"env_vars":null,"search_vec":"'/exports,':30 '2.0.0':16 'applic':14 'best':10 'catch':23 'common':24 'convent':51 'custom':5 'differenti':40 'egg.js':13,50,55 'eggach':4 'enforc':9 'eslint':2,6,43 'eslint-plugin-eggach':1 'generic':42 'javascript':57 'key':32 'leftov':36 'like':26 'mainten':18 'mistak':25 'module.exports':29 'module.exports/exports,':28 'organ':56 'overrid':27 'plugin':3,7 'plugin.js':34 'practic':11 'provid':20 'releas':52 'rule':21,44 'specif':47 'stabl':17 'tailor':48 'test':39 'unexpect':31 'version':15","created_at":"2026-04-25T11:19:21.951852+00:00","updated_at":"2026-04-25T11:19:21.951852+00:00","problems":[{"fix":"Run npm install eslint-plugin-eggache --save-dev","cause":"Missing installation of eslint-plugin-eggache","error":"Failed to load plugin 'eggache': Cannot find module 'eslint-plugin-eggache'"},{"fix":"Change extends to 'plugin:eggache/recommended'","cause":"Missing 'plugin:' prefix in extends","error":"ESLint configuration error: Unable to load config 'eggache/recommended'"},{"fix":"Use 'eggache/no-override-exports' as rule name","cause":"Missing plugin name prefix in rule key","error":"Definition for rule 'no-override-exports' was not found"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":"","cli_version":null,"type":"library","homepage":null,"github":"https://github.com/eggjs/eslint-plugin-eggache","docs":null,"changelog":null,"pypi":null,"npm":"https://www.npmjs.com/package/eslint-plugin-eggache","openapi_spec":null,"status_page":null,"smithery":null,"categories":["testing"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-17","next_check":"2026-07-24","install_tag":null}}