ESLint Config for RPG Maker

This is a shareable ESLint configuration that enforces a consistent coding style and best practices. It's designed for creating RPG Maker plugins and includes all global variables for both RPG Maker MV and RPG Maker MZ within and is designed to be used within our @fenixengine ecosystem.

Installation

All ESLint plugins are included as dependencies of this config, so you don’t need to install them manually.

First, install ESLint and our config:

npm install -D eslint eslint-config-rpgmaker

Usage

Create an .eslintrc.js file in your project and extend this config:

import eslintRpgmaker from '@fenixengine/eslint-rpgmaker-config';

export default [
  eslintRpgmaker,
];

Included Rules

This config includes rules from:

eslint-plugin-n: Best practices for Node.js

eslint-plugin-import: Helps with managing imports

eslint-plugin-js (recommended): Base ESLint rules

Recommended Extensions

For best results, install the ESLint extension for your editor (e.g., VS Code) and enable auto-fixing on save.

Running ESLint

Run ESLint manually with:

npx eslint . --fix

This will lint all files in the project and automatically fix common issues.

License

MIT