feat: Add package command (#106)

Author: erezrokah

.dockerignore

@@ -0,0 +1,4 @@
+dist-dir
+node_modules
+npm-debug.log
+.env

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '20'
           cache: 'npm'
 
       - name: Install dependencies
@@ -31,12 +31,17 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '20'
           cache: 'npm'
 
       - name: Install dependencies
         run: npm ci
 
+      -
+        # Required for the package command tests to work
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
       - name: Test
         run: |
           npm test
@@ -47,7 +52,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '20'
           cache: 'npm'
 
       - name: Install dependencies
@@ -63,7 +68,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '20'
           cache: 'npm'
 
       - name: Install dependencies

.gitignore

@@ -132,3 +132,6 @@ dist
 # Editor settings
 .idea
 .vscode
+
+dist-dir
+.DS_Store

Dockerfile

@@ -0,0 +1,27 @@
+FROM node:20-slim as builder
+
+WORKDIR /app
+
+COPY package*.json ./
+
+RUN npm ci
+
+COPY . .
+
+RUN npm run build
+
+FROM node:20-slim AS final
+
+WORKDIR /app
+
+COPY --from=builder ./app/dist ./dist
+
+COPY package*.json ./
+
+RUN npm ci --omit=dev
+
+EXPOSE 7777
+
+ENTRYPOINT ["node", "dist/main.js"]
+
+CMD [ "serve", "--address", "[::]:7777", "--log-format", "json", "--log-level", "info" ]

README.md

@@ -4,7 +4,7 @@ This is the high-level package to use for developing CloudQuery plugins in JavaS
 
 ## Prerequisites
 
-Node.js 16 or higher. Install Node.js from [here](https://nodejs.org/en/download/).
+Node.js 20 or higher. Install Node.js from [here](https://nodejs.org/en/download/).
 
 ## Setup
 
@@ -29,7 +29,13 @@ npm test
 ### Start a local memory based plugin server
 
 ```bash
-npm run dev
+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

docs/overview.md

@@ -0,0 +1,3 @@
+# MemDB Plugin
+
+Test docs for the MemDB plugin.