Getting Started

Requirements

  • Node.js 10+
  • npm or Yarn

Installation

This package is hosted on GitHub Packages, so you must tell to npm/yarn where to download it. Please read Authenticating to GitHub Packages.

You can run npm login --registry=https://npm.pkg.github.com --scope=@yproximite or create a .npmrc file with the following content:

@yproximite:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=<access token>

Then run:

$ yarn add --dev @yproximite/yprox-cli

Linting JavaScript

If you plan to use yProx-CLI to lint your JavaScript, you need to install ESLint too:

$ yarn add --dev 'eslint@>=5.0.0'

Linting CSS and Sass

If you plan to use yProx-CLI to lint your CSS and Sass, you need to install Stylelint too:

$ yarn add --dev 'stylelint@>=9.0.0'

Vue support

You will need to install vue-template-compiler (which should match your Vue version) to build .vue files:

$ yarn add --dev 'vue-template-compiler@>=2.0.0'