ESLint Plugin SUI (Sistema Único de Información)

1.14.0 verified Fri May 01 auth: no javascript

ESLint plugin providing a set of custom lint rules for projects following SUI standards. Version 1.14.0 supports ESLint >=7 and Node.js ^14.17.0 || ^16.0.0 || >=18.0.0. This plugin is designed to enforce coding conventions specific to SUI-based development. It is released on an irregular cadence and lacks comprehensive documentation for rules and configurations, which are marked as TODO. Compared to generic ESLint plugins, it is narrowly focused on SUI-specific patterns.

Common errors

error Error: Failed to load plugin 'sui' declared in '.eslintrc': Cannot find module 'eslint-plugin-sui' ↓

cause Missing local installation of eslint-plugin-sui.

fix

Run npm install eslint-plugin-sui --save-dev

error Error: Cannot find module 'eslint-plugin-sui' ↓

cause Plugin not installed or node_modules not present.

fix

Ensure eslint-plugin-sui is in package.json devDependencies and run npm install.

Warnings

gotcha Plugin rules and configs are underdocumented; the README contains TODO placeholders for generated documentation. ↓

fix Inspect the plugin source code (node_modules/eslint-plugin-sui) to discover available rules and configs.

gotcha ESM import may fail in older Node versions due to lack of proper ESM/CJS dual packaging; use require() if using CommonJS. ↓

fix Use require() instead of import for versions <1.0.

breaking Peer dependency on eslint >=7; incompatible with older ESLint versions. ↓

fix Upgrade ESLint to version 7 or later.

Install

npm install eslint-plugin-sui

yarn add eslint-plugin-sui

pnpm add eslint-plugin-sui

Imports

plugin
wrong
```
const eslintPluginSui = require('eslint-plugin-sui')
```
correct
```
import eslintPluginSui from 'eslint-plugin-sui'
```
The package does not export a default CommonJS object; use ESM import or dynamic import().

rules

wrong

const rules = require('eslint-plugin-sui').rules

correct

import { rules } from 'eslint-plugin-sui'

Named export 'rules' is available for programmatic access since v1.0.

configs
```
import { configs } from 'eslint-plugin-sui'
```
Configs may not be populated; see README TODO. Check package contents.

Quickstart

Shows how to configure eslint-plugin-sui in .eslintrc.js or package.json to enable custom SUI lint rules.

// .eslintrc.js
module.exports = {
  plugins: ['sui'],
  rules: {
    'sui/rule-name': 'error'
  }
};

// Or in package.json:
{
  "eslintConfig": {
    "plugins": ["sui"],
    "rules": {
      "sui/rule-name": 2
    }
  }
}