Merge pull request #21 from rendertom/eslint-prettier

ESlint and Prettier

Author: rendertom

.eslintrc.json

@@ -1,24 +1,21 @@
 {
-	"env": {
-		"browser": false,
-		"commonjs": true,
-		"es6": true,
-		"node": true
-	},
-	"parserOptions": {
-		"ecmaFeatures": {
-			"jsx": true
-		},
-		"sourceType": "module"
-	},
-	"rules": {
-		"no-const-assign": "warn",
-		"no-this-before-super": "warn",
-		"no-undef": "warn",
-		"no-unreachable": "warn",
-		"no-unused-vars": "warn",
-		"constructor-super": "warn",
-		"valid-typeof": "warn",
-		"semi": "warn"
-	}
+  "env": {
+    "browser": false,
+    "commonjs": true,
+    "es6": true,
+    "node": true
+  },
+  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-unreachable": "warn",
+    "no-unused-vars": "warn",
+    "semi": "warn",
+    "valid-typeof": "warn"
+  }
 }

.prettierignore

@@ -0,0 +1,4 @@
+.node_modules
+
+# Ignore all Markdown files:
+*.md

.prettierrc.json

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

.vscode/extensions.json

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

.vscode/launch.json

@@ -3,26 +3,24 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Extension",
-            "type": "extensionHost",
-            "request": "launch",
-            "runtimeExecutable": "${execPath}",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}"
-            ]
-        },
-        {
-            "name": "Extension Tests",
-            "type": "extensionHost",
-            "request": "launch",
-            "runtimeExecutable": "${execPath}",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}",
-                "--extensionTestsPath=${workspaceFolder}/test"
-            ]
-        }
-    ]
-}
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": ["--extensionDevelopmentPath=${workspaceFolder}"]
+    },
+    {
+      "name": "Extension Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--extensionTestsPath=${workspaceFolder}/test"
+      ]
+    }
+  ]
+}

.vscode/settings.json

@@ -1,4 +1,4 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-    "terminal.integrated.shell.windows": "C:\\Windows\\System32\\cmd.exe"
-}
+  "terminal.integrated.shell.windows": "C:\\Windows\\System32\\cmd.exe"
+}

CHANGELOG.md

@@ -6,7 +6,7 @@ All notable changes to the Adobe Script Runner extension will be documented in t
 
 ### Added
 
--
+- ESLint + Prettier for a consistent codebase
 
 ### Changed
 

README.md

@@ -28,6 +28,7 @@ Adobe Script Runner executes script in the active viewer by default. However, wh
 ## Installation
 
 - ### From VSCode application
+
   - Open `Extensions` and type `Adobe Script Runner`.
   - Click `Install` and then `Reload` button.
 
@@ -48,7 +49,7 @@ Keyboard shortcut `Cmd+R` is bind to `adobeScriptRunner.ae` command, which will
 - Open Keyboard Shortcuts editor and click on the link `keybindings.json`.
 - This will open the Default Keyboard Shortcuts on the left and your `keybindings.json` file where you can overwrite the default bindings on the right.
 - With `keybindings.json` in focus click `Cmd+K` twice to open an interactive keybinding modal window (or whatever it’s called) and follow the on-screen instructions. This will create a new binding entry in the `keybindings.json` file.
-- Edit the `command` property to `adobeScriptRunner.XX`, where XX is an abbreviation of the application. Check available abbreviations in `Extensions > Adobe Script Runner > Contributions` tab. 
+- Edit the `command` property to `adobeScriptRunner.XX`, where XX is an abbreviation of the application. Check available abbreviations in `Extensions > Adobe Script Runner > Contributions` tab.
 
 The result should look something like this:
 
@@ -108,4 +109,4 @@ Executable paths for InCopy and InDesign for Windows are not exposed because the
 
 ## Known issues
 
-- The host application does not get focus on script run.
+- The host application does not get focus on script run.

lib/buildCommand.js

@@ -8,27 +8,27 @@ const ide = require('./ide.js');
  * @param {Object} hostApp entry from hostApps[hostApp].
  */
 function buildCommand(hostApp) {
-	try {
-		getScriptFile(function(scriptFile) {
-			getShellCommand(hostApp, scriptFile, function(command) {
-				console.log('Running shell command:', command);
-				cp.exec(command, (error, stdout, stderr) => {
-					if (error) {
-						console.error(`exec error: ${error}`);
-						return;
-					}
+  try {
+    getScriptFile(function (scriptFile) {
+      getShellCommand(hostApp, scriptFile, function (command) {
+        console.log('Running shell command:', command);
+        cp.exec(command, (error, stdout, stderr) => {
+          if (error) {
+            console.error(`exec error: ${error}`);
+            return;
+          }
 
-					console.log(stdout);
-					console.log(stderr);
-				});
-				ide.showInformationMessage(`Script sent to ${hostApp.appName}`);
-			});
-		});
-	} catch (error) {
-		if (typeof error !== 'undefined') {
-			console.log(error);
-		}
-	}
+          console.log(stdout);
+          console.log(stderr);
+        });
+        ide.showInformationMessage(`Script sent to ${hostApp.appName}`);
+      });
+    });
+  } catch (error) {
+    if (typeof error !== 'undefined') {
+      console.log(error);
+    }
+  }
 }
 
-module.exports = buildCommand;
+module.exports = buildCommand;

lib/extension.js

@@ -5,15 +5,13 @@ const vscode = require('vscode');
 /**
  * @description Method is called when extension is activated.
  *              Extension is activated the very first time the command is executed.
- * @param {any} context vscode.ExtensionContext
  */
-function activate(context) {
-	hostApps.forEach(hostApp => {
-		vscode.commands.registerCommand(
-			`adobeScriptRunner.${hostApp.shortName}`,
-			() => buildCommand(hostApp)
-		);
-	});
+function activate() {
+  hostApps.forEach((hostApp) => {
+    vscode.commands.registerCommand(`adobeScriptRunner.${hostApp.shortName}`, () =>
+      buildCommand(hostApp)
+    );
+  });
 }
 
 exports.activate = activate;