eslint-plugin-jetops-index

jetops-eslint-plugin-jetops-index

What

Show error for each declaration in index.{j|t}s file.

Why

Because it's terrible to work in a project where all the code is written in index.{j|t}s files.

Because it's terrible when you have all the opened tabs of your IDE are named index.

But because we think index files are a great way to expose only choosen elements from a module.

Examples

Examples of correct code for this rule:

// index.ts

export { namedExport } from './aFile.ts'
export { default } from './anoterFile.ts'

Examples of incorrect code for this rule:

// index.ts

export const aVariable = 'DONT DO THIS'

export function aFunction() {
  return 'THIS NEITHER'
}

class AClass {
  aMethod() {
    return 'THIS, NEITHER ONE NOR THE OTHER'
  }
}

eslint-plugin-jetops-index

This library was generated with Nx.

Running unit tests

Run nx test eslint-plugin-jetops-index to execute the unit tests via Jest.

Running lint

Run nx lint eslint-plugin-jetops-index to execute the lint via ESLint.