Activity

1. Don Jayamanne (DonJayamanne)

   added

   needs PR

   debtCode quality issuesCode quality issues

   on Jan 16, 2019
2. Don Jayamanne (DonJayamanne)

   changed the title [-]Code formatting for typescript code[/-] [+]Spike Code formatting for typescript code[/+] on Jan 16, 2019
3. Brett Cannon (brettcannon)

   added this to the 2019 - June Sprint 13 milestone on Jun 26, 2019
4. Kim-Adeline Miguel (kimadeline)

   self-assigned this

   on Jul 8, 2019
5. kimadeline commented on Jul 9, 2019

   

   Kim-Adeline Miguel (kimadeline)

   on Jul 9, 2019

   More actions

   How to integrate

   • npm i prettier --save-dev
   • vscode prettier extension: esbenp.prettier-vscode
   • extra rules:
     • .prettierrc: "singleQuote": true
     • workspace settings:
       • "prettier.tslintIntegration": true
       • "editor.formatOnSave": true
   • update the readme 📜

   npm scripts

   • formatting: "prettier:format": "prettier --write '{src,uitests}/**/*.{ts,tsx,js,css}'"
   • dry run: "prettier:check": "prettier --check '{src,uitests}/**/*.{ts,tsx,js,css}'"
   • either include folders in the run command, or specify files/folders to ignore in a .prettierignore file

   Committing

   📚 Precommit hooks documentation: https://prettier.io/docs/en/precommit.html

   • git bash scripts (pre- and post-commit hooks)
   • precise-commits (for formatting staged lines only instead of the entire file), more info at https://github.com/nrwl/precise-commits#why-precise-commits

   CI checks

   See #6501 for an example of a formatting check job

   Code formatting

   • Doing a full pass at once
     • ✅ covers everything at once
     • ✅ CI command is simpler (can just do a sweep of the repo)
     • ❌ there will be one "formatting" commit in the commit history
     • ❌ may cause merge conflicts with people's current work (hopefully only once)
   • Checking only changed files
     • ✅ no commit history pollution and no merge conflicts when integrating it in people's daily workflow
     • ❌ requires an extra tool for CI to only verify changed files (use one of the pre-commit hook solutions)
     • ❌ noise in PRs
6. kimadeline commented on Jul 9, 2019

   

   Kim-Adeline Miguel (kimadeline)

   on Jul 9, 2019

   More actions

   Work to be done listed here: #2012
7. Kim-Adeline Miguel (kimadeline)

   closed this as completedon Jul 9, 2019
8. ghost removed

   needs PR

   on Jul 9, 2019
9. lock

   locked as resolved and limited conversation to collaborators on Jul 16, 2019