https://github.com/cloudquery/plugin-sdk-javascript

https://github.com/cloudquery/plugin-sdk-javascript

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cloudquery/plugin-sdk-javascript
• Owner: cloudquery
• License: mpl-2.0
• Created: 2023-08-02T18:27:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-04T09:09:00.000Z (about 2 months ago)
• Last Synced: 2024-11-04T09:11:24.758Z (about 2 months ago)
• Language: TypeScript
• Size: 937 KB
• Stars: 3
• Watchers: 6
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# CloudQuery Plugin SDK for JavaScript

This is the high-level package to use for developing CloudQuery plugins in JavaScript.

## Prerequisites

Node.js 20 or higher. Install Node.js from [here](https://nodejs.org/en/download/).

## Setup

### Install dependencies

```bash

npm ci

```

### Build

```bash

npm run build

```

### Test

```bash

npm test

```

### Start a local memory based plugin server

```bash

npm run dev -- serve

```

### Package as a Docker image

```bash

npm run dev -- package -m test "v1.0.0" . --dist-dir dist-dir

```

### Formatting and Linting

```bash

# This is just to check if the code is formatted

npm run format:check

# Automatically format code

npm run format

# Lint

npm run lint

```