📄 Decide specification of main exports

[StewEucen]

Overview

• Decide specification of main exports

Note

• I consider this structure of main-exports.

// index.js (main of package.json)

const initials = require('./rules/initials')
const standard = require('./rules/standard')

/**
 * @type {ESLintDefaultRules}
 */
module.exports = {
  initials,
  standard,
}

/**
 * @typedef {{
 *   [x: string]: Array<*> // FIXME: fulfill `*` actually
 * }} ESLintDefaultRules 
 */

• The value to be exported should be an object, but it is preferable not to nest properties.

// ❌
module.exports = {
  standard: {
    initials,
    stylistic,
  },
}

// ✅
module.exports = {
  initials,
  stylistic,
  standard,
}

• initials is unnecessary, because @stylistic includes initials

module.exports = {
  initials,
  stylistic,
  standard,
}

Decision Spec

• As ESM

// index.js (main of package.json)
export core from './rules/core'
export plugins from './rules/plugins'

// ./rules/plugins.js
export stylistic from './stylistic'
export jest from './jest'
export jsdoc from './jsdoc'

// ./rules/plugins/stylistic.js
export js from './js'
export plus from './plus'

// types.js
/**
 * @typedef {{
 *   [x: string]: Array<*> // FIXME: fulfill `*` actually
 * }} ESLintDefaultRules 
 */

Should all rules be handled in this repository or not?

• Not. Because this repository is just haystacks to be cut for other ESLint config package.

[StewEucen]

About non-stylistic Rules

• We named it essentials (Essential Rules)

[StewEucen]

• Complete to decide spec of this package