Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 1.66 KB

README.md

File metadata and controls

57 lines (45 loc) · 1.66 KB
Raw

Gwen-Web NPM Package

Easily add Gwen-Web to your existing JS projects!

Setup

For npm users:

npm i --save-dev @gweninterpreter/gwen-web
npm run gwen init

For Yarn users:

yarn add -D @gweninterpreter/gwen-web
yarn gwen init

For pnpm users:

pnpm add -D @gweninterpreter/gwen-web
pnpm gwen init

Configuration options

The behaviour of the Gwen launcher can be customized through setting some options in package.json, under the gwenWeb key:

  • version: Specifies the version of Gwen-Web to download. Can either be a version number, a semver range, or the string latest, in which case the latest version of Gwen-Web will be used. Defaults to latest.
  • mavenRepo: Specifies the Maven repo to download Gwen-Web from. Useful if you have eg. a local Artifactory instance to cache Gwen-Web in. Defaults to Maven Central (https://repo1.maven.org/maven2/).
  • mavenSnapshotRepo: Specifies the Maven repo to download Gwen-Web from when version is a snapshot version (ie. contains the string SNAPSHOT). Defaults to Sonatype Snapshots (https://s01.oss.sonatype.org/content/repositories/snapshots/).

The version specified in package.json can also be overridden using the GWEN_WEB_VERSION environment variable. It accepts the same values as version described above, and will take precedence over the version specified in package.json if it exists.

License

Copyright 2021-2024 Ruby Juric

This software is open sourced under the Apache License, Version 2.0.

See also: LICENSE.