Skip to content

Latest commit

 

History

History
136 lines (93 loc) · 12.9 KB

README.md

File metadata and controls

136 lines (93 loc) · 12.9 KB
Raw

Alpheios Core

JavaScript Style Guide Build Status Coverage Status

This monorepo contains packages of Alpheios Tools Core. It is managed by Lerna.

The following packages are included:

  • components
  • data-models
  • client-adapters
  • res-client
  • wordlists
  • inflection-tables

Directory structure

The root folder (alpheios-core) contains a root package.json and a Lerna configuration file (lerna.json). All packages that comprise Alpheios Core are in the packages subdirectory, each within its individual subfolder. Data models package is, for example, in alpheios-core/packages/data-models. The root directory may also contain a node_modules folder for package dependencies that are hoisted.

Operations with packages

Most operations with packages (including the ones made by npm) are executed from a root directory (alpheios-core) using Lerna or its companion tools. Operations can be performed over all packages at once or over individual packages. In the latter case a --scope Lerna filter shall be used: npx lerna command --scope package-name or npx lerna command --scope '{package-name-one,package-name-two}. Do not run npm commands from folders of individual packages, it may break things. Use lerna run (npx lerna run npm-command) for that. You can also use lerna exec too.

Please note: the name of the package is the value of the name field in its package.json, not the name of the folder where this package is located.

Installing dependencies

If necessary, run a set-node-build-deps npm script to install node-build dependencies first (please check an explanation below). Then use a bootstrap npm script in package.json within the root directory to install or update dependencies of all packages, including the root one, at once. It will use a --hoist option that, instead of installing dependencies into folders of individual packages, will install them into the node_modules folder of the root directory instead.

Alpheios Core uses v2 of the node-build tool. This version does not install dependencies automatically, but rather lists them as peer dependencies. Peer dependencies are not installed by npm. This means that node-build dependencies need to be injected into the root package.json of Alpheios Core. A set-node-build-deps script does just that: it installs node-build at the root, uses install-peerdeps npm package to inject dependencies, and then removes node-build from the root since it is not needed any more. This installation step is required because node-build is hosted on GitHub and install-peerdeps, not being able to work with GitHub-hosted packages at the moment, requires the package to be installed locally.

node-build dependencies do not need to be updated every time bootstrap runs: once added to package.json, dependencies will stay there. bootstrap will pick them up and install during its run. Only if it is known that dependencies of node-build are changed it is necessary to re-run set-node-build-deps so that the corresponding packages will be updated within package.json.

Hoisting of dependencies

A --hoist option prevents the same dependency to be installed several times. The standard node.js resolution procedure makes it possible: if a dependency is not found in a node_modules subdirectory of the current folder it will go up the hierarchy trying to find a dependency there. As a result, it will go all the way up to the root directory (alpheios-core) where a dependency will finally be found in a node_modules folder.

npx lerna bootstrap --hoist does not create links to dependencies in individual packages. However, we need build-node to be installed into the node-modules directory of each individual package. This is how we refer to it from npm scripts section of package.json and it does not use the same dependency resolution mechanics as node.js do. Because of this we eliminate a node-build package from hoisting.

Please see module resolution for more details about how hoisting works.

Adding dependencies

Use npx lerna add package-dependency-to-add --dev --scope=package-to-which-dependency-to-be-added command to add a new dependency to the package. If you want to add, for example, a vue dependency to alpheios-client-adapters then the following command will do it: npx lerna add vue --dev --scope=alpheios-client-adapters.

Updating dependencies

If dependencies needs to be updated, one can use list-mismatching-deps, fix-mismatching-deps, list-outdated-deps (they will update package.json files of one ore several individual packages) or update package.json of an individual package manually. If to re-run a bootstrap script after that it will install or update missing dependencies. In case of any problems one can run a clean npm script before the bootstrap. clean will remove all node_modules folders making a way to the clean install.

Working with dependencies

There are several script that help to manage dependencies:

  • list-mismatching-deps will list all dependencies across different packages and highlight the ones that are listed as different versions in individual packages. It will, for example, highlight a webpack dependency if package A depends on version 4.0.1 of it and package B depends on version 4.1.5.
  • list-outdated-deps will run npm outdated across all packages and will list packages that have outdated dependencies. If there is an outdated version found across one of the packages one might edit that package.json file manually to set the dependency to its latest version, run fix-mismatching-deps to update the same dependency across other packages to specify the same version and finally run bootstrap to install an updated dependency package.
  • fix-mismatching-deps: if several packages depend on different versions of the same npm package this script will update package.json files with older dependencies so that all packages will depend on the the newwest version of the dependency list. For example, if package A depends on webpack v4.0.1 and packages B depends on webpack v4.1.5 then this command will updated both packages so that package A and package B will depend on webpack v4.1.5. This may be not the latest version of webpack available on npm but it will be the latest version specified across all individual packages. fix-mismatching-deps does not update dependencies themselves in node_modules; one has to run a bootstrap command to install an updated dependency version.

Installing local packages temporarily

During development process one may need to install a local version of a package that is not part of alpheios-core. This can greatly simplify local development and debugging. Unfortunately, Lerna bootstrap does not work with packages installed locally.

The currently recommended way to install and use a local package is:

  1. Install a local package dependency as a dev dependency to the package.json inside an alpheios-core root directory: npm i -D ../package-name.
  2. Run lerna bootstrap from the root of alpheios-core. This step is needed because the previous install step may remove packages previously hoisted by lerna bootstrap and we will need to restore them.
  3. Edit webpack configuration files (located usually in the build directory) of those alpheios-core packages that need to use a local version of a package being installed. Update an alias section and make the alias for the package being installed point to the package instance in the root directory, i.e. replace 'package-name': path.join(projectRoot, 'node_modules/package-name/bundle-name') alias with 'package-name': path.join(projectRoot, '../../node_modules/package-name/bundle-name'). Now the locally installed package is ready to be used.

In order to revert to using a package hosted on npm or GitHub do the following:

  1. Remove the package installed at the root of an alpheios-core: npm un package-name.
  2. Run lerna bootstrap from the root of an alpheios-core.
  3. Edit webpack's configuration files of those alpheios-core packages that were changed previously to use a local version of the package. Update an alias section and make the alias point to the package instance in the local directory, i.e. replace 'package-name': path.join(projectRoot, '../../node_modules/package-name/bundle-name') with 'package-name': path.join(projectRoot, 'node_modules/package-name/bundle-name').

Developing Code

When you are fixing a bug or starting a new feature, create a branch off of master and do your development work in there as usual. Name the branch according to the following scheme:

For issues in the alpheios-core repository:

i<issue-number>-[description]

If the issue is hosted by another repository (in which case ideally there would be a companion issue entered in alpheios-core but it could be overlooked):

i<issue-number>-<repo-name>-[description]

After your work is completed, and the PR approved, merge your changes to master.

See also the Git Workflow Documentation

Using Conventional Commits

For at least one commit in your development branch, run npm run conventional-commit and follow the prompts to specify the type of change you are making.

Running npm scripts

Please do not run scripts related to addition, installation, and upgrade of package dependencies from a package directory. Do it from a root directory (alpheios-core) using npm scripts of the root package.json or use Lerna's run command (npx lerna run scipt-to-run).

To run npm scripts for all packages use npx lerna run script-name from the top-level directory (i.e. alpheios-core). This will run script-name script for all packages that have this script in their package.json. See lerna run documentation for more information on this command.

To run npm scripts of individual packages in situations other than add, install or update use npx lerna run --scope package-name script-name or go to the package directory (i.e. alpheios-core/packages/package-name) and run npm scripts from there: npm run script-name. Alternatively, you can use npx lerna run --scope package-name script-name to run a scoped script from a root directory.

Claiming an individual package as a dependency (using webpack)

To use an individual package as a dependency:

  • Set alpheios-core as a dependency in package.json.
  • Install alpheios-core.
  • Set a webpack alias that will point to an individual package within alpheios-core. So if, for example, a package depends on alpheios-client-adapters a webpack alias must point to an alpheios-client-adaptes package within alpheios-core: alias: { 'alpheios-client-adapters': path.join(projectRoot, 'node_modules/alpheios-core/packages/client-adapters/dist/alpheios-client-adapters.js') }.
  • Import items from Client Adapters: import { something } from 'alpehios-client-adapters'.

Building for development

Run npm run build

This will inject an automatic build number generated from the branch name and date.

Commit built files to the development branch.

Building for QA

  1. merge the master branch to the qa branch and push to GitHub
  2. GitHub Actions will execute the release.yml workflow to inject the build number, build the distribution files, tag a pre-release in GitHub and push the components package to npm tagged as @qa

Building and Versioning for Production

  1. merge the qa branch to the production branch (but don't push it)
  2. run npx lerna version and increase the version number as appropriate for release. This will also push the change to GitHub.
  3. GitHub Actions will execute the release.yml workflow to inject the build number, build the distribution files, tag a pre-release in GitHub and push the components package to npm tagged as @rc
  4. When ready to release the code, manually tag the npm package as @latest using npm --dist-tag and remove the "Pre-release" flag from the Release in GitHub.
  5. Merge the version and any other code changes from production back to master

See also the Git Workflow Documentation