Registry / testing / eslint-plugin-sweepit

eslint-plugin-sweepit

JSON →
library0.0.23jsnpmunverified

Opinionated architectural ESLint rules for TypeScript projects with React support. Current stable version 0.0.23, updated irregularly. Ships type definitions. Requires ESLint ^9.0.0 and TypeScript >=5.0.0. Key differentiators: prescriptive flat configs (core and React) that bundle recommended TypeScript-ESLint rules, functional programming rules, and custom rules for naming conventions (e.g., no TitleCase/titleCase props, no custom kebab-case props, restrict set* prefix to useState setters). Automatically enables TypeScript project service for type-aware rules. Focused on enforcing consistent prop naming and architectural boundaries.

testing
npm install eslint-plugin-sweepit
package ↗
INSTALL
IMPORT
SIG · ESLINT-PLUGIN-SWEE
E
eslint-plugin-sweepit
testingjavascriptv0.0.23
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

default
✓ import sweepit from 'eslint-plugin-sweepit'
✗ const sweepit = require('eslint-plugin-sweepit')
ESM-only package with default export of plugin object. No CommonJS support.
configs
✓ import sweepit from 'eslint-plugin-sweepit'; sweepit.configs.core
✗ import { configs } from 'eslint-plugin-sweepit'
configs is accessed via the default export, not a named export.
rules
✓ import sweepit from 'eslint-plugin-sweepit'; sweepit.rules['no-array-props']
✗ import { rules } from 'eslint-plugin-sweepit'
Rules are properties on the default export object, not standalone exports.

Shows how to set up eslint-plugin-sweepit with flat config, including core and React configs and rule overrides.

// eslint.config.js import sweepit from 'eslint-plugin-sweepit'; export default [ ...sweepit.configs.core, ...sweepit.configs.react, { rules: { 'sweepit/no-array-props': 'warn', 'sweepit/no-prefixed-prop-bundles': ['error', { threshold: 4 }], }, }, ];
Debug
Known issues
breakingESLint 9 flat config required. Legacy .eslintrc format is not supported.
fix
Migrate to flat config (eslint.config.js). See ESLint migration guide.
affects: >=0.0.0
gotchaconfigs.core and configs.react enable TypeScript projectService by default, which can slow down linting on large projects.
fix
Disable projectService in parserOptions if performance is an issue: set parserOptions.projectService to false.
affects: >=0.0.0
deprecatedRule naming may change in future major versions; currently uses kebab-case in the rule key but title-case in documentation references.
fix
Use consistent kebab-case rule keys as specified in the plugin.
affects: 0.0.x
Errors
Common errors & fixes
Failed to load plugin 'eslint-plugin-sweepit': Cannot find module 'eslint-plugin-sweepit'
Package not installed or missing dependencies.
fix
Run `npm install --save-dev eslint-plugin-sweepit eslint typescript`.
ESLint couldn't determine the plugin for rule 'sweepit/no-array-props'
Plugin not included in flat config or loaded incorrectly.
fix
Import sweepit and spread configs into the config array: `import sweepit from 'eslint-plugin-sweepit'; export default [...sweepit.configs.core];`
TypeError: Cannot read properties of undefined (reading 'core')
Default export used incorrectly (e.g., named import).
fix
Use default import: `import sweepit from 'eslint-plugin-sweepit';`.
Upgrade
Version history
0.0.23latest on npm
Audit
Dependencies
eslintrequiredpeer dependency required for plugin to work
typescriptrequiredpeer dependency required for TypeScript rules and type information
Agent activity
4 hits · last 30 days
node
4
Resources
packagehttps://www.npmjs.com/package/eslint-plugin-sweepit ↗
eslint-plugin-sweepit — npm install eslint-plugin-sweepit · libregistry