Initial Commit

Author: gr4ph0s

.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",
+        "@typescript-eslint/semi": "warn",
+        "curly": "warn",
+        "eqeqeq": "warn",
+        "no-throw-literal": "warn",
+        "semi": "off"
+    },
+    "ignorePatterns": [
+        "out",
+        "dist",
+        "**/*.d.ts"
+    ]
+}

.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Publish new release
+
+on:
+  workflow_dispatch:
+    inputs:
+      node_version:
+        description: 'NodeJs Version to use'
+        default: '14.18.2'
+        required: true
+        
+jobs:
+  build_release_vsix:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@master
+          
+    - name: Setup Node.js ${{ github.event.inputs.node_version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ github.event.inputs.node_version }}
+        
+    - name: Run npm ci
+      run: npm ci --prefer-offline
+      shell: bash
+      
+    - name: Install vsce
+      run: npm i -g vsce
+      shell: bash
+      
+    - name: get-npm-version
+      id: package-version
+      uses: martinbeentjes/npm-get-version-action@main
+
+    - name: Compile and Build VSIX
+      run: vsce package -o cinema4d-connector-${{ steps.package-version.outputs.current-version}}.vsix
+      shell: bash
+
+    - name: Create Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: cinema4d-connector-${{ steps.package-version.outputs.current-version}}
+        release_name: Release cinema4d-connector-${{ steps.package-version.outputs.current-version}}
+        draft: false
+        prerelease: false
+        
+    - name: Upload artifact
+      uses: AButler/upload-release-assets@v2.0
+      with:
+        files: '*.vsix'
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        release-tag: cinema4d-connector-${{ steps.package-version.outputs.current-version}}
+        

.gitignore

@@ -0,0 +1,8 @@
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+out/
+
+*.vs
+*.vsix
+
+# Dependency directories
+node_modules/

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+	// See http://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		"dbaeumer.vscode-eslint"
+	]
+}

.vscode/launch.json

@@ -0,0 +1,21 @@
+// 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}/out/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		}
+	]
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.exclude": {
+        "out": false // set this to true to hide the "out" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true // set this to false to include "out" folder in search results
+    },
+    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+    "typescript.tsc.autoDetect": "off"
+}

.vscode/tasks.json

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

.vscodeignore

@@ -0,0 +1,10 @@
+.vscode/**
+.vscode-test/**
+src/**
+.gitignore
+.yarnrc
+vsc-extension-quickstart.md
+**/tsconfig.json
+**/.eslintrc.json
+**/*.map
+**/*.ts

README.md

@@ -0,0 +1,42 @@
+# Cinema 4D Connector - Visual Studio Code Extension
+
+Provides an extension for VS Code to exchange code between the Script Manager of Cinema 4D and VS Code.
+
+This extension is only functional with the [Cinema 4D Plugin](https://github.com/PluginCafe/Cinema4D_Connector-Cinema4D_Plugin) for Visual Studio Code counterpart plugin. The extension also provides syntax highlighting for resource files and string resources as used by Cinema 4D, as well as other tools to assist Cinema 4D plugins and scripts developers.
+
+All the commands of this extension can be found by pressing `ctrl+shift+P` and searching for `C4D`.
+
+![Cinema 4D Python Debugging in Visual Studio Code](https://github.com/PluginCafe/Cinema4D_Connector-VisualStudioCode_Extension/blob/main/image/vscode_example.png)
+
+## Installation
+
+To use all the features it is necessary to install the following two extensions:
+
+- The Cinema 4D plugin, downloadable [here](https://github.com/PluginCafe/Cinema4D_Connector-Cinema4D_Plugin/releases). Once downloaded, extract the archive to the Cinema 4D S26+ plugins folder. You then need to activate the extension in the Cinema 4D preferences in the `Extensions | Code Exchange` menu, activate the WebSocket Json checkbox.
+
+- The `Cinema 4D Connector` extension for Visual Studio code, directly accessible in the Visual Studio code marketplace, or download it [here](https://github.com/PluginCafe/Cinema4D_Connector-VisualStudioCode_Extension/releases).
+
+## Features
+
+In-depth documentation can be found in [Cinema 4D Connector - Documentation](https://github.com/PluginCafe/Cinema4D_Connector-Cinema4D_Plugin/blob/main/documentation.md).
+
+* **Load Script in Script Manager**: Load the active script from Visual Studio Code editor to Cinema 4D script manager. 
+* **Execute in Cinema 4D as a Script in Script Manager**: Execute a script directly into Cinema 4D.
+* **Debug in Cinema 4D as a Script in Script Manager**: Start a debugging session for the given script to Cinema 4D.
+* **Autocompletion for the `c4d` Python package**: Provide autocompletion on the fly when typing for the c4d package.
+* **Load Cinema 4D Script Template**: Loads a template script.
+* **Python Console output forwarding**: Cinema 4D Python console outputs is forwarded to a Visual Studio Code console called "Cinema 4D".
+* **Syntax highliting for \*.res and \*.str files**: The syntax for files with the extension .str and .res has a syntax colouring.
+
+## Known Issues
+
+- Autocompletion does not work for the `maxon` package.
+- Autocompletion does not work for temporary scripts from Cinema 4D, those whose path begins with `Root@`, e.g. `Root@12345678/Scripts@12345678/untilted.py.`
+- Autocompletion for methods from the `c4d` package will generate incomplete default argument if this argument is part of the `c4d` package, e.g. the automcpletion will output only `BaseContainer` while it should be `c4d.BaseContainer`.
+- When the `Load Script in Script Manager` command is used on an untitled file, it creates a new temporary file in Cinema 4D and this is returned to Visual Studio Code. This file should be used to exchange data to/from Cinema 4D.
+- The first debugging session will show a message about the deprecated use of `ptvsd`, this is a false positive and can be ignored.
+
+## License
+
+This extension is licensed under the [Apache 2.0 License](LICENSE).
+