Skip to content

Instantly share code, notes, and snippets.

@bpmutter
Last active November 5, 2022 20:14
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save bpmutter/9693dc10b7fb6caae144208f38fad9bf to your computer and use it in GitHub Desktop.
Save bpmutter/9693dc10b7fb6caae144208f38fad9bf to your computer and use it in GitHub Desktop.
NOTES - ESLint Overviews in user documentation page introductions

Notes for - eslint/eslint#16473

pages that need intro refactor:

  • Configuring
    • refine current intro blurb to talk more about why you want to configure eslint. what the idea of configuring means
  • Configuration Files (New)
    • include some information about how configuration file contains different rules/plugins
  • Configuration Files
    • add same general content ot Configuration Files (New)
    • maybe borrow some content from the Configuration Files (New). right now there's really no introductory text on this page
  • Configuring Language Options
    • add a small blurb at top of the page talking about how this page explains the various ways that you can deal with the different 'flavors' of javascript. runtimes, versions, global variables for those environments, features
  • Configuring Rules
    • add one/two sentences at top of the page introducing.
  • Configuring Plugins
    • explain what this page covers: how you can plugins to your project, eslint stuff created by others.
    • consider noting that provides some specific info about two important plugin types, parsers and processors
  • Ignoring Code
    • before 1st section state:
      • you can configure eslint to ignore code
      • can do glob pattern matching, specific files
      • why you might want to do this? (i cant think of why off the top of my head, but surely there are many good reasons)

RESUME @ https://eslint.org/docs/latest/user-guide/command-line-interface

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment