In this project there is pre-processing of source Javascript and stylesheet files. The output of this processing is directed into the app/assets/ directory ready to be included in the gem. Strangely, both the source (javascript/ and styles/) and the target (app/assests/) directories are included in the git repository. This introduces confusion: which files should be developed on?
I propose we only include the source files in the git repo, and have a well defined build process that processes the assets and creates the gem.
Changes
Remove generated Javascript and CSS from the git repository. Instead, update the Rake gem build task to re-generate the Javascript and CSS.
Commit dependency lock-files to git to ensure repeatable gem builds.
Update Javascript and CSS pre-processing tools to the latest versions.
Use yarn to manage Javascript packages, instead of npm. This is consistent with what we're using in many other projects.
Remove some custom CSS. While this was in the source file, it seems the preprocessing has never been applied and the target CSS never updated. It hasn't been released in a gem. This seems to have been a work in progress because it breaks several things in the style-guide pages.
Context
In this project there is pre-processing of source Javascript and stylesheet files. The output of this processing is directed into the
app/assets/directory ready to be included in the gem. Strangely, both the source (javascript/andstyles/) and the target (app/assests/) directories are included in the git repository. This introduces confusion: which files should be developed on?I propose we only include the source files in the git repo, and have a well defined build process that processes the assets and creates the gem.
Changes
yarnto manage Javascript packages, instead ofnpm. This is consistent with what we're using in many other projects.