feat: add betterer #8045

pvinis · 2023-01-25T02:00:14Z

This PR resolves []

Description

remove danger (it has served us well. thank you 🙇)
add betterer (https://phenomnomnominal.github.io/betterer/docs/betterer/, https://github.com/phenomnomnominal/betterer)
move all rules from danger to betterer
add some more rules
move some config out of package.json (lint-staged and prettier)

try it out for yourself, with yarn betterer:all! then try removing a jest.unmock("react-relay") or add an extra one, to see how this tool says yay and nay.

no changes

removing bad things

adding bad things (notice the tip at the end, to rerun yarn betterer:all --update in order to allow it to pass that check, in case we really need to add that one extra bad thing. its kinda like detect-secrets in that way, or jest snapshots.)

PR Checklist

I tested my changes on iOS / Android.
I added screenshots or videos to illustrate my changes.
I added Tests and Stories for my changes.
I added an app state migration.
I hid my changes behind a feature flag.
I have prefixed changes that need to be tested during a release QA with [NEEDS EXTERNAL QA] on the changelog.

To the reviewers 👀

I would like at least one of the reviewers to run this PR on the simulator or device.

Changelog updates

Cross-platform user-facing changes

iOS user-facing changes

Android user-facing changes

Dev changes

Need help with something? Have a look at our docs, or get in touch with us.

pvinis · 2023-01-25T02:01:39Z

.husky/pre-commit

@@ -3,4 +3,3 @@


 yarn lint-staged
-yarn secrets:check:staged


moved to lint-staged

pvinis · 2023-01-25T02:01:51Z

.husky/pre-push

@@ -3,3 +3,4 @@


 yarn type-check
+yarn betterer:all


one final check

pvinis · 2023-01-25T02:02:13Z

.lintstagedrc.mjs

@@ -0,0 +1,9 @@
+export default {


extracted this into a config file

pvinis · 2023-01-25T02:02:19Z

.prettierrc.cjs

@@ -0,0 +1,7 @@
+module.exports = {


extracted this into a config file

(i tried .mjs with export default but of course prettier being a bad tool doesn't support that)

pvinis · 2023-01-25T02:03:47Z

.vscode/extensions.json

@@ -1,6 +1,10 @@
 {
  // See http://go.microsoft.com/fwlink/?LinkId=827846
  // for the documentation about the extensions.json format
-  "recommendations": ["Orta.vscode-ios-common-files", "Orta.vscode-danger", "artsy.artsy-studio-extension-pack", "meta.relay"],
+  "recommendations": [


random linting

pvinis · 2023-01-25T02:04:18Z

dangerRules/useWebPs.tests.ts

-  })
-
-  it("does not the author when they add WebPs", () => {
-    useWebPs(["image1.webp", "image2.webp", "image3.webp"])


this is now a betterer rule

pvinis · 2023-01-25T02:04:47Z

dangerfile.ts

-const testOnlyFilter = (filename: string) => filename.includes(".tests") && typescriptOnly(filename)
-
-/**
- * Danger Rules


all these are now betterer rules

pvinis · 2023-01-25T02:05:03Z

package.json

@@ -7,7 +7,7 @@
    "node": "16.x",
    "yarn": "1.x"
  },
-  "main": "index.ios.js",
+  "main": "index-common.js",


random thing, but we didnt update that in a while

pvinis · 2023-01-25T02:05:37Z

src/app/Components/Artist/ArtistArtworks/CreateSavedSearchModal.tests.tsx

@@ -17,8 +17,6 @@ import {
  tracks,
 } from "./CreateSavedSearchModal"

-jest.unmock("react-relay")


that was a test for one of the betterer rules

pvinis · 2023-01-25T02:06:14Z

.betterer.results

@@ -0,0 +1,2720 @@
+// BETTERER RESULTS V2.


this file is like the .secrets.baseline file. it holds all the results, and makes sure things get.. better-er.

pvinis · 2023-01-25T02:06:37Z

.betterer.ts

+const typescriptTestFiles = ["./src/**/*.tests.ts", "./src/**/*.tests.tsx"]
+const imageExtensionsToAvoid = ["png", "jpg", "jpeg"]
+
+export default {


look at all these nice rules :)

damassi · 2023-01-25T03:58:59Z

.betterer.ts

+
+  "Avoid using class components!": () =>
+    regexp(/extends (React\.)?Component/).include(typescriptFiles),
+}


.gitignore

damassi

Looks great @pvinis - mind updating the PR with an image showing the output? Also, can you add a hyperlink to betterer in the line item in the description so readers don't have to fish.

.circleci/config.yml

package.json

damassi · 2023-01-25T04:38:03Z

package.json

-    "singleQuote": false,
-    "trailingComma": "es5",
-    "bracketSpacing": true
-  },


gkartalis

🔥 🔥 🔥 🔥

.betterer.ts

.circleci/config.yml

pvinis · 2023-01-25T10:45:38Z

added links and screenshots

gkartalis

👌👌👌👌👌👌 So much betterer

pvinis · 2023-01-25T10:53:34Z

everything addressed 👍 thanks all for reviewing! ill merge and see how we do with it :)

.circleci/config.yml

MrSltun

✨ 🔥 ❤️

pvinis added 8 commits January 25, 2023 01:28

this is great!

e1a6a30

try ci

12b1c73

class components

f4af17b

unmock

a65902c

works

21cec12

hm

6c0f3dd

this

fae1d6e

move stuff around

7218208

pvinis self-assigned this Jan 25, 2023

Delete betterer-check.yml

0b7868e

pvinis commented Jan 25, 2023

View reviewed changes

.husky/pre-commit

@@ -3,4 +3,3 @@

yarn lint-staged

yarn secrets:check:staged

Copy link

Contributor Author

pvinis Jan 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved to lint-staged

pvinis commented Jan 25, 2023

View reviewed changes

.husky/pre-push

@@ -3,3 +3,4 @@

yarn type-check

yarn betterer:all

Copy link

Contributor Author

pvinis Jan 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one final check

pvinis commented Jan 25, 2023

View reviewed changes

.lintstagedrc.mjs

@@ -0,0 +1,9 @@

export default {

Copy link

Contributor Author

pvinis Jan 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extracted this into a config file

damassi reacted with thumbs up emoji

pvinis commented Jan 25, 2023

View reviewed changes

pvinis requested review from gkartalis, MrSltun and a team January 25, 2023 02:07

strictness

9087a19

damassi reviewed Jan 25, 2023

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

damassi reviewed Jan 25, 2023

View reviewed changes

.circleci/config.yml Show resolved Hide resolved

damassi reviewed Jan 25, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

damassi reviewed Jan 25, 2023

View reviewed changes

package.json

"singleQuote": false,

"trailingComma": "es5",

"bracketSpacing": true

},

Copy link

Member

damassi Jan 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tyty

pvinis reacted with heart emoji

gkartalis reviewed Jan 25, 2023

View reviewed changes

.betterer.ts Outdated Show resolved Hide resolved

.circleci/config.yml Show resolved Hide resolved

cache and sort

9108889

ci

e0f9750

gkartalis previously approved these changes Jan 25, 2023

View reviewed changes

pvinis added 2 commits January 25, 2023 10:52

not now

19b0715

fixed

73cae93

pvinis dismissed gkartalis’s stale review via 73cae93 January 25, 2023 10:53

pvinis added Squash On Green A label to indicate that Peril should squash-merge this PR when all statuses are green and removed Squash On Green A label to indicate that Peril should squash-merge this PR when all statuses are green labels Jan 25, 2023

pvinis commented Jan 25, 2023

View reviewed changes

.circleci/config.yml Show resolved Hide resolved

Update .circleci/config.yml

bc30422

pvinis added the Squash On Green A label to indicate that Peril should squash-merge this PR when all statuses are green label Jan 25, 2023

MrSltun approved these changes Jan 25, 2023

View reviewed changes

artsy-peril bot merged commit bbf03aa into main Jan 25, 2023

artsy-peril bot deleted the pvinis/betterer branch January 25, 2023 11:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add betterer #8045

feat: add betterer #8045

pvinis commented Jan 25, 2023 •

edited

Loading

pvinis Jan 25, 2023

pvinis Jan 25, 2023

pvinis Jan 25, 2023

pvinis Jan 25, 2023 •

edited

Loading

pvinis Jan 25, 2023

pvinis Jan 25, 2023

pvinis Jan 25, 2023

pvinis Jan 25, 2023

pvinis Jan 25, 2023

pvinis Jan 25, 2023

pvinis Jan 25, 2023

damassi Jan 25, 2023

damassi left a comment •

edited

Loading

damassi Jan 25, 2023

gkartalis left a comment

pvinis commented Jan 25, 2023

gkartalis left a comment

pvinis commented Jan 25, 2023

MrSltun left a comment

feat: add betterer #8045

feat: add betterer #8045

Conversation

pvinis commented Jan 25, 2023 • edited Loading

Description

PR Checklist

To the reviewers 👀

Changelog updates

Cross-platform user-facing changes

iOS user-facing changes

Android user-facing changes

Dev changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pvinis Jan 25, 2023 • 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

damassi left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gkartalis left a comment

Choose a reason for hiding this comment

pvinis commented Jan 25, 2023

gkartalis left a comment

Choose a reason for hiding this comment

pvinis commented Jan 25, 2023

MrSltun left a comment

Choose a reason for hiding this comment

pvinis commented Jan 25, 2023 •

edited

Loading

pvinis Jan 25, 2023 •

edited

Loading

damassi left a comment •

edited

Loading