Skip to content

HOFF-113: updating hof getting started guidance to reference the skeleton application#28

Merged
gregwolversonHO merged 2 commits intomasterfrom
HOFF-113-update-hof-guide
Jul 14, 2025
Merged

HOFF-113: updating hof getting started guidance to reference the skeleton application#28
gregwolversonHO merged 2 commits intomasterfrom
HOFF-113-update-hof-guide

Conversation

@gregwolversonHO
Copy link
Copy Markdown
Contributor

What?

Updating hof getting started guidance to reference the hof-skeleton application instead of the generator cli.

Why?

The generator cli is outdated and has been replaced with the hof-skeleton app as a simple, bare bones approach to getting started with hof.

How?

Updated the getting started section of the hof guide

Screenshots (optional)

Anything Else? (optional)

Check list

  • I have reviewed my own pull request for linting issues (e.g. adding new lines)
  • I have created a JIRA number for my branch (if applicable)
  • I have created a JIRA number for my commit (if applicable)
  • I have followed the chris beams method for my commit https://cbea.ms/git-commit/
    here is an example commit
  • I will squash the commits before merging

hof is built in [node.js](https://nodejs.org/en/), and so you'll need that installed first. At present all versions 4 and above are supported, although it is recommended that you use the [latest LTS version](https://github.com/nodejs/LTS#lts-schedule).

hof also requires npm version 3 or greater. You can check your installed version by running `npm -v` and update to the latest version by running `npm install -g npm@latest`.
hof also requires npm version 3 or greater, and yarn. You can check your installed versions by running `npm -v` and `yarn -v` and update to the latest versions by running `npm install -g npm@latest` and `npm install -g yarn`.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking at package.json, actually requires npm >= 6.14.0, not version 3 or greater. I think it would be a matter of the team's preference whether to use npm or yarn, using both wouldn't make sense for development, at least. We could add the Yarn version to the 'engines' field if needed, although I haven't tested it and can't suggest the minimum required version.

package.json engines ref:

"engines": {
  "node": ">=10.22.1",
  "npm": ">=6.14.0"
}

I would suggest to reword it, to add a bit more details and context perhaps:

Suggested change
hof also requires npm version 3 or greater, and yarn. You can check your installed versions by running `npm -v` and `yarn -v` and update to the latest versions by running `npm install -g npm@latest` and `npm install -g yarn`.
HOF requires Node.js version 10.22.1 or greater and npm version 6.14.0 or greater.
While you can use either npm or yarn for package management, the test scripts for hof expect yarn to be available.
You can check your installed versions by running `node -v`, `npm -v`, and `yarn -v` and update to the latest versions by running `npm install -g npm@latest` and `npm install -g yarn`.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dk4g thanks for the suggestions! Makes sense to me, I don't know the ins and outs of the framework, so I'm happy to take your advice and reword the guide to reflect the right approach.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi a previous senior dev had some issues with dependencies inside dependencies with npm but he was able to fix the issue with yarn so he switched hof to yarn. I would just stick to yarn in docs and our framework and not npm. We use yarn.lock in most of our prod services. We should check though across other services.
We need to be aligned on this so let's discuss in a tech session and update our docs to reflect we support yarn and can't guarantee the framework's compatibility with npm

Copy link
Copy Markdown

@gregaustinHO gregaustinHO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@gregwolversonHO gregwolversonHO merged commit ed86201 into master Jul 14, 2025
1 check passed
@sulthan-ahmed sulthan-ahmed deleted the HOFF-113-update-hof-guide branch July 14, 2025 08:54
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.

4 participants