Import relayOperationGenericsRule

[ashfurrow]

This is a work-in-progress PR to import relayOperationGenericsRule.js into this project, including a transition to TypeScript proper instead of @ts-check. It's a WIP because I ran out of time this morning. Next steps are to finish it, link it from Reaction, and get Reaction consuming the rule from a module. Then we can think about tests, too, and then add this and other eslint-plugin-relay rules to this project. And then publish to NPM. Baby steps.

See also: artsy/yeoman-generator-artsy#10

/cc @alloy

[ashfurrow-peril]

Danger run resulted in 1 warning; to find out more, see the checks page.

Generated by 🚫 dangerJS

[peril-staging]

Danger run resulted in 1 warning; to find out more, see the checks page.

Generated by 🚫 dangerJS

[ashfurrow]

Aww jeez

[alloy]

It’s customary to make these types of dependencies peer ones, although I think that’s more important when it’s a dep that will be used at runtime to ensure the app has only 1 version of it.

[ashfurrow]

Ah, interesting! It took until now for me to get the distinction, this blog post was helpful.

[alloy]

It’s an art!

[alloy]

I believe these type annotations can be removed when using TS, which already has these in its function signature.

[ashfurrow]

Yup, I've been working my way down the file and switching them over 👍

[alloy]

Might be worth it to import this * as graphql as these symbols could be slightly confusing when used together with the tsc API

[alloy]

Ah yes! Nice 👌

[alloy]

Btw, I’d appreciate it if you could make me the author of the initial commit (of only the rule file), even if just for knowing who to talk to if there’s ever any questions 🙏

[alloy]

Let‘s move it to the relay-tools org before cutting the first release. I’ll invite you to the org now.

[ashfurrow]

Sure, sounds good 👍 Thanks!

[alloy]

Thanks!

[ashfurrow]

I had to put this in devDependencies because peer deps aren't installed by default.

[ashfurrow]

Okay, this just needs testing now. Before we publish, we can link locally on reaction and make sure it will work. I'm expecting to have to faff with TSLint to get it to load rules from node modules.

[ashfurrow]

I've found this blog post helpful for getting the package set up and linked from Reaction: https://palantir.github.io/tslint/2016/03/31/sharable-configurations-rules.html

Also, it's not possible to link against a package that has no published version (see this issue) so I added the following to Reaction's package.json to test:

"tslint-plugin-relay": "link:../tslint-plugin-relay"

Which sets up the symlink on yarn install.

[ashfurrow]

Okay, the blog post I linked to is a bit outdated since it doesn't permit TypeScript rules. I've modified how we compile to point to the rules directory, for consistency.

It's not working when linked locally, but I think it might be a problem with the module resolution that our symlink is not adhering too. I'm going to merge, move the repo to the relay-tools org, then publish a v0.0.1 so we can test on Reaction.

[ashfurrow]

Woo! https://www.npmjs.com/package/tslint-plugin-relay

Okay, linking works. I looked and there were two problems:

• tslint-base.json gets copied to build on yarn build, but references the ./build directory from there, causing path problems.
• Reaction's tslint.json file needs to extend "tslint-plugin-relay", not "tslint-plugin-relay/tslint-config" as described in the blog post above.

I'll fix both, verify this is working, then PR to Reaction 👍

[ashfurrow]

Oh shoot. It looks like a rebase erased the git author status for Eloy on the initial import. I did a force-push on master to correct before anyone sees 🙈

[alloy]

Woohoo! Nice job, @ashfurrow 👏