Merge pull request #56 from KnorpelSenf/linting

Linting

Author: josiasmontag

.eslintignore

@@ -0,0 +1,5 @@
+.DS_Store
+.idea
+node_modules/
+built/
+package-lock.json

.eslintrc.js

@@ -0,0 +1,29 @@
+module.exports = {
+    root: true,
+    env: {
+        node: true,
+        es6: true
+    },
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'prettier/@typescript-eslint',
+        'plugin:prettier/recommended'
+    ],
+    rules: {
+        'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+        'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+        '@typescript-eslint/no-unused-vars': 'error',
+        '@typescript-eslint/no-explicit-any': 0,
+        '@typescript-eslint/explicit-function-return-type': [
+            'error',
+            {
+                allowExpressions: true
+            }
+        ],
+        'object-shorthand': ['error', 'always', { avoidQuotes: true }]
+    },
+    parserOptions: {
+        parser: '@typescript-eslint/parser'
+    }
+};

.gitignore

@@ -1,4 +1,4 @@
 .DS_Store
 .idea
 node_modules/
-built
+built/

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none",
+  "htmlWhitespaceSensitivity": "ignore",
+  "tabWidth": 4,
+  "semi": true,
+  "arrowParens": "avoid"
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["dbaeumer.vscode-eslint"]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll": true
+    }
+}

README.md

@@ -1,7 +1,6 @@
 # cloudconvert-node
 
-
-> This is the official Node.js SDK v2 for the [CloudConvert](https://cloudconvert.com/api/v2) _API v2_. 
+> This is the official Node.js SDK v2 for the [CloudConvert](https://cloudconvert.com/api/v2) _API v2_.
 > For API v1, please use [v1 branch](https://github.com/cloudconvert/cloudconvert-node/tree/v1) of this repository.
 
 [![Build Status](https://travis-ci.org/cloudconvert/cloudconvert-node.svg?branch=master)](https://travis-ci.org/cloudconvert/cloudconvert-node)
@@ -10,21 +9,20 @@
 
 ## Installation
 
-
     npm install --save cloudconvert
-    
+
 Load as ESM module:
 
 ```js
 import CloudConvert from 'cloudconvert';
 ```
 
 ... or via require:
+
 ```js
 const CloudConvert = require('cloudconvert');
 ```
 
-
 ## Creating Jobs
 
 ```js
@@ -33,24 +31,25 @@ import CloudConvert from 'cloudconvert';
 const cloudConvert = new CloudConvert('api_key');
 
 let job = await cloudConvert.jobs.create({
-    'tasks': {
+    tasks: {
         'import-my-file': {
-            'operation': 'import/url',
-            'url': 'https://my-url'
+            operation: 'import/url',
+            url: 'https://my-url'
         },
         'convert-my-file': {
-            'operation': 'convert',
-            'input': 'import-my-file',
-            'output_format': 'pdf',
-            'some_other_option': 'value'
+            operation: 'convert',
+            input: 'import-my-file',
+            output_format: 'pdf',
+            some_other_option: 'value'
         },
         'export-my-file': {
-            'operation': 'export/url',
-            'input': 'convert-my-file'
+            operation: 'export/url',
+            input: 'convert-my-file'
         }
     }
 });
 ```
+
 You can use the [CloudConvert Job Builder](https://cloudconvert.com/api/v2/jobs/builder) to see the available options for the various task types.
 
 ## Downloading Files
@@ -60,13 +59,15 @@ CloudConvert can generate public URLs for using `export/url` tasks. You can use
 ```js
 job = await cloudConvert.jobs.wait(job.id); // Wait for job completion
 
-const exportTask = job.tasks.filter(task => task.operation === 'export/url' && task.status === 'finished')[0];
+const exportTask = job.tasks.filter(
+    task => task.operation === 'export/url' && task.status === 'finished'
+)[0];
 const file = exportTask.result.files[0];
 
 const writeStream = fs.createWriteStream('./out/' + file.filename);
 
-https.get(file.url, function(response) {
-  response.pipe(writeStream);
+https.get(file.url, function (response) {
+    response.pipe(writeStream);
 });
 
 await new Promise((resolve, reject) => {
@@ -81,10 +82,10 @@ Uploads to CloudConvert are done via `import/upload` tasks (see the [docs](https
 
 ```js
 const job = await cloudConvert.jobs.create({
-    'tasks': {
+    tasks: {
         'upload-my-file': {
-            'operation': 'import/upload'          
-        },
+            operation: 'import/upload'
+        }
         // ...
     }
 });
@@ -96,12 +97,10 @@ const inputFile = fs.createReadStream('./file.pdf');
 await cloudConvert.tasks.upload(uploadTask, inputFile, 'file.pdf');
 ```
 
-
 ## Websocket Events
 
 The node SDK can subscribe to events of the [CloudConvert socket.io API](https://cloudconvert.com/api/v2/socket#socket).
 
-
 ```js
 const job = await cloudConvert.jobs.create({ ... });
 
@@ -121,6 +120,7 @@ cloudConvert.jobs.subscribeTaskEvent(job.id, 'finished', event => {
 ```
 
 When you don't want to receive any events any more you should close the socket:
+
 ```js
 cloudConvert.socket.close();
 ```
@@ -134,7 +134,11 @@ const payloadString = '...'; // The JSON string from the raw request body.
 const signature = '...'; // The value of the "CloudConvert-Signature" header.
 const signingSecret = '...'; // You can find it in your webhook settings.
 
-const isValid = cloudConvert.webhooks.verify(payloadString, signature, signingSecret); // returns true or false
+const isValid = cloudConvert.webhooks.verify(
+    payloadString,
+    signature,
+    signingSecret
+); // returns true or false
 ```
 
 ## Contributing
@@ -172,7 +176,20 @@ By default, this runs the integration tests against the Sandbox API with an offi
     53d6fe6b688c31c565907c81de625046  input.pdf
     99d4c165f77af02015aa647770286cf9  input.png
 
+### Linting
+
+The project is linted by ESLint+Prettier.
+
+If you're using VSCode, all files will be linted automatically upon saving.
+Otherwise, you can lint the project by running
+
+    npm run lint
+
+and even auto-fix as many things as possible by running
+
+    npm run lint -- --fix
+
 ## Resources
 
-* [API v2 Documentation](https://cloudconvert.com/api/v2)
-* [CloudConvert Blog](https://cloudconvert.com/blog)
+-   [API v2 Documentation](https://cloudconvert.com/api/v2)
+-   [CloudConvert Blog](https://cloudconvert.com/blog)

lib/CloudConvert.ts

@@ -1,40 +1,40 @@
-import axios, { AxiosInstance } from "axios";
+import axios, { AxiosInstance } from 'axios';
 import io from 'socket.io-client';
-import JobsResource, { JobEventData } from "./JobsResource";
-import TasksResource, { TaskEventData } from "./TasksResource";
-import UsersResource from "./UsersResource";
-import WebhooksResource from "./WebhooksResource";
+import JobsResource, { JobEventData } from './JobsResource';
+import TasksResource, { TaskEventData } from './TasksResource';
+import UsersResource from './UsersResource';
+import WebhooksResource from './WebhooksResource';
 
 export default class CloudConvert {
     private socket: SocketIOClient.Socket | undefined;
     private subscribedChannels: Map<string, boolean> | undefined;
-    
+
     public readonly apiKey: string;
     public readonly useSandbox: boolean;
-    
+
     public axios!: AxiosInstance;
     public tasks!: TasksResource;
     public jobs!: JobsResource;
     public users!: UsersResource;
     public webhooks!: WebhooksResource;
 
     constructor(apiKey: string, useSandbox = false) {
-
         this.apiKey = apiKey;
         this.useSandbox = useSandbox;
 
         this.createAxiosInstance();
         this.createResources();
-
     }
 
-
     createAxiosInstance(): void {
         this.axios = axios.create({
-            baseURL: this.useSandbox ? 'https://api.sandbox.cloudconvert.com/v2/' : 'https://api.cloudconvert.com/v2/',
+            baseURL: this.useSandbox
+                ? 'https://api.sandbox.cloudconvert.com/v2/'
+                : 'https://api.cloudconvert.com/v2/',
             headers: {
-                'Authorization': 'Bearer ' + this.apiKey,
-                'User-Agent': 'cloudconvert-node/v2 (https://github.com/cloudconvert/cloudconvert-node)'
+                Authorization: 'Bearer ' + this.apiKey,
+                'User-Agent':
+                    'cloudconvert-node/v2 (https://github.com/cloudconvert/cloudconvert-node)'
             }
         });
     }
@@ -46,13 +46,22 @@ export default class CloudConvert {
         this.webhooks = new WebhooksResource(this);
     }
 
-
-    subscribe(channel: string, event: string, callback: ((event: JobEventData) => void) | ((event: TaskEventData) => void)): void {
-
+    subscribe(
+        channel: string,
+        event: string,
+        callback:
+            | ((event: JobEventData) => void)
+            | ((event: TaskEventData) => void)
+    ): void {
         if (!this.socket) {
-            this.socket = io.connect(this.useSandbox ? 'https://socketio.sandbox.cloudconvert.com' : 'https://socketio.cloudconvert.com', {
-                transports: ['websocket']
-            });
+            this.socket = io.connect(
+                this.useSandbox
+                    ? 'https://socketio.sandbox.cloudconvert.com'
+                    : 'https://socketio.cloudconvert.com',
+                {
+                    transports: ['websocket']
+                }
+            );
             this.subscribedChannels = new Map<string, boolean>();
         }
 
@@ -61,23 +70,21 @@ export default class CloudConvert {
                 channel,
                 auth: {
                     headers: {
-                        'Authorization': 'Bearer ' + this.apiKey
+                        Authorization: 'Bearer ' + this.apiKey
                     }
-                },
+                }
             });
             this.subscribedChannels?.set(channel, true);
         }
 
-        this.socket.on(event, function (eventChannel: string, eventData: any): void {
+        this.socket.on(event, function (
+            eventChannel: string,
+            eventData: any
+        ): void {
             if (channel !== eventChannel) {
                 return;
             }
             callback(eventData);
         });
-
     }
-
-
 }
-
-