Skip to content

Latest commit

 

History

History
107 lines (73 loc) · 3.93 KB

setting-up-the-project.md

File metadata and controls

107 lines (73 loc) · 3.93 KB

Setting Up The Project

Setup Volta

If you are not already using ⚡️ volta or have a version older than 1.1.1 you will want to begin by installing it.

For package management, the project uses PNPM.

Volta will manage node and pnpm versions for you, but for PNPM there is one more step:

To your shell profile you will want to add the following.

export VOLTA_FEATURE_PNPM=1;

Note if you have previously installed pnpm globally via other means you should uninstall it from all other locations first. You may also need to uninstall nvm or other node version managers if they turn out to conflict.

Install bun.sh

If you don't already have bun.sh For MacOS or Linux

curl -fsSL https://bun.sh/install | bash

can be done using homebrew, npm or Docker (User choice) checkout installation doc

For Windows

# WARNING: No stability is guaranteed on the experimental Windows builds
powershell -c "irm bun.sh/install.ps1|iex"

Installation doc

Install certificate packages

Install mkcert using homebrew on MacOS or Linux

brew install mkcert

can be done using Chocolatey, Scoop or MacPorts (User choice) checkout installation [doc][https://github.com/FiloSottile/mkcert?tab=readme-ov-file#installation]

For Firefox users, Mozilla NSS is also needed Using homebrew on MacOS

brew install nss

Or apt on Linux

sudo apt install libnss3-tools

but can also be done using other methods.

Clone the repository

git clone git@github.com:emberjs/data.git

Install the project dependencies

cd data && pnpm install

Currently the install command is also what builds all of the individual packages in the monorepo and hardlinks them together, so if making changes to one package that need to be used by another you will need to rerun pnpm install for the changes to be picked up.

Create certificates

pnpm dlx @warp-drive/holodeck ensure-cert

Building the project

The project's packages will build whenever pnpm install is run. They can be rebuilt by running pnpm prepare.

Both install and prepare will ensure turbo cache is ignored so that pnpm will automatically update "hardlinks" for the build output files in the node_modules directory of the various other packages and test apps that depend upon the package.

However, this is pretty slow for development, so a fast albeit slightly manual approach is available for development by running the below commands in order:

From the project root:

  • install: pnpm install - installs all dependencies and sets up initial hardlinks
  • start: pnpm start - starts the build for every public package in watch mode

Then, from an individual test app:

  • pnpm start - starts the build for test assets in watch mode
  • pnpm test:start - launches a test server (and by opens a browser window for debugging them)

Because the project uses hardlinks, even though the packages are rebuilding, the test apps won't be able to see the results of the change in many scenarios unless the hardlinks are regenerated.

At anypoint, run pnpm sync from the root to regenerate the hardlinks. The test app server may pick up this change automatically, but if it does not saving any file (even without changing it) in the test app will trigger a rebuild.

Run some commands

Generally test and lint commands can be found in the "scripts" section of the root package.json manifest. Individual packages or test packages have additional commands in the "scripts" section of their own package.json manifest as well.

Any command in script can be run using pnpm from the directory of that manifest. For instance, to run linting from the root: pnpm lint

Github Actions workflows will generally use these same commands.