Merge pull request #112 from KnorpelSenf/maintenance

chore: perform various maintenance tasks

Author: josiasmontag

.eslintrc.js

@@ -4,28 +4,28 @@
 name: Tests
 
 on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+    push:
+        branches: [master]
+    pull_request:
+        branches: [master]
 
 jobs:
-  build:
+    build:
+        runs-on: ubuntu-latest
 
-    runs-on: ubuntu-latest
+        strategy:
+            max-parallel: 2
+            matrix:
+                node-version: [20, 22, 23]
+                # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
-    strategy:
-      matrix:
-        node-version: [16, 18, 20]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm install -d
-      - run: npm run lint
-      - run: npm test
-      - run: npm run test-integration
+        steps:
+            - uses: actions/checkout@v4
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node-version }}
+            - run: npm install -d
+            - run: npm run lint
+            - run: npm test
+            - run: npm run test-integration

.github/workflows/run-tests.yml

@@ -0,0 +1,6 @@
+{
+    "require": "tsx",
+    "spec": [
+        "tests/**/*.ts"
+    ]
+}

.mocharc.json

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

.eslintignore .prettierignore.eslintignore renamed to .prettierignore

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

.prettierrc

@@ -1,6 +1,12 @@
 {
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-        "source.fixAll": true
+        "source.fixAll": "explicit"
+    },
+    "[md]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode"
     }
 }

.vscode/settings.json

@@ -1,6 +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 for the [CloudConvert](https://cloudconvert.com/api/v2) API v2.
 
 [![Node.js Run Tests](https://github.com/cloudconvert/cloudconvert-node/actions/workflows/run-tests.yml/badge.svg)](https://github.com/cloudconvert/cloudconvert-node/actions/workflows/run-tests.yml)
 [![npm](https://img.shields.io/npm/v/cloudconvert.svg)](https://www.npmjs.com/package/cloudconvert)
@@ -86,15 +86,15 @@ const job = await cloudConvert.jobs.create({
     }
 });
 
-const uploadTask = job.tasks.filter(task => task.name === 'upload-my-file')[0];
+const uploadTask = job.tasks.find(task => task.name === 'upload-my-file');
 
 const inputFile = fs.createReadStream('./file.pdf');
 
 await cloudConvert.tasks.upload(uploadTask, inputFile, 'file.pdf');
 ```
-> **Note on custom streams**:
-The length of the stream needs to be known prior to uploading. The SDK automatically detects the file size of file-based read streams. If you are using a custom stream, you need to pass a `filesize` as fourth parameter to the `upload()` method. 
 
+> **Note on custom streams**:
+The length of the stream needs to be known prior to uploading. The SDK tries to automatically detect the file size of file-based read streams. If you are using a custom stream, you might need to pass a `fileSize` as fourth parameter to the `upload()` method. 
 
 ## Websocket Events
 
@@ -242,5 +242,5 @@ and even auto-fix as many things as possible by running
 
 ## 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)

README.md

@@ -0,0 +1,55 @@
+import { defineConfig, globalIgnores } from 'eslint/config';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import globals from 'globals';
+import tsParser from '@typescript-eslint/parser';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default defineConfig([
+    globalIgnores([
+        '**/node_modules/',
+        '**/built/',
+        '**/package-lock.json',
+        '**/package.json',
+        'tests/unit/requests/',
+        'tests/unit/responses/',
+        '.vscode/',
+        'tsconfig.json',
+        '.mocharc.json'
+    ]),
+    {
+        extends: compat.extends(
+            'eslint:recommended',
+            'plugin:@typescript-eslint/recommended'
+        ),
+
+        plugins: {
+            '@typescript-eslint': typescriptEslint
+        },
+
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.node
+            },
+
+            parser: tsParser,
+            ecmaVersion: 'latest',
+            sourceType: 'module'
+        },
+
+        rules: {
+            '@typescript-eslint/no-explicit-any': 'off'
+        }
+    }
+]);