policygenius / athenaeum Goto Github PK

Background
A number of RCL components do not have guards around props that are undefined and simply pass those down. This can not only present a problem in use but it also shows up in jest snapshots, which doesn't provide a great way to test the expected HTML structure of our components.

We will need to do a thorough documentation of all the components that do not have this guard and determine if one is needed. Best way to do this may just be to look at a few snapshots and find patterns.

Acceptance Criteria

• Guards are put in place to prevent unwanted/unnecessary undefined values from being applied to RCL components

Tech Notes
Here is a list of known offenders:

• <Text />
• <Layout />
• <Icon />
• <Button />
• <LinkWrapper />

Broken images found on Spacers

• http://rcl.policygenius.com/latest/index.html#!/Spacers

Typography

• http://rcl.policygenius.com/latest/index.html#!/Typography

Grid

• http://rcl.policygenius.com/latest/index.html#!/Grid

the react-svg-inline webpack is no longer support consider upgrade and refactor to use: https://github.com/smooth-code/svgr

crash-2019-01-08_23_27_37-client.txt

http://rcl.policygenius.com/latest/index.html#!/TextField

cannot set autofocus on textfield.

The Text component takes a size prop, but that size will only work with the 'a' font.

For our markdown linter, which lints the JS written in each component's Readme.md file, we use a customized version of the eslint-plugin-markdown package, which is currently forked on my (jmcolella) Github account.

For yarn to load the correct, customized module, the package.json points to the tarball on my Github for this package and the yarn.lock resolves a specific SHA for the tarball.

Occasionally, the SHA in the yarn.lock will not resolve properly and, as of now, needs to be updated manually. If you are experiencing any yarn issues on Buildkite, please follow the steps below to help solve the issue:

1. Go to the list of commits for the tarball. Copy the most recent SHA (the full SHA, not the shortened version)
2. Go to the yarn.lock file in athenaeum and find the eslint-plugin-markdown packaged. Where it says resolved, at the very end, replace the SHA that is already there with the one you copied.
3. Run yarn
4. An error will appear saying the SHA given in step 2 is incorrect and it will supply another one. The error will read something like: Expected #{wrong_sha}, but got #{correct_sha}.
5. Replace the SHA in the yarn.lock with the correct_sha from step 4.
6. Run yarn again to ensure all is good

I currently don't know another way to resolve this issue, hopefully we can spend time soon to get to the bottom of it.