Skip to content

Instantly share code, notes, and snippets.

@machinaut
Created November 7, 2022 23:07
Show Gist options
  • Save machinaut/6df5bc112ed22cd7331af6602f0834d0 to your computer and use it in GitHub Desktop.
Save machinaut/6df5bc112ed22cd7331af6602f0834d0 to your computer and use it in GitHub Desktop.

Foam Extension Development Quick Start Guide

For OSX, tested on my computer on a monday. YMMV. I started without any node/etc installed.

I never got NVM to work for node versioning, so I defaulted to just using brew node:

	brew install node

And then install yarn and lerna globally:

	npm install -g [email protected]
	npm install -g yarn
	npm install -g lerna

Then open the foam repo in vscode

	cd foam
	code .

Then install the build requirements

  • Tasks: Run Task
  • npm
  • npm: install

Then package the extension

  • Tasks: Run Task
  • npm
  • npm: package-extension
  • Continue without scanning the task output
  • (Optionally accept installs/etc in the terminal to continue)

Then install the packaged extension

  • Tasks: Run Task
  • npm
  • npm: install-extension
  • Continue without scanning the task output

Now it should be installed in vscode.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment