zip files

.eslintrc.json

@@ -0,0 +1,22 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "react-hooks"
+    ],
+    "rules": {
+        "@typescript-eslint/naming-convention": "warn",
+        "@typescript-eslint/semi": "warn",
+        "curly": "warn",
+        "eqeqeq": "warn",
+        "no-throw-literal": "warn",
+        "semi": "off",
+        "react-hooks/rules-of-hooks": "error", // Checks rules of Hooks
+        "react-hooks/exhaustive-deps": "warn" // Checks effect dependencies    
+    }
+}

.gitignore

@@ -0,0 +1,7 @@
+out
+node_modules
+.vscode-test/
+*.vsix
+.DS_Store
+.history
+.env

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 120,
+  "singleQuote": true,
+  "arrowParens": "avoid"
+}

.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,38 @@
+// 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",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/src/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}",
+			"sourceMaps": true
+		},
+		{
+			"name": "Extension Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionTestsPath=${workspaceFolder}/out/test/index"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/test/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}",
+			"sourceMaps": true
+		}
+	]
+}

.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": "watch",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		}
+	]
+}

.vscodeignore

@@ -0,0 +1,13 @@
+.vscode/**
+.vscode-test/**
+out/test/**
+src/**
+test/**
+.gitignore
+vsc-extension-quickstart.md
+**/tsconfig.json
+**/.eslintrc.json
+**/*.map
+**/*.ts
+.env
+.prettierrc

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to the "vsc-flink-sql-ext" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [Unreleased]
+
+- Initial release

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# eBay Flink SQL Assistant for VS Code Guidelines
+
+Thank you so much for wanting to contribute to Flink SQL Assistant! Here are a few important things you should know about contributing:
+
+  1. Ruleset changes require discussion, use cases, etc. Code comes later.
+  2. Pull requests are great for small fixes for bugs, documentation, etc.
+  3. Code contributions require updating relevant documentation.
+
+This project takes all contributions through <a href='https://help.github.com/articles/using-pull-requests'>pull requests</a>.
+Code should *not* be pushed directly to `master`.
+
+The following guidelines apply to all contributors.
+
+## General Guidelines
+- Only one logical change per commit
+- Do not mix whitespace changes with functional code changes
+- Do not mix unrelated functional changes
+- When writing a commit message:
+  - Describe *why* a change is being made
+  - Do not assume the reviewer understands what the original problem was
+  - Do not assume the code is self-evident/self-documenting
+  - Describe any limitations of the current code
+- Any significant changes should be accompanied by tests.
+- The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it.
+- Please squash all commits for a change into a single commit (this can be done using `git rebase -i`).
+
+## Commit Message Guidelines
+* Provide a brief description of the change in the first line.
+* Insert a single blank line after the first line
+* Provide a detailed description of the change in the following lines, breaking
+ paragraphs where needed.
+* The first line should be limited to 50 characters and should not end in a
+ period.
+* Subsequent lines should be wrapped at 72 characters.
+* Put `Closes #XXX` line at the very end (where `XXX` is the actual issue number) if the proposed change is relevant to a tracked issue.
+
+Note: In Git commits the first line of the commit message has special significance. It is used as the email subject line, in git annotate messages, in gitk viewer annotations, in merge commit messages and many more places where space is at a premium. Please make the effort to write a good first line!
+
+## Ruleset Change Guidelines
+We need to make public ruleset changes, including adding new rules, very carefully to maintain backward compatibility for contributions. Because of this, if you're interested in seeing a new rule, the best approach is to create an Github issue (or comment on an existing issue if there is one) requesting the rule and describing specific use cases for it.
+
+If the rule has merit, it will go through a thorough process of rule design and review. Any code should come after this.
+
+## Making Changes
+* Fork the `vsc-flink-sql` repository
+* Make your changes
+* <a href='rulesets/tests/README.md'>Run tests</a>
+* Push your changes to a branch in your fork
+* See our commit message guidelines further down in this document
+* Submit a pull request to the repository
+* Update `vsc-flink-sql` GITHUB issue with the generated pull request link

README.md

@@ -0,0 +1,75 @@
+# Flink SQL Extension for Visual Studio Code
+
+An extension for efficiently editing and developing Flink SQL. Provides a simplified experience developing Flink SQL through intelligent editing features and a smooth integration with user's Flink cluster. 
+
+![Overview](images/documentation/flinksql-overview-1.png)
+
+## Feature Overview
+### 1. Intelligent editor
+  - Syntax highlighting
+  - Autocomplete
+  - Documentation for built-in functions
+
+### 2. SQL Snippets
+  - Categorize by SQL type and connector
+  - Provide required parameters for "CREATE TABLE" statements
+  - Press tab to jump to target inputs
+
+### 3. Integration with local Flink cluster
+  - Connect with your local Flink cluster
+  - Submit file / selected SQL to configured cluster
+  - Real-time submission feedback in output console
+  - Flink SQL CLI lifecycle management
+
+### 4. Embedded Monitoring
+  - Flink Monitoring Platform 
+  - Refresh the page to get the latest job status
+
+### 5. Linking to Flink SQL Monitoring
+  - List flink jobs and show their status
+  - List task managers
+  - Provide external links to Flink Web UI
+
+## Supported Flink Environment
+Currently, the following list of flink environment are supported:
+
+1.  Local Flink Clusters
+  - Flink clusters that lives in your local environment
+  - Start the SQL client with the following: ```./bin/sql-client.sh```
+
+Please specify the path to your flink cluster in settings of this extension.
+
+## How to Install
+### 1. Install from the VS Code Extension Marketplace
+  We will be publishing the extension in VS Code Market Place. More information about installation will be provided in this section once the extension is published.
+
+  For now, you can build and run the extension locally by pulling a copy of this repository to your local environment. More instructions in the following section. 
+
+### 2. Build and Run Locally
+  You can run the extension locally by following the steps below:
+  - Download Visual Studio Code
+  - Have a copy of this github repository in your local
+  - Open the project with VS Code. Click on "Run Extension" in the "Run" explorer panel in VS Code to run the extension. 
+![Running Extension](images/documentation/run-extension.png)
+
+## How to use
+After you have downloaded this extension, follow the below steps to set up and start coding.
+
+### 1. Configure your flink cluster
+
+  Before directly submit flink sql from our editor, please go to settings to configure the following three fields:
+  - Flink Dashboard URL
+  - Flink Package Path
+  - Command to start Flink SQL Client
+
+### 2. Create a new ```.flinksql``` file
+
+  The extension provides syntax highlight for files with ```.flinksql``` extensions. Naming the files ending in ```.flinksql``` would give you full access to the functionalities of the extension. 
+
+### 3. Start developing!
+
+## Contributing to the project
+
+Please refer to the following guide for our contributing guideline: [CONTRIBUTING.md](CONTRIBUTING.md)
+
+Instructions for developing and testing the extension is documented in this [quickstart](vsc-extension-quickstart.md) guide in this repository.