@appsignal/stimulus

@appsignal/stimulus

• AppSignal.com website
• Documentation
• Support

The @appsignal/javascript integration for Stimulus v1.1+.

See also the mono repo README for more information.

Installation

Add the @appsignal/stimulus and @appsignal/javascript packages to your package.json. Then, run yarn install/npm install.

You can also add these packages to your package.json on the command line:

yarn add @appsignal/javascript @appsignal/stimulus
npm install --save @appsignal/javascript @appsignal/stimulus

Usage

Application.handleError

The default Stimulus integration is a function that binds to the Application.handleError property. In a new app created using rails new $APP_NAME --webpack=stimulus, for example, your javascript/controllers/index.js file would look something like this:

import { Application } from "stimulus"
import { definitionsFromContext } from "stimulus/webpack-helpers"

import Appsignal from "@appsignal/javascript"
import { installErrorHandler } from "@appsignal/stimulus"

const appsignal = new Appsignal({
  key: "YOUR FRONTEND API KEY"
})

const application = Application.start()
installErrorHandler(appsignal, application)
const context = require.context("controllers", true, /_controller\.js$/)
application.load(definitionsFromContext(context))

Development

Installation

Make sure mono is installed and bootstrapped, see the project README's development section for more information.

You can then run the following to start the compiler in watch mode in this sub directory. This automatically compiles both the ES Module and CommonJS variants:

yarn build:watch

You can also build the library without watching the directory:

yarn build        # build both CJS and ESM
yarn build:cjs    # just CJS
yarn build:esm    # just ESM

Testing

The tests for this library use Jest as the test runner. Once you've installed the dependencies, you can run the following command in the root of this repository to run the tests for all packages, or in the directory of a package to run only the tests pertaining to that package:

yarn test

Versioning

This repo uses Semantic Versioning (often referred to as semver). Each package in the repository is versioned independently from one another.

@TODO: define how this works once we know more about releasing

Contributing

Thinking of contributing to this repo? Awesome! 🚀

Please follow our Contributing guide in our documentation and follow our Code of Conduct.

Also, we would be very happy to send you Stroopwafles. Have look at everyone we send a package to so far on our Stroopwafles page.

Support

Contact us and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.