Skip to content

adobe/aio-cli-plugin-app-dev

aio-cli-plugin-app-dev

oclif Version Downloads/week Node.js CI License Codecov Coverage

  • This command is a new way of looking at local development. This uses the approach of a simulator, rather than an emulator.
  • Supports ESM, and TypeScript actions.
  • App Builder Debugging Docs

Commands

aio app dev

Run your App Builder app locally

USAGE
  $ aio app dev [-v] [--version] [-o] [-e <value>]

FLAGS
  -e, --extension=<value>  Run only a specific extension, this flag can only be specified once
  -o, --open               Open the default web browser after a successful run, only valid if your app has a front-end
  -v, --verbose            Verbose output
  --version                Show version

DESCRIPTION
  Run your App Builder app locally

See code: src/commands/app/dev/index.js

Overriding the hostname and port

By default the hostname will be localhost and the default port is 9080. You can override these values by setting these environment variables:

  1. SERVER_HOST
  2. SERVER_DEFAULT_PORT

The command will try to use the default port, if it is not available it will find an open port to use instead.

Visual Studio Code Webpack Debugging Support (Source Maps)

To enable step-by-step debugging in Visual Studio Code for your webpacked code, you will have to add source map support by adding a custom webpack config.

In the root of your project, add a webpack-config.js file:

module.exports = {
  devtool: 'inline-source-map'
}

TypeScript Support

Install these node modules in your app: npm install --save-dev ts-loader typescript

In the root of your project, add a webpack-config.js file:

module.exports = {
  devtool: 'inline-source-map',
  module: {
    rules: [
      {
        // includes, excludes are in tsconfig.json
        test: /\.ts?$/,
        exclude: /node_modules/,
        use: 'ts-loader'
      }
    ]
  }
}

In the root of your project, add a tsconfig.json file:

{
  "exclude": ["node_modules", "dist"],
  "compilerOptions": {
    "target": "ES6",
    "module": "ES6",
    "sourceMap": true
  }
}

There is a Visual Studio Code issue with TypeScript and inspecting variables by hovering your mouse over them:

microsoft/vscode#221503

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.