diff --git a/.eslintrc b/.eslintrc index f695e82f787..dc8b4db1e3c 100644 --- a/.eslintrc +++ b/.eslintrc @@ -34,6 +34,7 @@ "no-new": ["error"], "no-undef": ["error"], "no-unused-vars": ["error", {"vars": "all", "args": "none"}], + "semi": ["error"], "strict": ["error"], "wrap-iife": ["error", "any"] } diff --git a/.vscode/settings.json b/.vscode/settings.json index e3ecc5978ba..ef0adfd47a4 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -27,7 +27,7 @@ "editor.insertSpaces": true, "editor.tabSize": 4, "editor.detectIndentation": false, - "jshint.enable": true, + "eslint.enable": true, "javascript.format.insertSpaceAfterCommaDelimiter": true, "javascript.format.insertSpaceAfterSemicolonInForStatements": true, "javascript.format.insertSpaceBeforeAndAfterBinaryOperators": true, diff --git a/Documentation/Contributors/EclipseGuide/README.md b/Documentation/Contributors/EclipseGuide/README.md deleted file mode 100644 index e6a7dcb1439..00000000000 --- a/Documentation/Contributors/EclipseGuide/README.md +++ /dev/null @@ -1,65 +0,0 @@ -# Eclipse Guide - -While primarily known as a Java IDE, Eclipse can be configured to work well for web development too. These instructions are written for Eclipse Neon but the process is the same for any recent version. - -* Install [Java](http://www.java.com/en/download/manual.jsp) if it isn't already. -* Download the [Eclipse IDE for Java Developers](http://www.eclipse.org/downloads/eclipse-packages/). Extract to a directory of your choice and run. Create a workspace anywhere you like. - -* Install additional Eclipse components: JavaScript Development Tools and Eclipse Web Developer Tools. - * Help - Install New Software. Work with: select *Neon* from the list. - * Expand *Programming Languages*, check *JavaScript Development Tools*. - * Expand *Web, XML, Java EE and OSGi Enterprise Development*, check *Eclipse Web Developer Tools*. - * Next, Next, Accept, Finish, _wait_, No (we have more to install). - -![The Java Development Tools installation dialog](indigo.jpg) - -* Install the [JSHint](http://www.jshint.com/) plugin: - * Help - Install New Software. Work with: `http://github.eclipsesource.com/jshint-eclipse/updates/`. - * Check *JSHint*. Next, Next, Accept, Finish, _wait_, OK, _wait_, Restart. - -![The JSHint installation dialog](jshint.jpg) - -* Run Eclipse. Close the Welcome page. - -* Window - Preferences: - * General - Editors - Text Editors. Check Insert spaces for tabs. Apply. - * Web - CSS Files - Editor. Switch the radio button to "Indent using spaces". Change Indentation size to 4. Apply. - * Web - HTML Files - Editor. Switch the radio button to "Indent using spaces". Change Indentation size to 4. OK. - -![Configuring "Insert spaces for tabs"](tabs.jpg) - -* Import Cesium into your workspace: File - Import, General - Existing Projects into Workspace, Next. Fill in the path to the root Cesium directory, Finish. - -* Click the "Open Perspective" button in the upper right and select JavaScript. You can then right-click on the Java perspective and close it. - -* Window - Show View - Console. - -Also consider the [Optional Eclipse Configuration](#optionaleclipseconfiguration) options below. - -## Optional Eclipse Configuration - -These steps are optional depending on your preference. - -### GLSL Plugin - -If you edit WebGL shader files (.glsl) with Eclipse, install GLShaders for GLSL syntax highlighting. First exit Eclipse, then download [GLShaders](http://sourceforge.net/projects/glshaders/) and extract into Eclipse's dropins directory. - -![The Eclipse dropins directory](glshaders.jpg) - -### Git - -Most of us use Git from the command-line, but there is also Eclipse integration: - -* Window - Preferences: Team - Git - Configuration - * Verify Location in User Settings tab is set to .gitconfig in the default repository directory. - * Verify Location in Systems Settings tab is set to {Installed/Git/Location}/etc/gitconfig. - -* Right click on Cesium in the Script Explorer. Team - Share project. Select Git, Next. Check Use or create repository in parent directory of project. Finish. - -## Eclipse Tips - -* Use Ctrl-Shift-R to search and open files in the workspace. - -![The Open Resource dialog](openresource.jpg) - -* Use Ctrl-Shift-F to auto format selected code. diff --git a/Documentation/Contributors/EclipseGuide/glshaders.jpg b/Documentation/Contributors/EclipseGuide/glshaders.jpg deleted file mode 100644 index 1c2ddeabff6..00000000000 Binary files a/Documentation/Contributors/EclipseGuide/glshaders.jpg and /dev/null differ diff --git a/Documentation/Contributors/EclipseGuide/indigo.jpg b/Documentation/Contributors/EclipseGuide/indigo.jpg deleted file mode 100644 index c37c9713d27..00000000000 Binary files a/Documentation/Contributors/EclipseGuide/indigo.jpg and /dev/null differ diff --git a/Documentation/Contributors/EclipseGuide/jshint.jpg b/Documentation/Contributors/EclipseGuide/jshint.jpg deleted file mode 100644 index 3d8b6c7c9f5..00000000000 Binary files a/Documentation/Contributors/EclipseGuide/jshint.jpg and /dev/null differ diff --git a/Documentation/Contributors/EclipseGuide/openresource.jpg b/Documentation/Contributors/EclipseGuide/openresource.jpg deleted file mode 100644 index 2c6b21dd1f8..00000000000 Binary files a/Documentation/Contributors/EclipseGuide/openresource.jpg and /dev/null differ diff --git a/Documentation/Contributors/EclipseGuide/tabs.jpg b/Documentation/Contributors/EclipseGuide/tabs.jpg deleted file mode 100644 index cf3f5002e7f..00000000000 Binary files a/Documentation/Contributors/EclipseGuide/tabs.jpg and /dev/null differ diff --git a/Documentation/Contributors/README.md b/Documentation/Contributors/README.md index d783cee68e4..fd923758d4f 100644 --- a/Documentation/Contributors/README.md +++ b/Documentation/Contributors/README.md @@ -2,9 +2,8 @@ * [CONTRIBUTING.md](../../CONTRIBUTING.md) - Start here. How to find something to work on, submit issues, and open pull requests. * [Build Guide](BuildGuide/README.md) - How to build and run Cesium locally. -* **IDEs** - use any IDE you want for Cesium development. Most contributors use WebStorm (commercial) or Eclipse (open source). +* **IDEs** - use any IDE you want for Cesium development. Most contributors use WebStorm (commercial) or VSCode (open source). * [WebStorm Guide](WebStormGuide/README.md) - How to set up WebStorm. - * [Eclipse Guide](EclipseGuide/README.md) - How to set up Eclipse. * [VSCode Guide](VSCodeGuide/README.md) - How to set up VSCode. * [Coding Guide](CodingGuide/README.md) - JavaScript and GLSL coding conventions and best practices for design, maintainability, and performance. * [Testing Guide](TestingGuide/README.md) - How to run the Cesium tests and write awesome tests. diff --git a/Documentation/Contributors/VSCodeGuide/README.md b/Documentation/Contributors/VSCodeGuide/README.md index f2454c42031..03d38e30c4f 100644 --- a/Documentation/Contributors/VSCodeGuide/README.md +++ b/Documentation/Contributors/VSCodeGuide/README.md @@ -40,18 +40,21 @@ extension, there are some that appear to be quite useful to Cesium. Just enter the desired extension name in the search box and click install. You will need to restart VSCode after you are done installing extensions. -* **jshint** by Dirk Baeumer -- This extension picks up on Cesium's own jsHint settings, -and will warn of any violations. The Cesium main repository should pass jsHint -using the Cesium jsHint settings with no warnings and no errors. Proposed -contributions to Cesium that introduce jsHint warnings will need to be corrected +* **[eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)** +by Dirk Baeumer -- This extension picks up on Cesium's own eslint settings, +and will warn of any violations. The Cesium main repository should pass eslint +using the Cesium eslint settings with no warnings and no errors. Proposed +contributions to Cesium that introduce eslint warnings will need to be corrected before they are accepted. -* **Shader languages support for VS Code** by slevesque -- This extension provides -syntax highlighting for Cesium's shader code. +* **[Shader languages support for VS Code](https://marketplace.visualstudio.com/items?itemName=slevesque.shader)** +by slevesque -- This extension provides syntax highlighting for Cesium's shader code. -* **Prettify JSON** by Mohsen Azimi -- This seems generally useful. +* **[Prettify JSON](https://marketplace.visualstudio.com/items?itemName=mohsen1.prettify-json)** + by Mohsen Azimi -- This seems generally useful. -* **glTF Extension for VS Code** by CesiumJS.org -- This extension adds features for previewing and editing 3D models in glTF files [glTF Tools](https://marketplace.visualstudio.com/items?itemName=cesium.gltf-vscode). +* **[glTF Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=cesium.gltf-vscode)** +by CesiumJS.org -- This extension adds features for previewing and editing 3D models in glTF files. ## VSCode Tasks and Files