eslint-config-bananass/src/rules/stylistic.js

ESLint Config for Bananass Framework.🍌

/**
 * @fileoverview This file follows:
 *
 * - The best practices outlined in `eslint-config-airbnb-base@19.0.4`.
 *   - @see https://github.com/airbnb/javascript/tree/eslint-config-airbnb-v19.0.4/packages/eslint-config-airbnb-base/rules
 */

// --------------------------------------------------------------------------------
// Import
// --------------------------------------------------------------------------------

import { stylistic as stylisticPluginModule } from '../plugins/index.js';

// --------------------------------------------------------------------------------
// Typedef
// --------------------------------------------------------------------------------

/**
 * @import { ESLint, Linter } from "eslint";
 */

// --------------------------------------------------------------------------------
// Export
// --------------------------------------------------------------------------------

/** @type {{'@stylistic': ESLint.Plugin}} */
export const stylisticPlugin = { '@stylistic': stylisticPluginModule };

/** @type {Linter.RulesRecord} */
export const stylisticRules = {
  /**
   * Enforce consistency of spacing after the start of a comment `//` or `/*`.
   * @see https://eslint.style/rules/spaced-comment (@stylistic)
   * @see https://github.com/airbnb/javascript/blob/eslint-config-airbnb-v19.0.4/packages/eslint-config-airbnb-base/rules/style.js#L499-L509 (airbnb-base)
   */
  '@stylistic/spaced-comment': [
    'error',
    'always',
    {
      line: { exceptions: ['-', '+'], markers: ['=', '!', '/'] },
      block: { exceptions: ['-', '+'], markers: ['=', '!', ':', '::'], balanced: true },
    },
  ],
};