Enhanced Template Java class name substitution (#522)

* Enhanced Template Java class name substitution * Es linting fixes * Update user guide and package.json for default language template enhancements * Add Java template image to user guide for better clarity
agrawal-d · Jan 21, 2025 · 5bfc4eb · 5bfc4eb
1 parent 0f8b0ab
commit 5bfc4eb
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 2 deletions.
diff --git a/docs/img/javaTemplate.png b/docs/img/javaTemplate.png
diff --git a/docs/img/templateSettings.png b/docs/img/templateSettings.png
diff --git a/docs/user-guide.md b/docs/user-guide.md
@@ -105,6 +105,14 @@ Several options are available to customize the extension. Open VS Code settings
     down during codeforces submission.
 -   [Python] Command used to run python files. For eg. py, python3, pypy3, etc.
 
+## Default Language Templates
+- The path of the template that will be loaded when a new file of the default language is created by Competitive Companion
+- For Java Users, the template shall be in the format where class name is `CLASS_NAME` as the file name so that CLASS_NAME in the code gets auto replaced.
+\
+![Templates](img/templateSettings.png)
+![Templates](img/javaTemplate.png)
+
+
 ## Getting help
 
 If you have trouble using the extension, find any bugs, or want to request a new

diff --git a/package.json b/package.json
@@ -349,7 +349,7 @@
                 "cph.general.defaultLanguageTemplateFileLocation": {
                     "type": "string",
                     "default": "",
-                    "description": "The path of the template that will be loaded when a new file of the default language is created by Competitive Companion"
+                    "description": "The path to the template file that will be used when creating a new file for the default language via Competitive Companion. For Java templates, use 'CLASS_NAME' as a placeholder for the class name like 'class CLASS_NAME{...}'"
                 },
                 "cph.general.autoShowJudge": {
                     "type": "boolean",

diff --git a/src/companion.ts b/src/companion.ts
@@ -241,8 +241,16 @@ const handleNewProblem = async (problem: Problem) => {
                     `Template file does not exist: ${templateLocation}`,
                 );
             } else {
-                const templateContents =
+                let templateContents =
                     readFileSync(templateLocation).toString();
+
+                if (extn == 'java') {
+                    const className = path.basename(problemFileName, '.java');
+                    templateContents = templateContents.replace(
+                        'CLASS_NAME',
+                        className,
+                    );
+                }
                 writeFileSync(srcPath, templateContents);
             }
         }