mirror of
https://github.com/zulip/zulip.git
synced 2025-11-10 17:07:07 +00:00
docs: Apply bullet style changes from Prettier.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
(cherry picked from commit 915884bff7)
This commit is contained in:
committed by
Tim Abbott
parent
5ae8fe292d
commit
0147c6adce
@@ -27,7 +27,7 @@ setdefault(key: K, value: V): V {
|
||||
|
||||
The following resources are valuable for learning TypeScript:
|
||||
|
||||
* The main documentation on [TypeScript syntax][typescript-handbook].
|
||||
- The main documentation on [TypeScript syntax][typescript-handbook].
|
||||
|
||||
|
||||
## Type checking
|
||||
@@ -49,11 +49,11 @@ we plan to start with a style that is closer to the existing
|
||||
JavaScript code, so that we can easily migrate individual modules
|
||||
without too much code churn. A few examples:
|
||||
|
||||
* TypeScript generally prefers explicit `return undefined;`, whereas
|
||||
- TypeScript generally prefers explicit `return undefined;`, whereas
|
||||
our existing JavasScript style uses just `return;`.
|
||||
* With TypeScript, we expect to make heavy use of `let` and `const`
|
||||
- With TypeScript, we expect to make heavy use of `let` and `const`
|
||||
rather than `var`.
|
||||
* With TypeScript/ES6, we may no longer need to use `_.each()` as our
|
||||
- With TypeScript/ES6, we may no longer need to use `_.each()` as our
|
||||
recommended way to do loop iteration.
|
||||
|
||||
For each of the details, we will either want to bulk-migrate the
|
||||
@@ -71,13 +71,13 @@ converts them from JS to TS.
|
||||
Our plan is to order which modules we migrate carefully, starting with
|
||||
those that:
|
||||
|
||||
* Appear frequently as reverse dependencies of other modules
|
||||
- Appear frequently as reverse dependencies of other modules
|
||||
(e.g. `people.js`). These are most valuable to do first because
|
||||
then we have types on the data being interacted with by other
|
||||
modules when we migrate those.
|
||||
* Don't have large open pull requests (to avoid merge conflicts); one
|
||||
- Don't have large open pull requests (to avoid merge conflicts); one
|
||||
can scan for these using [TinglingGit](https://github.com/zulip/TinglingGit).
|
||||
* Have good unit test coverage, which limits the risk of breaking
|
||||
- Have good unit test coverage, which limits the risk of breaking
|
||||
correctness through refactoring. Use
|
||||
`tools/test-js-with-node --coverage` to get a coverage report.
|
||||
|
||||
@@ -85,14 +85,14 @@ When migrating a module, we want to be especially thoughtful about
|
||||
putting together a commit structure that makes mistakes unlikely and
|
||||
the changes easy to verify. E.g.:
|
||||
|
||||
* First a commit that just converts the language to TypeScript adding
|
||||
- First a commit that just converts the language to TypeScript adding
|
||||
types. The result may potentially have some violations of the
|
||||
long-term style we want (e.g. not using `const`). Depending on how
|
||||
we're handling linting, we set some override eslint rules at the top
|
||||
of the module at this stage so CI still passes.
|
||||
* Then a commit just migrating use of `var` to `const/let` without
|
||||
- Then a commit just migrating use of `var` to `const/let` without
|
||||
other changes (other than removing any relevant linter overrides).
|
||||
* Etc.
|
||||
- Etc.
|
||||
|
||||
With this approach, we should be able to produce a bunch of really
|
||||
simple commits that can be merged the same day they're written without
|
||||
|
||||
Reference in New Issue
Block a user