@activeprospect/integration-dev-dependencies

Integration Dev Dependencies

Centralizes management and updates of common devDependencies used by LeadConduit integrations.

Migrating to Vue 3

[!IMPORTANT]
The master branch should be used for all Vue 3 development. Releases that depened on Vue3 are versioned 2.x and above.

The vue2 branch is a long-lived branch intended to facilitate development of versions of this library which depend on Vue2 and Vue3 simultaneously. Releases that depend on Vue 3 must be merged into the vue2 branch, and released under version 1.x.x. If new versions of this library need to be released with a Vue2 dependency, you must select the vue2 branch when running the "Publish to npm registry" GitHub Action

How to migrate an integration to Vue 3:

1. Install the latest version of this library, at least 2.x: npm i --save-dev @activeprospect/integration-dev-dependencies@2
2. Install the latest version of integration-components if needed, at least 5.x: npm i --save @activeprospect/integration-components@5
3. Update the integration's dependencies, and make the required changes to the app creation, store creation, and router configuration. See leadconduit-trustedform #108 for an example of the required changes to migrate to Vue 3.

Usage

Note that in this package, they're listed as dependencies, but in your integration module, this should in fact be included as an entry in devDependencies:

npm install --save-dev @activeprospect/integration-dev-dependencies

Conversion

To convert old integrations to use this package, you can run its convert.js script. Once the package is added to devDependencies (see above), just run:

npx convert

This will correct ESLint configuration, modify a few source files if needed, and update package.json with revised dependencies, as well as a few new scripts: fixlint, lint, and watch (if the integration has a UI).

Linting

Installation of this package installs the ESLint configuration file .eslintrc.js via symbolic link to the parent package.

This can be used by your IDE, or run via npm scripts: npm run lint or npm run fixlint.

Live webpacking with watch

Instead of using webpack-dev-middleware, this package supports live updating of webpacked rich UI (RUI) files during development via Webpack's "watch" functionality.

In a separate terminal session from your local LeadConduit server, run npm run watch. This updates the webpacked source used by the RUI, and then stays running. Whenever one of the RUI files is updated (though not /api code, which runs server-side), this will rerun webpack automatically. This allows changes to be made and reloaded more quickly and easily in the browser while developing.