Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul development and test dependencies. #51

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

matthewmcvickar
Copy link
Contributor

@matthewmcvickar matthewmcvickar commented Jun 26, 2023

This is an attempt to simplify and update the dependencies for this project.

There are a few reasons for this:

  • The GitHub workflow for testing that runs on each push is failing because the package dependencies are out of date.
  • The JavaScript testing framework nodeunit has not been under active development for a long time and has numerous security vulnerabilities.
  • The development tooling workflow library Grunt has not been under active development for some time and has numerous security vulnerabilities. It is also unnecessary, as the same functionality can be replicated by using NPM scripts defined in package.json.

What was done:

  • Removed Grunt. Replaced its functionality with NPM scripts in package.json.
  • Removed nodeunit. Replaced it with the Jest JavaScript testing framework and updated the tests accordingly.
  • Removed jsonlint. Replaced it with @prantlf/jsonlint, a fork of jsonlint that is improved and actively maintained.
  • Updated JSHint.
  • Updated README to replace mention of Grunt with an example of how to run Javascript tests.
  • Update GitHub Actions workflow YAML to reflect new JS testing.

I have a few other PRs in the hopper for this project, but I wanted to get the baseline dependencies updated and automated tests working before going any further.

This is an attempt to simplify and update the dependencies for this
project.

There are a few reasons for this:
- The GitHub workflow for testing that would run on each push was
  failing because the dependencies were out of date.
- The JavaScript testing framework 'nodeunit' has not been under
  active development for a long time and has numerous security
  vulnerabilities.
- The development tooling workflow library Grunt has not been under
  active development for some time and has numerous security
  vulnerabilities. It is also unnecessary, as the functionality can
  be replicated with using `npm` scripts defined in `package.json`.

What was done:
- Removed Grunt. Replaced it with NPM scripts in `package.json`.
- Removed nodeunit. Replaced it with the Jest JavaScript testing
  framework and updated the tests accordingly.
- Removed jsonlint. Replaced it with @prantlf/jsonlint, a fork that is
  actively maintained.
- Updated JSHint.
- Updated README to replace mention of Grunt with an example of how to
  run Javascript tests.
- Update GitHub Actions workflow YAML to reflect new JS testing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant