Publishing is a two step process:
We recommend using Parcel for a nice, zero configuration transpiler and bundler and this is what our extension generator uses.
Parcel takes your code and creates a single JavaScript file (“parcel”) that is uploaded to the extension registry. Nothing is stopping you using webpack or Babel but Parcel works for us.
The name of the file uploaded doesn’t matter. We recommend it match your extension name so you can easily identify it when using your browser developer tools.
Sourcegraph extensions depends on the Sourcegraph extension API package and we recommend checking for a newer version on a regular basis.
npm outdated --save-dev
The extension generator includes npm commands for type checking and linting your code. You don’t have to, but we recommend running them before publishing.
npm run typecheck
npm run tslint
This guide presumes you will be publishing to Sourcegraph.com.
Ensure you installed and configured the src CLI.
Now you can publish with a single command.
src ext publish
This is the command you’ll run when releasing a new version.
However doing this as part of your development workflow would be slow and tedious. See the workflow for extension reloading without publishing.
Currently, publishing is limited to Sourcegraph.com and a Sourcegraph Enterprise private extension registry.
We know you need a way to develop locally before publishing, as well as having a way to mark an extension as a WIP/preview.
We recommend you subsribe to these issues so you can track our progress.
We can use parcel to serve and re-package the extension on file change and set the url of the extension to our local development environment.
Presuming you used the extension generator, you can run:
npm run serve
In a new terminal window, now re-publish your extension, overriding the url to point to your bundled JavaScript file.
src ext publish --url=http://localhost:1234/my-extension-name.js