Kk/linting+prettier #41

krzkaczor · 2018-11-10T20:53:10Z

What's inside:

autoformatting with prettier (in few places in tests we used fixtures and I used // prettier-ignore to ignore these pieces b/c they are looking better in single lines)
tslint ruleset
npm run test runs linting + tests
npm run test:fix runs linting in autofix mode
use test:fix during development and test on CI

Notes:

Prettier uses similar settings as standardjs (personally i dont care about semicolons and quotes)
Prettier was used to format MD files into consistent format as well
Tslint disallows var. const is prefered but you can use let when reassignment is needed
We can enfore even more rules with tslint - please add you comments

coveralls · 2018-11-10T20:58:27Z

Coverage increased (+0.1%) to 87.826% when pulling a747c77 on kk/linting+prettier into d1272cc on typescript.

GrandSchtroumpf · 2018-11-11T14:48:18Z

Personally, I'm in favor of semicolons at the end of a statement. Especially with Typescript, which aimed to help C# engineers to write Javascript code.

holgerd77 · 2018-11-12T11:52:50Z

@GrandSchtroumpf @krzkaczor Ah, sorry, that's one of the few things where I can't make any compromises. We have non-semicolon code style in all our libraries, and this is a highly opinionated thing and also not really related to TypeScript (one very well finds articles on both sides when googling for best practices), so it wouldn't be fair to side-introduce this here and overrule the implicit and explicit convention of various contributors who have agreed on this.

If someone on the current team is reading this, please also feel free to comment!

.prettierrc

holgerd77

Ok, I am through with a first round, discussioning the explicitly introduced options.

We should do a second iteration here and:
a) Also have at least some look on the TypeStrict (what a name 😄) settings implicitly introduced here
b) have one thought/fly over the rules not introduced in this PR (so I would encourage everyone to have some look at the rules doc pages for Prettier and TSLint and have some one-step-back thought on what would eventually make sense)

.prettierrc

holgerd77 · 2018-11-12T12:05:51Z

.prettierrc

+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "proseWrap": "always"


I just switched my own behavior (actually last week 😄) to not introduce line-breaks in md or rst any more, since this becomes less readable e.g. on mobile devices and one can always activate soft-wrap on editor, so I would be in favor not to break, no strong opinion on this though.

It doesnt change the rendered output though right? Could you play with these settings locally and let me know what do you prefer? https://prettier.io/docs/en/options.html#prose-wrap

Just tried locally, the current setting wraps markdown on the (extended 😄) print width. E.g. on my laptop (13 inch) editor window this already gives super-suboptimal results, so please let's remove this and keep the default as-is setting.

I am just realizing that THIS is actually what this printWidth setting from above is about (I have interpreted this as just being for printing out code on a printer, hehe 😄). So this already clashes with my personal setup. I know that I am not the norm, but I think it should be possible to pretty-view the code on a relatively standard setup (13'' MacBook Air, Atom Editor, Full Screen), and Atom is actually also by standard displaying this 80 characters line.

So on a second thought I would want to change that, either keep the default and let the outer system decide on when to go larger here, or we could maybe go 10 characters longer if this helps. But this setting is killing it for too many people working on a laptop.

okay i removed this setting

tslint.json

holgerd77 · 2018-11-12T12:16:09Z

tslint.json

+    "prefer-const": true,
+    "no-var-keyword": true,
+    "interface-name": [true, "never-prefix"],
+    "no-commented-code": true,


Again, don't find this rule in the docs.

It's defined here: https://github.com/SonarSource/SonarTS

If these rules are defined "somewhere" around in the ecosystem, how come that they are included in the generic TS code base? Or did you add dependencies for that?

These additional rulesets are part of typestrict so tslint just finds them 🤷‍♂️ I agree that we could add them to dev deps as well...

Generally I think this rule make sense, commented out code (side node: this rule would be self-descriptive if just named "no-commented-out-code", just another reminder on how important names are) tends to very much be left and float around forever and putting additional noise to the code base.

Ah no, don't let's bloat up the dev dependencies on this, but we should find ways to make the fact transparent that rules are also coming from there.

Actually I will start on an organizational ReadTheDocs documentation on the organization repo in the coming days, including things like contribution guidelines and also some tech standards.

I will also include a TypeScript section there and try to extract from here the common set of practices and tools we agreed upon. This guide can the referenced from the various repos.

(ah, and maybe to the point: we can add some additional explanation on TypeStrict there as well.)

Yeah, I will update the readme of typestrict.

tslint.json

krzkaczor · 2018-11-13T08:14:47Z

@holgerd77 just to clarify, I am the creator of TypeStrict (i love the name 😆). Idea behind this project is to bring rules that are hard to argue with — not enforcing the code style but rather finding bugs. I am happy to discuss any chosen rule, they are described in the readme.

holgerd77 · 2018-11-13T09:57:30Z

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "printWidth": 120,


Can we please change the setting here as well (see my comment below on proseWrap)?

(ah, you are probably in-the-works, seems you are making very incremental pushes 😄)

Soooo, should i make it 80 then? what about 100 at least 🤣

holgerd77

Looks good, thanks so much Chris for the work done here!

krzkaczor requested review from holgerd77 and GrandSchtroumpf November 10, 2018 20:53

holgerd77 reviewed Nov 12, 2018

View reviewed changes

.prettierrc Outdated Show resolved Hide resolved

holgerd77 suggested changes Nov 12, 2018

View reviewed changes

krzkaczor force-pushed the kk/linting+prettier branch from fbe3583 to 9a2e7f8 Compare November 13, 2018 09:51

holgerd77 reviewed Nov 13, 2018

View reviewed changes

krzkaczor added 3 commits November 13, 2018 11:12

add liting and formatting tools and configs

ae43927

tslint fixes

7fee55a

reformat the project

a747c77

krzkaczor force-pushed the kk/linting+prettier branch from 44f79ba to a747c77 Compare November 13, 2018 10:13

holgerd77 approved these changes Nov 13, 2018

View reviewed changes

holgerd77 merged commit 507fbd3 into typescript Nov 13, 2018

holgerd77 deleted the kk/linting+prettier branch November 13, 2018 10:26

holgerd77 mentioned this pull request Dec 13, 2018

Increase print width to 100 on Prettier settings ethereumjs/ethereumjs-config#4

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Kk/linting+prettier #41

Kk/linting+prettier #41

krzkaczor commented Nov 10, 2018 •

edited

Loading

coveralls commented Nov 10, 2018 •

edited

Loading

GrandSchtroumpf commented Nov 11, 2018

holgerd77 commented Nov 12, 2018

holgerd77 left a comment

holgerd77 Nov 12, 2018

krzkaczor Nov 13, 2018

holgerd77 Nov 13, 2018 •

edited

Loading

krzkaczor Nov 13, 2018

holgerd77 Nov 12, 2018

krzkaczor Nov 13, 2018

holgerd77 Nov 13, 2018

krzkaczor Nov 13, 2018

holgerd77 Nov 13, 2018

holgerd77 Nov 13, 2018

holgerd77 Nov 13, 2018

krzkaczor Nov 13, 2018

krzkaczor commented Nov 13, 2018 •

edited

Loading

holgerd77 Nov 13, 2018

holgerd77 Nov 13, 2018

krzkaczor Nov 13, 2018

holgerd77 left a comment

Kk/linting+prettier #41

Kk/linting+prettier #41

Conversation

krzkaczor commented Nov 10, 2018 • edited Loading

coveralls commented Nov 10, 2018 • edited Loading

GrandSchtroumpf commented Nov 11, 2018

holgerd77 commented Nov 12, 2018

holgerd77 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holgerd77 Nov 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krzkaczor commented Nov 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holgerd77 left a comment

Choose a reason for hiding this comment

krzkaczor commented Nov 10, 2018 •

edited

Loading

coveralls commented Nov 10, 2018 •

edited

Loading

holgerd77 Nov 13, 2018 •

edited

Loading

krzkaczor commented Nov 13, 2018 •

edited

Loading