Merge pull request #1 from OpenCageData/feature/eslint-prettier

Adds eslint, prettier

Author: tsamaya

.prettierignore

@@ -0,0 +1,14 @@
+# Lock files
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+# Other
+.vscode/
+# Ignore all node_modules directories
+node_modules/
+# Ignore all dist directories
+dist/
+# Ignore all build directories
+build/
+# Ignore all coverage directories
+coverage/

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

build/index.d.ts

@@ -9,7 +9,7 @@ export interface OpenCageResponse {
                 name: string;
                 iso_code: string;
             };
-            [key: string]: any;
+            [key: string]: string | number | boolean | object | undefined;
         };
         components: {
             country: string;
@@ -20,7 +20,7 @@ export interface OpenCageResponse {
             road?: string;
             house_number?: string;
             postcode?: string;
-            [key: string]: any;
+            [key: string]: string | number | boolean | object | undefined;
         };
         confidence: number;
         formatted: string;
@@ -43,19 +43,21 @@ export declare class OpenCageServer {
     constructor();
     /**
      * Handles the geocoding request.
+     *
      * @param args - The arguments for the request.
      * @returns The response containing the geocoded location information.
      */
     private handleGeocode;
     /**
      * Handles the reverse geocoding request.
+     *
      * @param args - The arguments for the request.
      * @returns The response containing the address and location information.
      */
     private handleReverseGeocode;
     /**
      * Handles the OpenCage API info request.
-     * @param args - The arguments for the request.
+     * @param _args - The arguments for the request.
      * @returns The response containing API usage and rate limit information.
      */
     private handleOpenCageInfo;

build/index.js

@@ -35,9 +35,11 @@ export class OpenCageServer {
     }
     /**
      * Handles the geocoding request.
+     *
      * @param args - The arguments for the request.
      * @returns The response containing the geocoded location information.
      */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     async handleGeocode(args) {
         const { query, language = 'en', countrycode, bounds, limit = 5, } = args || {};
         try {
@@ -110,9 +112,11 @@ export class OpenCageServer {
     }
     /**
      * Handles the reverse geocoding request.
+     *
      * @param args - The arguments for the request.
      * @returns The response containing the address and location information.
      */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     async handleReverseGeocode(args) {
         const { latitude, longitude, language = 'en', no_annotations } = args;
         const params = new URLSearchParams({
@@ -165,10 +169,11 @@ export class OpenCageServer {
     }
     /**
      * Handles the OpenCage API info request.
-     * @param args - The arguments for the request.
+     * @param _args - The arguments for the request.
      * @returns The response containing API usage and rate limit information.
      */
-    async handleOpenCageInfo(args) {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any
+    async handleOpenCageInfo(_args) {
         try {
             const params = new URLSearchParams({
                 q: `0,0`,
@@ -381,6 +386,7 @@ What would you like to help me with regarding geocoding?`,
 }
 // Start the server
 const server = new OpenCageServer();
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 server.run().catch((error) => {
     console.error('Fatal error in main():', error);
     process.exit(1);

eslint.config.mjs

@@ -0,0 +1,10 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import ts from 'typescript-eslint';
+
+export default [
+  { languageOptions: { globals: globals.node } },
+  js.configs.recommended,
+  ...ts.configs.recommended,
+  { ignores: ['build/'] },
+];