search

ni / javascript-styleguide

JavaScript and TypeScript Style Guide
MIT License
8 stars 9 forks source link

Language configuration is confusing #126

Open TrevorKarjanis opened 1 year ago

TrevorKarjanis commented 1 year ago

The following feedback was given for configuring a new Angular application with linting.

I wasn't sure which linters to configure. Are we meant to configure linters for JavaScript, Typescript, and Angular, or is just Angular sufficient? I think I eventually figured out that I need to configure Angular and JavaScript (as the Angular config talks about removing the TypeScript config, but I got hung up on this for a while). I think we could clarify this step.

Fix

  1. Clarify in the docs that the TS and Angular configurations include the TypeScript and JavaScript configs.
  2. Add an override for *.js to the docs for the Angular configuration
  3. Update the docs to mention the need to add something like this to angular.json (after verifying that it's necessary for our current version of Angular) 
         "lintFilePatterns": [
          "src/**/*.ts",
          "src/**/*.html",
          "acceptance-tests/**/*.ts",
          "acceptance-tests/**/*.js"
        ]
jattasNI commented 11 months ago

I split off config changes to #127 so now this should be a doc change that's relatively easy to knock out.