Skip to content

Package management: use ligo.json instead of package.json or esy.json

Motivation and Context

Users often work with JS toolchain alongside ours. Using package.json to manage both is tricky. It's better to have a separate manfiest to manage ligo dependencies.

Description

This MR let's users use a separate ligo.json maninfest to manage packages.

Component

  • compiler
  • website
  • webide
  • vscode-plugin
  • debugger

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Performance improvement (non-breaking change that improves performance)
  • None (change with no changelog)

Changelog

Users can now use a ligo.json file to manage dependencies instead of package.json Existing projects with esy.json or package.json will be prompted to rename their manifests. ligo will automatically generate new lock files under the directory ligo.esy.lock. Users can check this folder into their version controll system for reproducibility.

Checklist:

  • If a new syntax has been introduced, put a message on slack ligo-lsp
  • Changes follow the existing coding style (use dune @fmt to check).
  • Tests for the changes have been added (for bug fixes / feature).
  • Documentation has been updated.
  • Changelog description has been added (if appropriate).
  • Start titles under ## Changelog section with #### (if appropriate).
  • There is no image or uploaded file in changelog
  • Examples in changed behaviour have been added to the changelog (for breaking change / feature).
Edited by prometheansacrifice

Merge request reports

Loading