Skip to content

Announcements and Fixing Needed

Hey, so I spent a decent amount of work turning this project into a model for the other repositories. Here are some of the key points:

  • The Docker.{{ Docker build target }}.test.yml files are key to making everything work. If there is more than one build target then there there should be Docker.build_target_1.test.yml and Docker.build_target_2.test.yml. The build target names should match the build targets in the Dockerfile. Please check out the Dockerfile to see how we can leverage this project to create two unique products - one, a CodeClimate engine and the other a regular linter. The same should be done for all the other projects.
  • pnpm should be used
  • Most of the nitty gritty is automated. Documentation and all that is pretty much done. All you need to worry about are the details in the .blueprint section of package.json. Just fill those details in, create a modest README partial in docs/partials/guide.md, and then run bash start.sh && task init --- everything should automatically rescaffold itself for the most part --- please let me know about bugs
  • The two main features that you need to get working for each of the linters is the task build and task test command. The build task looks at the container-structure-test (i.e. Docker.build_target.test.yml files) and detects which build targets there are and then builds regular and slim containers. The .blueprint.dockerSlimCommand just needs to be filled out for each container.
  • The test task does a few things. It does the container-structure-test, then it tests the CodeClimate engine via the CLI, and then it tests the stages that start with integration in .gitlab-ci.yml. There's another optional one that compares the output of running a lint sequence but I think container-strcuture-test is good enough.

What Needs to Be Done on This Repository

  1. The slim build for the codeclimate-eslint build target is not working - it says that glob is missing. I literally just tried for hours to fix it to no avail so I have to pass this off to you for my sanity.
  2. I had container-strucutre-test working at one point but then I started getting errors. I realized there were issues with one of the builds that might have been causing the structure tests to fail.
  3. The task test command should do:
  • container-structure-test
  • CodeClimate CLI test
  • .gitlab-ci.yml integration test