https://github.com/tasshi-me/eslint-plugin-roro

An ESLint plugin to follow the RORO (Receive an Object, Return an Object) pattern.
https://github.com/tasshi-me/eslint-plugin-roro

eslint eslint-plugin eslintplugin roro

Last synced: 2 months ago
JSON representation

An ESLint plugin to follow the RORO (Receive an Object, Return an Object) pattern.

• Host: GitHub
• URL: https://github.com/tasshi-me/eslint-plugin-roro
• Owner: tasshi-me
• License: mit
• Created: 2024-12-06T15:52:06.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-04-08T02:44:20.000Z (2 months ago)
• Last Synced: 2025-04-10T00:09:07.899Z (2 months ago)
• Topics: eslint, eslint-plugin, eslintplugin, roro
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/eslint-plugin-roro
• Size: 249 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-roro

[![npm version](https://badge.fury.io/js/eslint-plugin-roro.svg?icon=si%3Anpm)](https://badge.fury.io/js/eslint-plugin-roro)

[![CI](https://github.com/tasshi-me/eslint-plugin-roro/actions/workflows/ci.yml/badge.svg)](https://github.com/tasshi-me/eslint-plugin-roro/actions/workflows/ci.yml)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

> This plugin provide rules to enforce the [RORO](https://medium.com/free-code-camp/elegant-patterns-in-modern-javascript-roro-be01e7669cbd) (Receive an Object, Return an Object) pattern.

## Usage

```shell

npm i -D eslint-plugin-roro

```

```javascript

// eslint.config.mjs

import eslintPluginRORO from "eslint-plugin-roro";

export default [eslintPluginRORO.configs.recommended];

```

## Rules

| Name                                           | Description                                        |

| ---------------------------------------------- | -------------------------------------------------- |

| [receive-object](docs/rules/receive-object.md) | Enforce functions to receive only a single object. |

| [return-object](docs/rules/return-object.md)   | Enforce functions to return an object.             |

## License

[MIT](LICENSE)