Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
esy - npm Package Compare versions
Comparing version 0.7.1 to 0.7.2-177-g496796ae
| { | ||
| "name": "esy", | ||
| "version": "0.7.1", | ||
| "version": "0.7.2-177-g496796ae", | ||
| "license": "BSD-2-Clause", | ||
@@ -5,0 +5,0 @@ "description": "Package builder for esy.", |
@@ -7,4 +7,3 @@ # esy | ||
| This README serves as a development documentation for esy. For user | ||
| documentation refer to [esy.sh][] documentation site. | ||
| Esy is a package manager for Reason and OCaml centered around the [NPM] workflow. Reason/OCaml are compiled languages and it can be daunting for developers to setup tools and develop a workflow that is intuitive and well documented. Developing apps that are natively compiled are also hard to reproduce and often require additional tooling. Esy tries address these, by offering a familiar `package.json` centered workflow and light-weight sandboxing. | ||
@@ -24,181 +23,18 @@ <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| ## Repository structure | ||
| ## Installation | ||
| The following snippet lists esy repository structured (omitting irrelevant or | ||
| obvious items) with further explanations: | ||
| Esy is available on NPM. | ||
| ├── CHANGELOG.md | ||
| ├── LICENSE | ||
| ├── README.md | ||
| │ | ||
| ├── Makefile | ||
| │ Common tasks and workflows for esy development. | ||
| │ | ||
| ├── bin/esy | ||
| │ symlink (wrapper on Windows) for esy command, used for running tests | ||
| │ | ||
| ├── bin/esyInstallRelease.js | ||
| │ postinstall step for npm releases produced with `esy npm-release` | ||
| │ command. This is a built JS file which is developed in a separate flow | ||
| │ inside `esy-install-npm-release/` subdirectory (see below). | ||
| │ | ||
| ├── docs | ||
| │ esy end user documentation in markdown format. | ||
| │ | ||
| ├── dune | ||
| ├── dune-project | ||
| │ | ||
| ├── esy | ||
| │ This dune library implements sandbox builder - a routine which builds | ||
| │ the entire dependency graph and provides other introspection APIs. | ||
| │ | ||
| ├── esy/bin | ||
| │ This dune executable implements "esy" command. | ||
| │ | ||
| ├── esy-solve | ||
| │ This dune library implements solver. | ||
| │ | ||
| ├── esy-install | ||
| │ This dune library implements installer. | ||
| │ | ||
| ├── esy-build-package | ||
| │ This dune library implements package builder. esy library uses this to | ||
| │ build each package. | ||
| │ | ||
| ├── esy-build-package/bin | ||
| │ This dune executable implements "esy-build-package" command. | ||
| │ | ||
| ├── esy-installer | ||
| │ Implementation of installation procedure defined with *.install files. | ||
| │ This re-implements opam-installer. | ||
| │ | ||
| ├── esy-install-npm-release | ||
| │ Sources for `bin/esyInstallRelease.js`. | ||
| │ | ||
| ├── esy-command-expression | ||
| │ Parser for #{...} syntax used in esy manifests. | ||
| │ | ||
| ├── esy-shell-expansion | ||
| │ A simple shell expansion. | ||
| │ | ||
| ├── esy-yarn-lockfile | ||
| │ Parser for a subset of yarn lockfile format. | ||
| │ | ||
| ├── esy-lib | ||
| │ A collection of utility modules shared between other libraries. | ||
| │ | ||
| ├── site | ||
| │ Sources for https://esy.sh | ||
| │ | ||
| ├── esy.lock | ||
| ├── package.json | ||
| │ | ||
| ├── scripts | ||
| │ | ||
| ├── test | ||
| │ Unit tests. | ||
| │ | ||
| ├── test-e2e-slow | ||
| │ End-to-end test suite which takes a significant amount of time. | ||
| │ We execute it on CI by placing `@slowtest` token in commit messages. | ||
| │ | ||
| └── test-e2e | ||
| End-to-end test suite. | ||
| ## Workflow | ||
| To make changes to `esy` and test them locally: | ||
| ``` | ||
| % git clone --recurse-submodules git://github.com/esy/esy.git | ||
| % cd esy # Change to the cloned directory | ||
| % esy # install and build dependencies | ||
| ``` | ||
| And then run newly built `esy` executable from anywhere by adding `PATH_TO_REPO/_build/install/default/bin` | ||
| to the $PATH during the shell's session. On Windows, append `PATH_TO_REPO/bin` too. | ||
| ### Updating `bin/esyInstallRelease.js` | ||
| `bin/esyInstallRelease.js` is developed separately within the `esy-install-npm-release/` directory. | ||
| Run: | ||
| ``` | ||
| % make bin/esyInstallRelease.js | ||
| ``` | ||
| to update the `bin/esyInstallRelease.js` file with the latest changed, don't | ||
| forget to commit it. | ||
| ### Running Tests | ||
| Run: | ||
| ``` | ||
| % make test | ||
| ``` | ||
| #### Slow tests | ||
| By placing `@slowtest` token in commit messages, we mark the commit ready for the slow tests framework | ||
| (tests that hit the network). They are run with `node test-e2e-slow/run-slow-tests.js` | ||
| #### Windows | ||
| In cases e2e tests fail with `Host key verification failed.`, you might have to create ssh keys | ||
| in the cygwin shall and add them to your github profile. | ||
| 1. Enter cygwin installed by esy (not the global one) | ||
| ```sh | ||
| .\node_modules\@prometheansacrifice\esy-bash\re\_build\default\bin\EsyBash.exe bash | ||
| npm i -g esy | ||
| ``` | ||
| 2. Generate ssh keys | ||
| ## Documentation | ||
| ```sh | ||
| ssh-keygen | ||
| ``` | ||
| You can find the Esy documentation [on the website](https://esy.sh/). You can also find them under the [docs folder](./docs) of the source tree. | ||
| 3. Add the public key to you Github profile | ||
| ## Contributing | ||
| 4. Add the following to the bash rc of the cygwin instance | ||
| Please refer the documents in [docs/contributing](./docs/contributing). You'll find instructions for building the source, CI setup, release process, esy internal concepts and other documentation to help you get started hacking on esy. You can also find them on the website [under the contributing section](https://esy.sh/docs/contributing/building-from-source) | ||
| ```sh | ||
| eval $(ssh-agent -s) | ||
| ssh-add ~/.ssh/id_rsa | ||
| ``` | ||
| ### Branches | ||
| There are two branches: | ||
| - `master` — the active development, we cut new versions out of there regularly. | ||
| - `0.0.x` — maintainance branch for 0.0.x releases. | ||
| - `0.2.x` — maintainance branch for 0.2.x releases. | ||
| - `0.3.x` — maintainance branch for 0.3.x releases. | ||
| ## Workflow for esy.sh | ||
| To make changes to [esy.sh][]: | ||
| 1. Bootstrap site's dev environment: | ||
| ``` | ||
| % make site-bootstrap | ||
| ``` | ||
| 2. Run site locally: | ||
| ``` | ||
| % make site-start | ||
| ``` | ||
| 3. When you are happy with the changes: | ||
| ``` | ||
| % make site-publish | ||
| ``` | ||
| ## Issues | ||
@@ -208,74 +44,13 @@ | ||
| ## Publishing Releases | ||
| ## History and motivation | ||
| esy is released on npm. | ||
| See [`package.json` for compilers](https://github.com/jordwalke/PackageJsonForCompilers) | ||
| Because esy is written in OCaml/Reason and compiled into a native executable we | ||
| need to acquire a set of prebuilt binaries for each supported platform (Windows, | ||
| macOS and Linux). We employ CI servers (thanks Azure) to build platform specific | ||
| releases. | ||
| ## Maintenance and Sponsorship | ||
| The release workflow is the following: | ||
| This project was originally authored by [Andrey Popp](https://github.com/andreypopp), and is currently maintained by [ManasJayanth](https://github.com/ManasJayanth). The project is currently not funded and could benefit from generous sponsorships. | ||
| 1. Ensure you are on `master` branch and assuming you want to release the | ||
| version currently defined in `package.json` (see step 6.), run | ||
| ``` | ||
| % make release-tag | ||
| % git push && git push --tags | ||
| ``` | ||
| 2. Wait till CI finishes its task and release `@esy-nightly/esy` package. | ||
| You can test it manually. | ||
| 3. Run | ||
| ``` | ||
| % make release-prepare | ||
| ``` | ||
| which downloads the nightly corresponding to the current commit working | ||
| directory is at and "promotes" it to a release. It will create | ||
| `_release/package` directory. | ||
| 4. Ensure release inside `_release/package` directory is ok. | ||
| You can `cd _release/package && npm pack && npm install -g ./esy-*.tgz` to test how | ||
| release installs and feels. | ||
| 5. Run | ||
| ``` | ||
| % make release-publish | ||
| ``` | ||
| to upload the release on npm. | ||
| Use | ||
| ``` | ||
| % make NPM_RELEASE_TAG=next release-publish | ||
| ``` | ||
| to publish the release under `next` tag (so users won't get it automatically but | ||
| only explicitly requested). | ||
| 6. Bump version in `package.json` to the next patch version. | ||
| We expect the next version to be mostly a patch version. In case you | ||
| want to release new minor or major version you need to bump it before the | ||
| release. | ||
| [hello-ocaml]: https://github.com/esy-ocaml/hello-ocaml | ||
| [hello-reason]: https://github.com/esy-ocaml/hello-reason | ||
| [esy/esy]: https://github.com/esy/esy | ||
| [esy-ocaml/esy-opam]: https://github.com/esy-ocaml/esy-opam | ||
| [opam]: https://opam.ocaml.org | ||
| [npm]: https://npmjs.org | ||
| [reason]: https://reasonml.github.io | ||
| [ocaml]: https://ocaml.org | ||
| [dune]: http://dune.readthedocs.io | ||
| [ocamlbuild]: https://github.com/ocaml/ocamlbuild/blob/master/manual/manual.adoc | ||
| [pjc]: https://github.com/jordwalke/PackageJsonForCompilers | ||
| [NPM]: https://npmjs.org | ||
| [esy.sh]: http://esy.sh | ||
@@ -7,4 +7,3 @@ # esy | ||
| This README serves as a development documentation for esy. For user | ||
| documentation refer to [esy.sh][] documentation site. | ||
| Esy is a package manager for Reason and OCaml centered around the [NPM] workflow. Reason/OCaml are compiled languages and it can be daunting for developers to setup tools and develop a workflow that is intuitive and well documented. Developing apps that are natively compiled are also hard to reproduce and often require additional tooling. Esy tries address these, by offering a familiar `package.json` centered workflow and light-weight sandboxing. | ||
@@ -24,181 +23,18 @@ <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| ## Repository structure | ||
| ## Installation | ||
| The following snippet lists esy repository structured (omitting irrelevant or | ||
| obvious items) with further explanations: | ||
| Esy is available on NPM. | ||
| ├── CHANGELOG.md | ||
| ├── LICENSE | ||
| ├── README.md | ||
| │ | ||
| ├── Makefile | ||
| │ Common tasks and workflows for esy development. | ||
| │ | ||
| ├── bin/esy | ||
| │ symlink (wrapper on Windows) for esy command, used for running tests | ||
| │ | ||
| ├── bin/esyInstallRelease.js | ||
| │ postinstall step for npm releases produced with `esy npm-release` | ||
| │ command. This is a built JS file which is developed in a separate flow | ||
| │ inside `esy-install-npm-release/` subdirectory (see below). | ||
| │ | ||
| ├── docs | ||
| │ esy end user documentation in markdown format. | ||
| │ | ||
| ├── dune | ||
| ├── dune-project | ||
| │ | ||
| ├── esy | ||
| │ This dune library implements sandbox builder - a routine which builds | ||
| │ the entire dependency graph and provides other introspection APIs. | ||
| │ | ||
| ├── esy/bin | ||
| │ This dune executable implements "esy" command. | ||
| │ | ||
| ├── esy-solve | ||
| │ This dune library implements solver. | ||
| │ | ||
| ├── esy-install | ||
| │ This dune library implements installer. | ||
| │ | ||
| ├── esy-build-package | ||
| │ This dune library implements package builder. esy library uses this to | ||
| │ build each package. | ||
| │ | ||
| ├── esy-build-package/bin | ||
| │ This dune executable implements "esy-build-package" command. | ||
| │ | ||
| ├── esy-installer | ||
| │ Implementation of installation procedure defined with *.install files. | ||
| │ This re-implements opam-installer. | ||
| │ | ||
| ├── esy-install-npm-release | ||
| │ Sources for `bin/esyInstallRelease.js`. | ||
| │ | ||
| ├── esy-command-expression | ||
| │ Parser for #{...} syntax used in esy manifests. | ||
| │ | ||
| ├── esy-shell-expansion | ||
| │ A simple shell expansion. | ||
| │ | ||
| ├── esy-yarn-lockfile | ||
| │ Parser for a subset of yarn lockfile format. | ||
| │ | ||
| ├── esy-lib | ||
| │ A collection of utility modules shared between other libraries. | ||
| │ | ||
| ├── site | ||
| │ Sources for https://esy.sh | ||
| │ | ||
| ├── esy.lock | ||
| ├── package.json | ||
| │ | ||
| ├── scripts | ||
| │ | ||
| ├── test | ||
| │ Unit tests. | ||
| │ | ||
| ├── test-e2e-slow | ||
| │ End-to-end test suite which takes a significant amount of time. | ||
| │ We execute it on CI by placing `@slowtest` token in commit messages. | ||
| │ | ||
| └── test-e2e | ||
| End-to-end test suite. | ||
| ## Workflow | ||
| To make changes to `esy` and test them locally: | ||
| ``` | ||
| % git clone --recurse-submodules git://github.com/esy/esy.git | ||
| % cd esy # Change to the cloned directory | ||
| % esy # install and build dependencies | ||
| ``` | ||
| And then run newly built `esy` executable from anywhere by adding `PATH_TO_REPO/_build/install/default/bin` | ||
| to the $PATH during the shell's session. On Windows, append `PATH_TO_REPO/bin` too. | ||
| ### Updating `bin/esyInstallRelease.js` | ||
| `bin/esyInstallRelease.js` is developed separately within the `esy-install-npm-release/` directory. | ||
| Run: | ||
| ``` | ||
| % make bin/esyInstallRelease.js | ||
| ``` | ||
| to update the `bin/esyInstallRelease.js` file with the latest changed, don't | ||
| forget to commit it. | ||
| ### Running Tests | ||
| Run: | ||
| ``` | ||
| % make test | ||
| ``` | ||
| #### Slow tests | ||
| By placing `@slowtest` token in commit messages, we mark the commit ready for the slow tests framework | ||
| (tests that hit the network). They are run with `node test-e2e-slow/run-slow-tests.js` | ||
| #### Windows | ||
| In cases e2e tests fail with `Host key verification failed.`, you might have to create ssh keys | ||
| in the cygwin shall and add them to your github profile. | ||
| 1. Enter cygwin installed by esy (not the global one) | ||
| ```sh | ||
| .\node_modules\@prometheansacrifice\esy-bash\re\_build\default\bin\EsyBash.exe bash | ||
| npm i -g esy | ||
| ``` | ||
| 2. Generate ssh keys | ||
| ## Documentation | ||
| ```sh | ||
| ssh-keygen | ||
| ``` | ||
| You can find the Esy documentation [on the website](https://esy.sh/). You can also find them under the [docs folder](./docs) of the source tree. | ||
| 3. Add the public key to you Github profile | ||
| ## Contributing | ||
| 4. Add the following to the bash rc of the cygwin instance | ||
| Please refer the documents in [docs/contributing](./docs/contributing). You'll find instructions for building the source, CI setup, release process, esy internal concepts and other documentation to help you get started hacking on esy. You can also find them on the website [under the contributing section](https://esy.sh/docs/contributing/building-from-source) | ||
| ```sh | ||
| eval $(ssh-agent -s) | ||
| ssh-add ~/.ssh/id_rsa | ||
| ``` | ||
| ### Branches | ||
| There are two branches: | ||
| - `master` — the active development, we cut new versions out of there regularly. | ||
| - `0.0.x` — maintainance branch for 0.0.x releases. | ||
| - `0.2.x` — maintainance branch for 0.2.x releases. | ||
| - `0.3.x` — maintainance branch for 0.3.x releases. | ||
| ## Workflow for esy.sh | ||
| To make changes to [esy.sh][]: | ||
| 1. Bootstrap site's dev environment: | ||
| ``` | ||
| % make site-bootstrap | ||
| ``` | ||
| 2. Run site locally: | ||
| ``` | ||
| % make site-start | ||
| ``` | ||
| 3. When you are happy with the changes: | ||
| ``` | ||
| % make site-publish | ||
| ``` | ||
| ## Issues | ||
@@ -208,74 +44,13 @@ | ||
| ## Publishing Releases | ||
| ## History and motivation | ||
| esy is released on npm. | ||
| See [`package.json` for compilers](https://github.com/jordwalke/PackageJsonForCompilers) | ||
| Because esy is written in OCaml/Reason and compiled into a native executable we | ||
| need to acquire a set of prebuilt binaries for each supported platform (Windows, | ||
| macOS and Linux). We employ CI servers (thanks Azure) to build platform specific | ||
| releases. | ||
| ## Maintenance and Sponsorship | ||
| The release workflow is the following: | ||
| This project was originally authored by [Andrey Popp](https://github.com/andreypopp), and is currently maintained by [ManasJayanth](https://github.com/ManasJayanth). The project is currently not funded and could benefit from generous sponsorships. | ||
| 1. Ensure you are on `master` branch and assuming you want to release the | ||
| version currently defined in `package.json` (see step 6.), run | ||
| ``` | ||
| % make release-tag | ||
| % git push && git push --tags | ||
| ``` | ||
| 2. Wait till CI finishes its task and release `@esy-nightly/esy` package. | ||
| You can test it manually. | ||
| 3. Run | ||
| ``` | ||
| % make release-prepare | ||
| ``` | ||
| which downloads the nightly corresponding to the current commit working | ||
| directory is at and "promotes" it to a release. It will create | ||
| `_release/package` directory. | ||
| 4. Ensure release inside `_release/package` directory is ok. | ||
| You can `cd _release/package && npm pack && npm install -g ./esy-*.tgz` to test how | ||
| release installs and feels. | ||
| 5. Run | ||
| ``` | ||
| % make release-publish | ||
| ``` | ||
| to upload the release on npm. | ||
| Use | ||
| ``` | ||
| % make NPM_RELEASE_TAG=next release-publish | ||
| ``` | ||
| to publish the release under `next` tag (so users won't get it automatically but | ||
| only explicitly requested). | ||
| 6. Bump version in `package.json` to the next patch version. | ||
| We expect the next version to be mostly a patch version. In case you | ||
| want to release new minor or major version you need to bump it before the | ||
| release. | ||
| [hello-ocaml]: https://github.com/esy-ocaml/hello-ocaml | ||
| [hello-reason]: https://github.com/esy-ocaml/hello-reason | ||
| [esy/esy]: https://github.com/esy/esy | ||
| [esy-ocaml/esy-opam]: https://github.com/esy-ocaml/esy-opam | ||
| [opam]: https://opam.ocaml.org | ||
| [npm]: https://npmjs.org | ||
| [reason]: https://reasonml.github.io | ||
| [ocaml]: https://ocaml.org | ||
| [dune]: http://dune.readthedocs.io | ||
| [ocamlbuild]: https://github.com/ocaml/ocamlbuild/blob/master/manual/manual.adoc | ||
| [pjc]: https://github.com/jordwalke/PackageJsonForCompilers | ||
| [NPM]: https://npmjs.org | ||
| [esy.sh]: http://esy.sh | ||
@@ -7,4 +7,3 @@ # esy | ||
| This README serves as a development documentation for esy. For user | ||
| documentation refer to [esy.sh][] documentation site. | ||
| Esy is a package manager for Reason and OCaml centered around the [NPM] workflow. Reason/OCaml are compiled languages and it can be daunting for developers to setup tools and develop a workflow that is intuitive and well documented. Developing apps that are natively compiled are also hard to reproduce and often require additional tooling. Esy tries address these, by offering a familiar `package.json` centered workflow and light-weight sandboxing. | ||
@@ -24,181 +23,18 @@ <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| ## Repository structure | ||
| ## Installation | ||
| The following snippet lists esy repository structured (omitting irrelevant or | ||
| obvious items) with further explanations: | ||
| Esy is available on NPM. | ||
| ├── CHANGELOG.md | ||
| ├── LICENSE | ||
| ├── README.md | ||
| │ | ||
| ├── Makefile | ||
| │ Common tasks and workflows for esy development. | ||
| │ | ||
| ├── bin/esy | ||
| │ symlink (wrapper on Windows) for esy command, used for running tests | ||
| │ | ||
| ├── bin/esyInstallRelease.js | ||
| │ postinstall step for npm releases produced with `esy npm-release` | ||
| │ command. This is a built JS file which is developed in a separate flow | ||
| │ inside `esy-install-npm-release/` subdirectory (see below). | ||
| │ | ||
| ├── docs | ||
| │ esy end user documentation in markdown format. | ||
| │ | ||
| ├── dune | ||
| ├── dune-project | ||
| │ | ||
| ├── esy | ||
| │ This dune library implements sandbox builder - a routine which builds | ||
| │ the entire dependency graph and provides other introspection APIs. | ||
| │ | ||
| ├── esy/bin | ||
| │ This dune executable implements "esy" command. | ||
| │ | ||
| ├── esy-solve | ||
| │ This dune library implements solver. | ||
| │ | ||
| ├── esy-install | ||
| │ This dune library implements installer. | ||
| │ | ||
| ├── esy-build-package | ||
| │ This dune library implements package builder. esy library uses this to | ||
| │ build each package. | ||
| │ | ||
| ├── esy-build-package/bin | ||
| │ This dune executable implements "esy-build-package" command. | ||
| │ | ||
| ├── esy-installer | ||
| │ Implementation of installation procedure defined with *.install files. | ||
| │ This re-implements opam-installer. | ||
| │ | ||
| ├── esy-install-npm-release | ||
| │ Sources for `bin/esyInstallRelease.js`. | ||
| │ | ||
| ├── esy-command-expression | ||
| │ Parser for #{...} syntax used in esy manifests. | ||
| │ | ||
| ├── esy-shell-expansion | ||
| │ A simple shell expansion. | ||
| │ | ||
| ├── esy-yarn-lockfile | ||
| │ Parser for a subset of yarn lockfile format. | ||
| │ | ||
| ├── esy-lib | ||
| │ A collection of utility modules shared between other libraries. | ||
| │ | ||
| ├── site | ||
| │ Sources for https://esy.sh | ||
| │ | ||
| ├── esy.lock | ||
| ├── package.json | ||
| │ | ||
| ├── scripts | ||
| │ | ||
| ├── test | ||
| │ Unit tests. | ||
| │ | ||
| ├── test-e2e-slow | ||
| │ End-to-end test suite which takes a significant amount of time. | ||
| │ We execute it on CI by placing `@slowtest` token in commit messages. | ||
| │ | ||
| └── test-e2e | ||
| End-to-end test suite. | ||
| ## Workflow | ||
| To make changes to `esy` and test them locally: | ||
| ``` | ||
| % git clone --recurse-submodules git://github.com/esy/esy.git | ||
| % cd esy # Change to the cloned directory | ||
| % esy # install and build dependencies | ||
| ``` | ||
| And then run newly built `esy` executable from anywhere by adding `PATH_TO_REPO/_build/install/default/bin` | ||
| to the $PATH during the shell's session. On Windows, append `PATH_TO_REPO/bin` too. | ||
| ### Updating `bin/esyInstallRelease.js` | ||
| `bin/esyInstallRelease.js` is developed separately within the `esy-install-npm-release/` directory. | ||
| Run: | ||
| ``` | ||
| % make bin/esyInstallRelease.js | ||
| ``` | ||
| to update the `bin/esyInstallRelease.js` file with the latest changed, don't | ||
| forget to commit it. | ||
| ### Running Tests | ||
| Run: | ||
| ``` | ||
| % make test | ||
| ``` | ||
| #### Slow tests | ||
| By placing `@slowtest` token in commit messages, we mark the commit ready for the slow tests framework | ||
| (tests that hit the network). They are run with `node test-e2e-slow/run-slow-tests.js` | ||
| #### Windows | ||
| In cases e2e tests fail with `Host key verification failed.`, you might have to create ssh keys | ||
| in the cygwin shall and add them to your github profile. | ||
| 1. Enter cygwin installed by esy (not the global one) | ||
| ```sh | ||
| .\node_modules\@prometheansacrifice\esy-bash\re\_build\default\bin\EsyBash.exe bash | ||
| npm i -g esy | ||
| ``` | ||
| 2. Generate ssh keys | ||
| ## Documentation | ||
| ```sh | ||
| ssh-keygen | ||
| ``` | ||
| You can find the Esy documentation [on the website](https://esy.sh/). You can also find them under the [docs folder](./docs) of the source tree. | ||
| 3. Add the public key to you Github profile | ||
| ## Contributing | ||
| 4. Add the following to the bash rc of the cygwin instance | ||
| Please refer the documents in [docs/contributing](./docs/contributing). You'll find instructions for building the source, CI setup, release process, esy internal concepts and other documentation to help you get started hacking on esy. You can also find them on the website [under the contributing section](https://esy.sh/docs/contributing/building-from-source) | ||
| ```sh | ||
| eval $(ssh-agent -s) | ||
| ssh-add ~/.ssh/id_rsa | ||
| ``` | ||
| ### Branches | ||
| There are two branches: | ||
| - `master` — the active development, we cut new versions out of there regularly. | ||
| - `0.0.x` — maintainance branch for 0.0.x releases. | ||
| - `0.2.x` — maintainance branch for 0.2.x releases. | ||
| - `0.3.x` — maintainance branch for 0.3.x releases. | ||
| ## Workflow for esy.sh | ||
| To make changes to [esy.sh][]: | ||
| 1. Bootstrap site's dev environment: | ||
| ``` | ||
| % make site-bootstrap | ||
| ``` | ||
| 2. Run site locally: | ||
| ``` | ||
| % make site-start | ||
| ``` | ||
| 3. When you are happy with the changes: | ||
| ``` | ||
| % make site-publish | ||
| ``` | ||
| ## Issues | ||
@@ -208,74 +44,13 @@ | ||
| ## Publishing Releases | ||
| ## History and motivation | ||
| esy is released on npm. | ||
| See [`package.json` for compilers](https://github.com/jordwalke/PackageJsonForCompilers) | ||
| Because esy is written in OCaml/Reason and compiled into a native executable we | ||
| need to acquire a set of prebuilt binaries for each supported platform (Windows, | ||
| macOS and Linux). We employ CI servers (thanks Azure) to build platform specific | ||
| releases. | ||
| ## Maintenance and Sponsorship | ||
| The release workflow is the following: | ||
| This project was originally authored by [Andrey Popp](https://github.com/andreypopp), and is currently maintained by [ManasJayanth](https://github.com/ManasJayanth). The project is currently not funded and could benefit from generous sponsorships. | ||
| 1. Ensure you are on `master` branch and assuming you want to release the | ||
| version currently defined in `package.json` (see step 6.), run | ||
| ``` | ||
| % make release-tag | ||
| % git push && git push --tags | ||
| ``` | ||
| 2. Wait till CI finishes its task and release `@esy-nightly/esy` package. | ||
| You can test it manually. | ||
| 3. Run | ||
| ``` | ||
| % make release-prepare | ||
| ``` | ||
| which downloads the nightly corresponding to the current commit working | ||
| directory is at and "promotes" it to a release. It will create | ||
| `_release/package` directory. | ||
| 4. Ensure release inside `_release/package` directory is ok. | ||
| You can `cd _release/package && npm pack && npm install -g ./esy-*.tgz` to test how | ||
| release installs and feels. | ||
| 5. Run | ||
| ``` | ||
| % make release-publish | ||
| ``` | ||
| to upload the release on npm. | ||
| Use | ||
| ``` | ||
| % make NPM_RELEASE_TAG=next release-publish | ||
| ``` | ||
| to publish the release under `next` tag (so users won't get it automatically but | ||
| only explicitly requested). | ||
| 6. Bump version in `package.json` to the next patch version. | ||
| We expect the next version to be mostly a patch version. In case you | ||
| want to release new minor or major version you need to bump it before the | ||
| release. | ||
| [hello-ocaml]: https://github.com/esy-ocaml/hello-ocaml | ||
| [hello-reason]: https://github.com/esy-ocaml/hello-reason | ||
| [esy/esy]: https://github.com/esy/esy | ||
| [esy-ocaml/esy-opam]: https://github.com/esy-ocaml/esy-opam | ||
| [opam]: https://opam.ocaml.org | ||
| [npm]: https://npmjs.org | ||
| [reason]: https://reasonml.github.io | ||
| [ocaml]: https://ocaml.org | ||
| [dune]: http://dune.readthedocs.io | ||
| [ocamlbuild]: https://github.com/ocaml/ocamlbuild/blob/master/manual/manual.adoc | ||
| [pjc]: https://github.com/jordwalke/PackageJsonForCompilers | ||
| [NPM]: https://npmjs.org | ||
| [esy.sh]: http://esy.sh | ||
@@ -19,8 +19,2 @@ /** | ||
| var packageJson = require('./package.json'); | ||
| var binariesToCopy = Object.keys(packageJson.bin) | ||
| .map(function (name) { | ||
| return packageJson.bin[name]; | ||
| }) | ||
| .concat(['esyInstallRelease.js']); | ||
| var foldersToCopy = ['bin', '_export']; | ||
@@ -133,6 +127,19 @@ function copyRecursive(srcDir, dstDir) { | ||
| let foldersToCopy, binariesToCopy; | ||
| binariesToCopy = Object.keys(packageJson.bin).map(function (name) { | ||
| return packageJson.bin[name]; | ||
| }); | ||
| if (platformPath === 'linux') { | ||
| fs.mkdirSync(path.join(__dirname, 'lib')); | ||
| foldersToCopy = ['bin', 'lib']; | ||
| } else { | ||
| foldersToCopy = ['bin', '_export']; | ||
| binariesToCopy = binariesToCopy.concat(['esyInstallRelease.js']); | ||
| } | ||
| foldersToCopy.forEach((folderPath) => { | ||
| var sourcePath = path.join(platformBuildPath, folderPath); | ||
| var destPath = path.join(__dirname, folderPath); | ||
| copyRecursive(sourcePath, destPath); | ||
@@ -149,2 +156,8 @@ }); | ||
| }); | ||
| if (platformPath === 'linux') { | ||
| fs.chmodSync(path.join(__dirname, 'lib', 'esy', 'esyBuildPackageCommand'), 0755); | ||
| fs.chmodSync(path.join(__dirname, 'lib', 'esy', 'esySolveCudfCommand'), 0755); | ||
| fs.chmodSync(path.join(__dirname, 'lib', 'esy', 'esyRewritePrefixCommand'), 0755); | ||
| } | ||
| }; | ||
@@ -171,7 +184,11 @@ | ||
| console.log('Native compiler toolchain installed successfully.'); | ||
| require('./esyInstallRelease'); | ||
| break; | ||
| case 'linux': | ||
| copyPlatformBinaries(platform); | ||
| // Statically linked binaries dont need postinstall scripts | ||
| break; | ||
| case 'linux': | ||
| case 'darwin': | ||
| copyPlatformBinaries(platform + (process.arch === 'x64' ? '' : '-arm64')); | ||
| require('./esyInstallRelease'); | ||
| break; | ||
@@ -182,3 +199,1 @@ default: | ||
| } | ||
| require('./esyInstallRelease'); |
253
README.md
@@ -7,4 +7,3 @@ # esy | ||
| This README serves as a development documentation for esy. For user | ||
| documentation refer to [esy.sh][] documentation site. | ||
| Esy is a package manager for Reason and OCaml centered around the [NPM] workflow. Reason/OCaml are compiled languages and it can be daunting for developers to setup tools and develop a workflow that is intuitive and well documented. Developing apps that are natively compiled are also hard to reproduce and often require additional tooling. Esy tries address these, by offering a familiar `package.json` centered workflow and light-weight sandboxing. | ||
@@ -24,181 +23,18 @@ <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| ## Repository structure | ||
| ## Installation | ||
| The following snippet lists esy repository structured (omitting irrelevant or | ||
| obvious items) with further explanations: | ||
| Esy is available on NPM. | ||
| ├── CHANGELOG.md | ||
| ├── LICENSE | ||
| ├── README.md | ||
| │ | ||
| ├── Makefile | ||
| │ Common tasks and workflows for esy development. | ||
| │ | ||
| ├── bin/esy | ||
| │ symlink (wrapper on Windows) for esy command, used for running tests | ||
| │ | ||
| ├── bin/esyInstallRelease.js | ||
| │ postinstall step for npm releases produced with `esy npm-release` | ||
| │ command. This is a built JS file which is developed in a separate flow | ||
| │ inside `esy-install-npm-release/` subdirectory (see below). | ||
| │ | ||
| ├── docs | ||
| │ esy end user documentation in markdown format. | ||
| │ | ||
| ├── dune | ||
| ├── dune-project | ||
| │ | ||
| ├── esy | ||
| │ This dune library implements sandbox builder - a routine which builds | ||
| │ the entire dependency graph and provides other introspection APIs. | ||
| │ | ||
| ├── esy/bin | ||
| │ This dune executable implements "esy" command. | ||
| │ | ||
| ├── esy-solve | ||
| │ This dune library implements solver. | ||
| │ | ||
| ├── esy-install | ||
| │ This dune library implements installer. | ||
| │ | ||
| ├── esy-build-package | ||
| │ This dune library implements package builder. esy library uses this to | ||
| │ build each package. | ||
| │ | ||
| ├── esy-build-package/bin | ||
| │ This dune executable implements "esy-build-package" command. | ||
| │ | ||
| ├── esy-installer | ||
| │ Implementation of installation procedure defined with *.install files. | ||
| │ This re-implements opam-installer. | ||
| │ | ||
| ├── esy-install-npm-release | ||
| │ Sources for `bin/esyInstallRelease.js`. | ||
| │ | ||
| ├── esy-command-expression | ||
| │ Parser for #{...} syntax used in esy manifests. | ||
| │ | ||
| ├── esy-shell-expansion | ||
| │ A simple shell expansion. | ||
| │ | ||
| ├── esy-yarn-lockfile | ||
| │ Parser for a subset of yarn lockfile format. | ||
| │ | ||
| ├── esy-lib | ||
| │ A collection of utility modules shared between other libraries. | ||
| │ | ||
| ├── site | ||
| │ Sources for https://esy.sh | ||
| │ | ||
| ├── esy.lock | ||
| ├── package.json | ||
| │ | ||
| ├── scripts | ||
| │ | ||
| ├── test | ||
| │ Unit tests. | ||
| │ | ||
| ├── test-e2e-slow | ||
| │ End-to-end test suite which takes a significant amount of time. | ||
| │ We execute it on CI by placing `@slowtest` token in commit messages. | ||
| │ | ||
| └── test-e2e | ||
| End-to-end test suite. | ||
| ## Workflow | ||
| To make changes to `esy` and test them locally: | ||
| ``` | ||
| % git clone --recurse-submodules git://github.com/esy/esy.git | ||
| % cd esy # Change to the cloned directory | ||
| % esy # install and build dependencies | ||
| ``` | ||
| And then run newly built `esy` executable from anywhere by adding `PATH_TO_REPO/_build/install/default/bin` | ||
| to the $PATH during the shell's session. On Windows, append `PATH_TO_REPO/bin` too. | ||
| ### Updating `bin/esyInstallRelease.js` | ||
| `bin/esyInstallRelease.js` is developed separately within the `esy-install-npm-release/` directory. | ||
| Run: | ||
| ``` | ||
| % make bin/esyInstallRelease.js | ||
| ``` | ||
| to update the `bin/esyInstallRelease.js` file with the latest changed, don't | ||
| forget to commit it. | ||
| ### Running Tests | ||
| Run: | ||
| ``` | ||
| % make test | ||
| ``` | ||
| #### Slow tests | ||
| By placing `@slowtest` token in commit messages, we mark the commit ready for the slow tests framework | ||
| (tests that hit the network). They are run with `node test-e2e-slow/run-slow-tests.js` | ||
| #### Windows | ||
| In cases e2e tests fail with `Host key verification failed.`, you might have to create ssh keys | ||
| in the cygwin shall and add them to your github profile. | ||
| 1. Enter cygwin installed by esy (not the global one) | ||
| ```sh | ||
| .\node_modules\@prometheansacrifice\esy-bash\re\_build\default\bin\EsyBash.exe bash | ||
| npm i -g esy | ||
| ``` | ||
| 2. Generate ssh keys | ||
| ## Documentation | ||
| ```sh | ||
| ssh-keygen | ||
| ``` | ||
| You can find the Esy documentation [on the website](https://esy.sh/). You can also find them under the [docs folder](./docs) of the source tree. | ||
| 3. Add the public key to you Github profile | ||
| ## Contributing | ||
| 4. Add the following to the bash rc of the cygwin instance | ||
| Please refer the documents in [docs/contributing](./docs/contributing). You'll find instructions for building the source, CI setup, release process, esy internal concepts and other documentation to help you get started hacking on esy. You can also find them on the website [under the contributing section](https://esy.sh/docs/contributing/building-from-source) | ||
| ```sh | ||
| eval $(ssh-agent -s) | ||
| ssh-add ~/.ssh/id_rsa | ||
| ``` | ||
| ### Branches | ||
| There are two branches: | ||
| - `master` — the active development, we cut new versions out of there regularly. | ||
| - `0.0.x` — maintainance branch for 0.0.x releases. | ||
| - `0.2.x` — maintainance branch for 0.2.x releases. | ||
| - `0.3.x` — maintainance branch for 0.3.x releases. | ||
| ## Workflow for esy.sh | ||
| To make changes to [esy.sh][]: | ||
| 1. Bootstrap site's dev environment: | ||
| ``` | ||
| % make site-bootstrap | ||
| ``` | ||
| 2. Run site locally: | ||
| ``` | ||
| % make site-start | ||
| ``` | ||
| 3. When you are happy with the changes: | ||
| ``` | ||
| % make site-publish | ||
| ``` | ||
| ## Issues | ||
@@ -208,74 +44,13 @@ | ||
| ## Publishing Releases | ||
| ## History and motivation | ||
| esy is released on npm. | ||
| See [`package.json` for compilers](https://github.com/jordwalke/PackageJsonForCompilers) | ||
| Because esy is written in OCaml/Reason and compiled into a native executable we | ||
| need to acquire a set of prebuilt binaries for each supported platform (Windows, | ||
| macOS and Linux). We employ CI servers (thanks Azure) to build platform specific | ||
| releases. | ||
| ## Maintenance and Sponsorship | ||
| The release workflow is the following: | ||
| This project was originally authored by [Andrey Popp](https://github.com/andreypopp), and is currently maintained by [ManasJayanth](https://github.com/ManasJayanth). The project is currently not funded and could benefit from generous sponsorships. | ||
| 1. Ensure you are on `master` branch and assuming you want to release the | ||
| version currently defined in `package.json` (see step 6.), run | ||
| ``` | ||
| % make release-tag | ||
| % git push && git push --tags | ||
| ``` | ||
| 2. Wait till CI finishes its task and release `@esy-nightly/esy` package. | ||
| You can test it manually. | ||
| 3. Run | ||
| ``` | ||
| % make release-prepare | ||
| ``` | ||
| which downloads the nightly corresponding to the current commit working | ||
| directory is at and "promotes" it to a release. It will create | ||
| `_release/package` directory. | ||
| 4. Ensure release inside `_release/package` directory is ok. | ||
| You can `cd _release/package && npm pack && npm install -g ./esy-*.tgz` to test how | ||
| release installs and feels. | ||
| 5. Run | ||
| ``` | ||
| % make release-publish | ||
| ``` | ||
| to upload the release on npm. | ||
| Use | ||
| ``` | ||
| % make NPM_RELEASE_TAG=next release-publish | ||
| ``` | ||
| to publish the release under `next` tag (so users won't get it automatically but | ||
| only explicitly requested). | ||
| 6. Bump version in `package.json` to the next patch version. | ||
| We expect the next version to be mostly a patch version. In case you | ||
| want to release new minor or major version you need to bump it before the | ||
| release. | ||
| [hello-ocaml]: https://github.com/esy-ocaml/hello-ocaml | ||
| [hello-reason]: https://github.com/esy-ocaml/hello-reason | ||
| [esy/esy]: https://github.com/esy/esy | ||
| [esy-ocaml/esy-opam]: https://github.com/esy-ocaml/esy-opam | ||
| [opam]: https://opam.ocaml.org | ||
| [npm]: https://npmjs.org | ||
| [reason]: https://reasonml.github.io | ||
| [ocaml]: https://ocaml.org | ||
| [dune]: http://dune.readthedocs.io | ||
| [ocamlbuild]: https://github.com/ocaml/ocamlbuild/blob/master/manual/manual.adoc | ||
| [pjc]: https://github.com/jordwalke/PackageJsonForCompilers | ||
| [NPM]: https://npmjs.org | ||
| [esy.sh]: http://esy.sh | ||
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Native code
Supply chain riskContains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.
Found 6 instances in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Install scripts
Supply chain riskInstall scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.
Found 1 instance in 1 package
Native code
Supply chain riskContains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.
Found 4 instances in 1 package
Improved metrics
- Total package byte prevSize
- increased by57.46%
169350162
- Number of package files
- increased by9.68%
34
- Lines of code
- increased by0.03%
46030
- Number of high supply chain risk alerts
- decreased by-20%
4
Worsened metrics
- Number of lines in readme file
- decreased by-80.65%
54
- Number of medium supply chain risk alerts
- increased by6.06%
35
No dependency changes