diff --git a/.gitignore b/.gitignore index 45c0018..d0b041a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ .env cov_profile/ npm/ -node_modules/ -.vscode/ \ No newline at end of file +node_modules/ \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..3bfc872 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "denoland.vscode-deno" + ] +} \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..ccad0fb --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,30 @@ +{ + "deno.enable": true, + "deno.enablePaths": [ + "mod.ts", + "version.ts", + "src", + "tests/*.ts", + "tests/engines/", + "scripts", + "examples/deno" + ], + "deno.inlayHints.enumMemberValues.enabled": false, + "deno.inlayHints.functionLikeReturnTypes.enabled": false, + "deno.inlayHints.parameterNames.enabled": "none", + "deno.inlayHints.parameterTypes.enabled": false, + "deno.inlayHints.propertyDeclarationTypes.enabled": false, + "deno.inlayHints.variableTypes.enabled": false, + "[json]": { + "editor.formatOnSave": true, + "editor.defaultFormatter": "denoland.vscode-deno" + }, + "[markdown]": { + "editor.formatOnSave": true, + "editor.defaultFormatter": "denoland.vscode-deno" + }, + "[typescript]": { + "editor.formatOnSave": true, + "editor.defaultFormatter": "denoland.vscode-deno" + } +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ac45f9c..73566b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,49 +12,37 @@ deno --version deno upgrade # to upgrade to the latest version ``` +### Fork and clone the repository + +Fork the repository on GitHub: + +1. Go to the repository page on GitHub - + https://github.com/serpapi/serpapi-javascript +2. Click the **Fork** button (top-right corner) +3. Clone your fork locally: + +```bash +git clone https://github.com//serpapi-javascript.git +cd serpapi-javascript +``` + +4. Add the upstream repository: + +```bash +git remote add upstream https://github.com/serpapi/serpapi-javascript.git +``` + +### Extension installation + Install the appropriate extension for your preferred editor/IDE: https://deno.land/manual/getting_started/setup_your_environment. The extension "integrates directly to the Deno CLI using the language server protocol. This helps ensure that the information you get about your code aligns to how that code will work when you try to run it under the Deno CLI."[^1] -If you use VSCode, use the following settings (`.vscode/settings.json`): - -```json -{ - "deno.enablePaths": [ - "mod.ts", - "version.ts", - "src", - "tests/*.ts", - "tests/engines/", - "scripts", - "examples/deno" - ], - "deno.inlayHints.enumMemberValues.enabled": false, - "deno.inlayHints.functionLikeReturnTypes.enabled": false, - "deno.inlayHints.parameterNames.enabled": "none", - "deno.inlayHints.parameterTypes.enabled": false, - "deno.inlayHints.propertyDeclarationTypes.enabled": false, - "deno.inlayHints.variableTypes.enabled": false, - "[json]": { - "editor.formatOnSave": true, - "editor.defaultFormatter": "denoland.vscode-deno" - }, - "[markdown]": { - "editor.formatOnSave": true, - "editor.defaultFormatter": "denoland.vscode-deno" - }, - "[typescript]": { - "editor.formatOnSave": true, - "editor.defaultFormatter": "denoland.vscode-deno" - } -} -``` - -Subsequently, install the -[vscode_deno extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) -and you're good to go. +Install the +[Deno extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) +for vscode and open the project — no manual configuration is required. ## Write tests