eslint-config-galex icon indicating copy to clipboard operation
eslint-config-galex copied to clipboard

fix readme

Open ljosberinn opened this issue 3 years ago • 1 comments

  • incremental adoption under features has no explanation other than the code example
  • standalone generation under features still refers to a --generated file which doesnt exist anymore
  • consolidate examples. there are some in collapsibles and some at the bottom, wtf

ljosberinn avatar Jun 08 '22 17:06 ljosberinn

I feel like it would be worth having a more typical usage example near the top of the README. Perhaps something that disables/modifies a couple of core ESLint rules and a couple of React rules inside a custom override:

const dependencies = getDependencies();

const customReactOverride = createReactOverride({
  ...dependencies,
  rules: {
    /* some rule overrides */
  }
});

module.exports = createConfig({
  rules: {
    /* some rule overrides */
  },
  overrides: [customReactOverride],
});

axelboc avatar Aug 09 '22 14:08 axelboc