@jupiterone/integration-sdk-dev-tools

@jupiterone/integration-sdk-dev-tools

This package contains some common dependencies and configuration files used in JupiterOne integrations.

This module is opinionated and bundles in the following dependencies:

• typescript
• prettier
• jest
• eslint
• husky
• lint-staged

For convenience, this package also comes bundled with the @jupiterone/integration-sdk-cli module.

Installation

npm install -D @jupiterone/integration-sdk-dev-tools

# or

yarn add -D @jupiterone/integration-sdk-dev-tools

Usage

Create prettier.config.js at root of your project that contains:

module.exports = require('@jupiterone/integration-sdk-dev-tools/config/prettier');

Create lint-staged.config.js at root of your project that contains:

module.exports = require('@jupiterone/integration-sdk-dev-tools/config/lint-staged');

Create husky.config.js at root of your project that contains:

module.exports = require('@jupiterone/integration-sdk-dev-tools/config/husky');

Create jest.config.js at root of your project that contains:

module.exports = require('@jupiterone/integration-sdk-dev-tools/config/jest');

Create tsconfig.json at root of your project that contains:

{
  "extends": "./node_modules/@jupiterone/integration-sdk-dev-tools/config/typescript",
  "compilerOptions": {
    "outDir": "dist"
  },
  "exclude": ["dist"]
}

Create a .eslintrc at the root of your project that contains:

{
  "root": true,
  "extends": [
    "./node_modules/@jupiterone/integration-sdk-dev-tools/config/eslint.json"
  ]
}

Changelog

[6.16.0] - 2021-08-25

Added

• Add j1-integration collect --project-path to allow for executing against a project in any location
• Add j1-integration sync --project-path to allow for executing against a project in any location
• Add j1-integration run --project-path to allow for executing against a project in any location
• Add j1-integration run --development to match other commands that connect to JupiterOne development environment
• Add j1-integration visualize --output-file to allow for specifying the output file path
• Add the j1-integration visualize --data-dir value to the error content of the generated file when there were no entities or relationships to render

Changed

• Improve grammar and consistency of CLI help content
• Change j1-integration visualize --data-dir to support absolute path, complementing added support for --project-path on other commands

Fixed

• Fix j1-integration document --output-file to reflect that it is a path relative to --project-path
• Fixed the way that symlinks are created on windows machines, which previously threw EPERM: operation not permitted, symlink