appeals-frontend-toolkitBuild tools and React components for the Appeals frontends.
$ yarn add @department-of-veterans-affairs/appeals-frontend-toolkit
UsageSee how other libraries, like Caseflow, are using this tool.
Component AssumptionsThe components make assumptions, like:
- Caseflow Commons CSS will be on the page.
- Global analytics functions will be available.
These assumptions are not explicitly documented, so you'll have to read the code. :)
DependenciesThis module has many peer dependencies. It relies on contracts with a variety of modules in the Webpack, React, and Karma ecosystems. Unfortunately, yarn and npm's support for
peerDependenciesis weak. For instance, adding peer dependencies can cause yarn to log warnings for no reason. This means that you'll have to just look in
package.jsonfor what seems relevant, and manually add it to your consumer project.
Dev NotesThis module has the public contract that consumers can require certain files in
components/directly. Before you move files around, be sure that no consumer is using them. (We can come up with a more formal way to declare what files are public when the usage of this module gets more complex, but for now I'd say it's overkill.)
Build ProcessTraditionally, an npm module is supposed to own its build process. Before running
yarn publish, you'd have a script that compiles a JS file that does not need further compilation to run in any environment you support. This greatly simplifies sharing code in the broad OSS world, because you don't need to know how a module was compiled to use it.
For our use case, I've decided to forgo that. Our team owns both this module and the consumers of it. In the near term, we have two consumers. Additionally, the build process for those two consumers is defined by this module itself. So it should be easy to keep all three places in sync. And this allows us to greatly simplify our publishing process. Instead of having Travis publish on
masterbuilds, or hoping that people remember to run
yarn run build-and-publishinstead of just
yarn publish, we can just publish directly without extra steps. We won't have the pain of accidentally publishing a version that does not have the prebuilt JS file.
React as a dev depUnfortunately, if
reactis listed as a
yarnfires a bunch of erroneous warnings about
reactnot being met as a peer dependency. Thus, we move it to
devDependenciesto silence the warnings. Semantically,
dependencyof this module and should be listed as such.