-
Notifications
You must be signed in to change notification settings - Fork 46
Open
Description
Taking a look at the state of the codebase, I'd like to recommend the following changes:
- Drop any use of stage-2 or lower JS syntax (e.g., the bind operator
::). We shouldn't use any JS that isn't guaranteed to one day actually be valid syntax. - Configure
babel-envto useshippedProposals: true, which should replace most of the one-off babel plugins. - Change the formatting to use two (2) spaces instead of four (4), and use semicolons, which is the most typical/popular way of formatting JS.
- Adopt
prettier,eslint-plugin-prettier,huskyandlint-stagedto perform automatic formatting and fixing as a pre-commit hook. This should eliminate any further fussing about formatting in future discussions or code reviews. - (Re-)write all docstrings as TypeScript-compatible JSDoc and use
tscas a type-checker. This will give us the types from TypeScript and DefinitelyTyped, but does not demand we rewrite the project in TS. We're taking this approach in Appium and I've found it works well. This shouldn't conflict with what we're doing to generate typings, as much of the API seems to be automatically generated from a swagger doc. However, this will likely require a few refactors to keep TS happy (e.g., you cannot return anything from a constructor other thanthis, so we'll need to find a different way to accomplish the same thing).
PhearZero
Metadata
Metadata
Assignees
Labels
No labels