-
Notifications
You must be signed in to change notification settings - Fork 61k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #36276 from github/repo-sync
Repo sync
- Loading branch information
Showing
43 changed files
with
8,806 additions
and
185 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
...okbook/refactoring-code/translating-code-to-a-different-programming-language.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| --- | ||
| title: Translating code to a different programming language | ||
| shortTitle: Translating code | ||
| intro: '{% data variables.product.prodname_copilot_chat_short %} can help you rewrite code to perform the same operations but in a different programming language.' | ||
| versions: | ||
| feature: copilot | ||
| category: | ||
| - 'Refactoring code' | ||
| complexity: | ||
| - Simple | ||
| octicon: rocket | ||
| topics: | ||
| - Copilot | ||
| --- | ||
|
|
||
| There are many reasons why you might want to move code from one programming language to another. Each programming language has its own strengths and weaknesses, and you might want to take advantage of features that are available in another language. For example, you might want to move code to a language that has better performance, or which uses strong typing to help prevent bugs. | ||
|
|
||
| For ease of maintaining code, you might want to move code to a language that is more widely used in your organization. For example, if few people in your organization know an older language such as Perl, you might want to move any Perl code that's still in use to a more commonly used language such as Python or JavaScript. | ||
|
|
||
| {% data variables.product.prodname_copilot_short %} can help you translate code from one language to another. Translating a standalone file, such as a script, is straightforward. This process is described in this article. | ||
|
|
||
| Translating a project containing multiple files is a more complex process, and is described in [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/using-copilot-to-migrate-a-project). | ||
|
|
||
| ## Example scenario | ||
|
|
||
| The following Perl script prompts the user to enter the path to a text file. It checks what the user enters and if a text file is found at that path, it outputs a word count and character count for the contents of the file. | ||
|
|
||
| ```perl copy | ||
| #!/usr/bin/perl | ||
| use strict; | ||
| use warnings; | ||
| use File::Spec; | ||
| use File::Basename; | ||
|
|
||
| print "Please enter the path to a local text file: "; | ||
| chomp(my $file_path = <STDIN>); | ||
|
|
||
| if ($file_path =~ /[`|;&<>(){}\[\]]/ || !File::Spec->file_name_is_absolute($file_path) && dirname($file_path) ne '.') { | ||
| die "Invalid file path. Please provide a valid path.\n"; | ||
| } | ||
| if (!-e $file_path) { | ||
| die "File not found. Please provide an existing file path.\n"; | ||
| } | ||
|
|
||
| open(my $fh, '<', $file_path) or die "Could not open file '$file_path': $!\n"; | ||
|
|
||
| my $is_binary = 0; | ||
| while (read($fh, my $buffer, 1024)) { | ||
| if ($buffer =~ /[^\x09\x0A\x0D\x20-\x7E]/) { | ||
| $is_binary = 1; | ||
| last; | ||
| } | ||
| } | ||
| close($fh); | ||
|
|
||
| if ($is_binary) { | ||
| die "The file '$file_path' is a binary file. Please provide a text file.\n"; | ||
| } | ||
|
|
||
| open($fh, '<', $file_path) or die "Could not open file '$file_path': $!\n"; | ||
| my $content = do { local $/; <$fh> }; | ||
| close($fh); | ||
|
|
||
| my $word_count = scalar(split /\s+/, $content); | ||
| my $char_count = length($content); | ||
|
|
||
| print "The file '$file_path' contains $word_count words and $char_count characters.\n"; | ||
| ``` | ||
|
|
||
| ## Example prompt | ||
|
|
||
| `Tell me how I can convert this Perl script to Typescript. The functionality and output of the new script should be exactly the same as the existing one. Also tell me how to run the new file using Node.` | ||
|
|
||
| ## Example response | ||
|
|
||
| {% data variables.product.prodname_copilot_short %} generates the following Typescript code. | ||
|
|
||
| > [!NOTE] {% data variables.product.prodname_copilot_chat_short %} responses are non-deterministic, so you may get a different response from the one shown here. | ||
| ```typescript copy | ||
| import * as fs from 'fs'; | ||
| import * as path from 'path'; | ||
| import * as readline from 'readline'; | ||
|
|
||
| const rl = readline.createInterface({ | ||
| input: process.stdin, | ||
| output: process.stdout | ||
| }); | ||
|
|
||
| rl.question('Please enter the path to a local text file: ', (filePath) => { | ||
| rl.close(); | ||
|
|
||
| if (/[`|;&<>(){}\[\]]/.test(filePath) || (!path.isAbsolute(filePath) && path.dirname(filePath) !== '.')) { | ||
| console.error('Invalid file path. Please provide a valid path.'); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| if (!fs.existsSync(filePath)) { | ||
| console.error('File not found. Please provide an existing file path.'); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| const fileBuffer = fs.readFileSync(filePath); | ||
| const isBinary = fileBuffer.some(byte => byte < 9 || (byte > 13 && byte < 32) || byte > 126); | ||
|
|
||
| if (isBinary) { | ||
| console.error(`The file '${filePath}' is a binary file. Please provide a text file.`); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| const content = fileBuffer.toString('utf-8'); | ||
| const wordCount = content.split(/\s+/).length; | ||
| const charCount = content.length; | ||
|
|
||
| console.log(`The file '${filePath}' contains ${wordCount} words and ${charCount} characters.`); | ||
| }); | ||
| ``` | ||
|
|
||
| Save this file as `wordcount.ts`. | ||
|
|
||
| {% data variables.product.prodname_copilot_short %} goes on to explain how to run the new file using Node. | ||
|
|
||
| 1. **Install Node.js:** If you don't have it already, download and install Node.js from the official website: https://nodejs.org/. | ||
| 1. **Install TypeScript:** | ||
|
|
||
| ```shell | ||
| npm install -g typescript | ||
| ``` | ||
|
|
||
| 1. **Compile the TypeScript code:** | ||
|
|
||
| ```shell | ||
| tsc wordcount.ts | ||
| ``` | ||
|
|
||
| This will create a `wordcount.js` file in the same directory. | ||
|
|
||
| 1. **Run the JavaScript file with Node.js:** | ||
|
|
||
| ```shell | ||
| node wordcount.js | ||
| ``` | ||
|
|
||
| ## Further reading | ||
|
|
||
| {% data reusables.copilot.example-prompts.further-reading-items %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.