Merge pull request #32 from zenml-io/develop

0.0.11

.coderabbit.yml

@@ -0,0 +1,28 @@
+language: "en"
+early_access: false
+reviews:
+  request_changes_workflow: false
+  high_level_summary: true
+  poem: true
+  review_status: true
+  collapse_walkthrough: false
+  path_filters:
+  - "!**/.xml"
+  path_instructions:
+  - path: "**/*.js"
+    instructions: "Review the JavaScript code for conformity with the Google JavaScript style guide, highlighting any deviations."
+  - path: "**/*.ts"
+    instructions: "Review the Typescript code for conformity with industry standards and best practices, highlighting any deviations."
+  - path: "**/*.py"
+    instructions: |
+      "Review the Python code for conformity with Python best practices and industry standards, highlighting any deviations."
+  auto_review:
+    enabled: true
+    ignore_title_keywords:
+    - "WIP"
+    - "DO NOT MERGE"
+    drafts: false
+    base_branches:
+    - "develop"
+chat:
+  auto_reply: true

.eslintrc

@@ -0,0 +1,19 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
+
+  "rules": {
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/consistent-type-definitions": ["error", "type"]
+  },
+
+  "env": {
+    "browser": true,
+    "es2021": true
+  }
+}

.eslintrc.json

@@ -0,0 +1,24 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/naming-convention": [
+      "warn",
+      {
+        "selector": "import",
+        "format": ["camelCase", "PascalCase"]
+      }
+    ],
+    "@typescript-eslint/semi": "warn",
+    "curly": "warn",
+    "eqeqeq": "warn",
+    "no-throw-literal": "warn",
+    "semi": "off"
+  },
+  "ignorePatterns": ["out", "dist", "**/*.d.ts"]
+}

.github/actions/lint/action.yml

@@ -0,0 +1,40 @@
+---
+name: Lint
+description: Lint TypeScript and Python code
+runs:
+  using: composite
+  steps:
+    - name: Install Node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18.x
+        cache: npm
+        cache-dependency-path: package-lock.json
+    - name: Install Node dependencies
+      run: npm ci
+      shell: bash
+    - name: Lint TypeScript code
+      run: npm run lint
+      shell: bash
+    - name: Check TypeScript format
+      run: npm run format-check
+      shell: bash
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.8'
+    - name: Pip cache
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-lint-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-lint-
+    - name: Install Python dependencies
+      run: |
+        python -m pip install -U pip
+        pip install -r requirements-dev.txt
+      shell: bash
+    - name: Lint Python and YAML code
+      run: ./scripts/lint.sh
+      shell: bash

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+---
+name: VSCode Extension CI
+on: [push, pull_request]
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Lint
+        uses: ./.github/actions/lint
+  build-and-test:
+    needs: lint
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: npm
+          cache-dependency-path: package-lock.json
+      - name: Install Node dependencies
+        run: npm ci
+      - name: Compile TS tests
+        run: npm run pretest
+      - name: Run headless test
+        uses: coactions/setup-xvfb@v1
+        with:
+          run: npm test

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+---
+name: Publish VSCode Extension
+on:
+  release:
+    types: [created]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Build Extension
+        run: npm run package
+      - name: Package Extension
+        run: npm run vsce-package
+      - name: Publish Extension
+        if: success() && startsWith(github.ref, 'refs/tags/')
+        run: npm run deploy
+        env:
+          VSCE_PAT: ${{ secrets.VSCE_PAT }}
+      - name: Generate Changelog
+        if: success() && startsWith(github.ref, 'refs/tags/')
+        run: |
+          git log $(git describe --tags --abbrev=0)..HEAD --oneline > CHANGELOG.txt
+          cat CHANGELOG.txt
+      - name: Create GitHub Release
+        if: success() && startsWith(github.ref, 'refs/tags/')
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: zenml.vsix
+          bodyFile: CHANGELOG.txt
+          tag: ${{ github.ref_name }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,43 @@
+.DS_Store
+Thumbs.db
+.vscode-test/
+.idea/
+.eslintcache
+lib-cov
+*.log
+*.log*
+pids
+
+# Node
+.npm/
+node_modules/
+npm-debug.log
+
+# Build outputs
+dist/
+out/
+build/
+*.tsbuildinfo
+.history/
+dag-packed.js
+dag-packed.js.map
+
+# env
+.env
+.env*
+
+# Output of 'npm pack'
+*.tgz
+
+# mypy
+.mypy_cache/
+
+# From vscode-python-tools-extension-template
+*.vsix
+.venv/
+.vs/
+.nox/
+bundled/libs/
+**/__pycache__
+**/.pytest_cache
+**/.vs

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "proseWrap": "preserve",
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "trailingComma": "es5",
+  "bracketSpacing": true
+}

.pylintrc

@@ -0,0 +1,7 @@
+[MESSAGES CONTROL]
+disable=
+    C0103, # Name doesn't conform to naming style
+    C0415, # Import outside toplevel
+    W0613, # Unused argument
+    R0801, # Similar lines in multiple files
+    R0903, # Too few public methods

.tool-versions

@@ -0,0 +1 @@
+nodejs 20.10.0

.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'out/test/**/*.test.js',
+});

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  // See http://go.microsoft.com/fwlink/?LinkId=827846
+  // for the documentation about the extensions.json format
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "amodio.tsl-problem-matcher",
+    "ms-vscode.extension-test-runner"
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,18 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+      "outFiles": ["${workspaceFolder}/dist/**/*.js"],
+      "preLaunchTask": "${defaultBuildTask}",
+      "timeout": 20000
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,19 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+  "python.defaultInterpreterPath": "",
+  "files.exclude": {
+    "out": false, // set this to true to hide the "out" folder with the compiled JS files
+    "dist": false // set this to true to hide the "dist" folder with the compiled JS files
+  },
+  "search.exclude": {
+    "out": true, // set this to false to include "out" folder in search results
+    "dist": true // set this to false to include "dist" folder in search results
+  },
+  // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+  "typescript.tsc.autoDetect": "off",
+  "python.testing.pytestArgs": ["src/test/python_tests"],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "python.testing.cwd": "${workspaceFolder}",
+  "python.analysis.extraPaths": ["bundled/libs", "bundled/tool"]
+}

.vscode/tasks.json

@@ -0,0 +1,45 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "watch",
+      "problemMatcher": "$ts-webpack-watch",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never",
+        "group": "watchers"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
+    {
+      "type": "npm",
+      "script": "watch-tests",
+      "problemMatcher": "$tsc-watch",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never",
+        "group": "watchers"
+      },
+      "group": "build"
+    },
+    {
+      "label": "tasks: watch-tests",
+      "dependsOn": ["npm: watch", "npm: watch-tests"],
+      "problemMatcher": []
+    },
+    {
+      "type": "npm",
+      "script": "compile",
+      "group": "build",
+      "problemMatcher": [],
+      "label": "npm: compile",
+      "detail": "webpack"
+    }
+  ]
+}

.vscodeignore

@@ -0,0 +1,15 @@
+.vscode/**
+.vscode-test/**
+out/**
+node_modules/**
+src/**
+.gitignore
+.yarnrc
+webpack.config.js
+vsc-extension-quickstart.md
+**/tsconfig.json
+**/.eslintrc.json
+**/*.map
+**/*.js.map
+**/*.ts
+**/.vscode-test.*