Language + Doc + KeyBinding

* Allow multiple languages. See [languages](doc/languages.md)
* Add two mini-tutorials and improve readme.
* Key bindings for frequent commands

CHANGELOG.md

@@ -7,6 +7,9 @@ All notable updates and fixes to the "acmX" extension will be documented in this
 * Users can create empty contest to be filled manually. Rename `personal` to `empty`.
 * New configuration to set solutions folder. Important to set it before using the tool.
 * Create contest with better names.
+* Allow multiple languages. See [languages](doc/languages.md)
+* Add two mini-tutorials and improve readme.
+* Add key bindings for frequent commands.
 
 ## 0.1.4
 

README.md

@@ -14,11 +14,11 @@
 
 ## How am I supposed to use **acmX**
 
-**acmX** have been designed to run automatically boilerplate actions [I](https://codeforces.com/profile/marX) repeat often in competitive programming. This is the expected pipeline to interact with it.
+**acmX** have been designed to run automatically boilerplate actions [I](https://codeforces.com/profile/marX) repeat often in competitive programming. Next is the expected pipeline to interact with it. It is important that you [setup some configurations](#getting-started) before start using the tool.
 
 * Create a contest calling `New Contest` or maybe a single problem calling `New Problem`. Testcases are downloaded automatically :)
 
-* Start coding awesome solution inside file `sol.cpp`. Right now solutions are only available in C++.
+* Start coding awesome solution inside file `sol.cpp`.
 
 * After you finish the code call `Run` and automatically your program will be compiled and run against every testcases. If the solutions seems to be ok, it will be reported otherwise you will see failing testcase in a *cool layout*. You can always go back to original layout calling `View: Code`.
 
@@ -48,10 +48,28 @@ The environment structure is the following:
 
 Certainly **acmX** can be (and hopefully will be) extended so that it fits everyones pipeline. If **acmX** almost fit yours, feel free to improve it and make a PR! I'll be happy to hear from you and give you support. If you find any issue report it at [github issue tracker](https://github.com/mfornet/acmx/issues).
 
+## Getting started
+
+You need to tell **acmX** which folder are you going to use, to save all the problems and contests. To do that:
+
+* Open settings (from command palette) or `Ctrl+,`
+* Go to `acmx.configuration.solutionPath`
+* Set this value to the path you are going to use to store contests and problems. (e.g. `/path/to/my/solutions`)
+
+I encourage everyone to read and change [all settings](#settings) so you can customize **acmX** for you. Anyway, after updating `acmx.configuration.solutionPath` it should work good for C++ users.
+
 ## Default template is awful, how can I change it
 
 Create a file with your template. In settings change `acmx.configuration.templatePath` to the path of your templates file.
 
+## What is contest id on each platform
+
+You can find this information for every supported platform [here](doc/platforms-id.md).
+
+## I code in java, can I use this tool
+
+Yes, of course, and any other language you want. Just make sure to update your [language configuration](doc/languages.md) setting.
+
 ## Commands
 
 Call this commands from the command pallete (`Ctrl + Shift + P`).
@@ -69,6 +87,8 @@ Call this commands from the command pallete (`Ctrl + Shift + P`).
 ## Settings
 
 * **acmx.configuration.templatePath**: Path to template file. Leave empty to use default template.
+* **acmx.configuration.solutionPath**: Path to folder where contest will be created and stored. To set active workspace use `.`
+* **acmx.configuration.extension**: Extension of the programming language you will use to code solutions. Default `cpp` for c++
 * **acmx.run.timetimeLimit**: Maximum time limit in seconds to run the program on each test case.
-* **acmx.execution.compileCpp**: Command to compile C++ programs. Refer to the code as $PROGRAM, and output file as $OUTPUT.
+* **acmx.execution.compile**: Command to compile C++ programs. Refer to the code as $PROGRAM, and output file as $OUTPUT.
 * **acmx.execution.pythonPath**: Path to python executable. This will be used to run generator.

doc/contributing.md

@@ -0,0 +1,3 @@
+# Contributing
+
+If you are going to add a new platform, remember to update [platforms-id](platforms-id.md).

doc/languages.md

@@ -0,0 +1,15 @@
+# Languages
+
+You can use whatever language you want. To do that change settings properly:
+
+* Open settings (from command palette) or `Ctrl+,`
+* Go to `acmx.execution.compile`
+* Change this value to run your compilation line.
+
+You have access to two variable in this line:
+
+* `$PROGRAM` the path to your solution. (in the case of C++ `/path/to/sol.cpp`)
+* `$OUTPUT` the path to an executable that run your program.
+
+By default it is: `g++ -std=c++11 $PROGRAM -o $OUTPUT` which compile c++11 code using g++.
+You can use other compilers, or even better, awesome scripts that solve your particular problem.

doc/platforms-id.md

@@ -0,0 +1,13 @@
+# Platforms ID
+
+Users need to specify problem/contest identifier to **acmX** for processing. This is an specification of what is every platform id.
+
+## Codeforces
+
+In [codeforces](https://codeforces.com) from the URL of a problem you can identify both contest id and problem id in the following format such that `PROBLEM_ID=CONTEST_ID-LETTER`:
+
+https://codeforces.com/contest/{CONTEST_ID}/problem/{LETTER}
+
+For example in problem (https://codeforces.com/contest/1101/problem/G) identifiers are `CONTEST_ID=1101` and `PROBLEM_ID=1101-G`.
+
+Notice that contest id don't coincide with round number.

package.json

@@ -5,13 +5,13 @@
     "icon": "images/logo.png",
     "publisher": "marx24",
     "version": "0.1.4",
-	"license": "MIT",
+    "license": "MIT",
     "engines": {
         "vscode": "^1.30.0"
     },
     "author": {
-		"name": "Marcelo Fornet"
-	},
+        "name": "Marcelo Fornet"
+    },
     "categories": [
         "Other"
     ],
@@ -30,42 +30,46 @@
     "main": "./out/extension",
     "contributes": {
         "configuration": [
-			{
-				"title": "acmX",
-				"properties": {
-					"acmx.run.timeLimit": {
-						"type": "number",
-						"default": 2,
-						"description": "Maximum time limit in seconds to run the program on each test case.",
-						"scope": "resource"
+            {
+                "title": "acmX",
+                "properties": {
+                    "acmx.run.timeLimit": {
+                        "type": "number",
+                        "default": 2,
+                        "description": "Maximum time limit in seconds to run the program on each test case.",
+                        "scope": "resource"
                     },
-
-					"acmx.execution.compileCpp": {
+                    "acmx.execution.compile": {
                         "type": "string",
-						"default": "g++ -std=c++11 $PROGRAM -o $OUTPUT",
-						"description": "Command to compile the program. Refer to the code as $PROGRAM, and output file as $OUTPUT.",
-						"scope": "resource"
-					},
-					"acmx.execution.pythonPath": {
+                        "default": "g++ -std=c++11 $PROGRAM -o $OUTPUT",
+                        "description": "Command to compile the program. Refer to the code as $PROGRAM, and output file as $OUTPUT.",
+                        "scope": "resource"
+                    },
+                    "acmx.execution.pythonPath": {
+                        "type": "string",
+                        "default": "/usr/bin/python3",
+                        "description": "Path to python executable.",
+                        "scope": "resource"
+                    },
+                    "acmx.configuration.templatePath": {
                         "type": "string",
-						"default": "/usr/bin/python3",
-						"description": "Path to python executable.",
-						"scope": "resource"
+                        "default": "",
+                        "description": "Path to template file. Leave empty to use default template.",
+                        "scope": "resource"
                     },
-
-					"acmx.configuration.templatePath": {
+                    "acmx.configuration.solutionPath": {
                         "type": "string",
-						"default": "",
-						"description": "Path to template file. Leave empty to use default template.",
-						"scope": "resource"
-					},
-					"acmx.configuration.solutionPath": {
+                        "default": ".",
+                        "description": "Path to folder where contest will be created and stored. To set active workspace use `.`",
+                        "scope": "resource"
+                    },
+                    "acmx.configuration.extension": {
                         "type": "string",
-						"default": ".",
-						"description": "Path to folder where contest will be created and stored. To set active workspace use `.`",
-						"scope": "resource"
-					}
-				}
+                        "default": "cpp",
+                        "description": "Extension of the programming language you will use to code solutions. Default `cpp` for c++",
+                        "scope": "resource"
+                    }
+                }
             }
         ],
         "commands": [
@@ -105,6 +109,24 @@
                 "command": "acmx.compile",
                 "title": "ACMX: Compile"
             }
+        ],
+        "keybindings": [
+            {
+                "command": "acmx.compile",
+                "key": "ctrl+alt+b"
+            },
+            {
+                "command": "acmx.runSolution",
+                "key": "ctrl+alt+l"
+            },
+            {
+                "command": "acmx.stress",
+                "key": "ctrl+alt+k"
+            },
+            {
+                "command": "acmx.coding",
+                "key": "ctrl+alt+o"
+            }
         ]
     },
     "scripts": {
@@ -116,12 +138,12 @@
     },
     "repository": {
         "type": "git",
-		"url": "https://github.com/mfornet/acmx.git"
+        "url": "https://github.com/mfornet/acmx.git"
+    },
+    "bugs": {
+        "url": "https://github.com/mfornet/acmx/issues",
+        "email": "mfornet94@gmail.com"
     },
-	"bugs": {
-		"url": "https://github.com/mfornet/acmx/issues",
-		"email": "mfornet94@gmail.com"
-	},
     "devDependencies": {
         "@types/got": "^9.3.0",
         "@types/mocha": "^2.2.42",
@@ -136,4 +158,4 @@
         "sync-request": "^6.0.0",
         "unescape": "^1.0.1"
     }
-}
+}

src/core.ts

@@ -10,6 +10,14 @@ export const TESTCASES = 'testcases';
 export const ATTIC = 'attic';
 const SRC = dirname(__filename);
 
+/**
+ * Name of program file. Take extension dynamically from configuration
+ */
+export function solFile(){
+    let extension: string|undefined = vscode.workspace.getConfiguration('acmx.configuration', null).get('extension');
+    return 'sol.' + extension;
+}
+
 export function getTimeout(){
     let timeout: number|undefined = vscode.workspace.getConfiguration('acmx.run', null).get('timeLimit');
     timeout = timeout! * 1000;
@@ -24,7 +32,7 @@ function getMaxSizeInput(){
 }
 
 function isProblemFolder(path: string) {
-    return  existsSync(join(path, 'sol.cpp')) &&
+    return  existsSync(join(path, solFile())) &&
             existsSync(join(path, 'attic'));
 }
 
@@ -112,10 +120,10 @@ export function newArena(path: string){
     let templatePath: string | undefined = vscode.workspace.getConfiguration('acmx.configuration', null).get('templatePath');
 
     if (templatePath! === ""){
-        templatePath = join(SRC, 'static', 'sol.cpp');
+        templatePath = join(SRC, 'static', solFile());
     }
 
-    copyFileSync(templatePath!, join(path, 'sol.cpp'));
+    copyFileSync(templatePath!, join(path, solFile()));
     copyFileSync(join(SRC, 'static', 'checker'), join(path, ATTIC, 'checker'));
 }
 
@@ -161,7 +169,7 @@ export function upgradeArena(path: string) {
 
     if (!existsSync(brute)){
         // Create brute.cpp file
-        copyFileSync(join(SRC, 'static', 'sol.cpp'), brute);
+        copyFileSync(join(SRC, 'static', solFile()), brute);
     }
 
     let generator = join(path, 'gen.py');
@@ -282,7 +290,7 @@ export function timedRun(path: string, tcName: string, timeout: number){
 }
 
 export function compileCode(pathCode: string, pathOutput: string){
-    let instruction: string | undefined = vscode.workspace.getConfiguration('acmx.execution', null).get('compileCpp');
+    let instruction: string | undefined = vscode.workspace.getConfiguration('acmx.execution', null).get('compile');
     let splitedInstruction = instruction!.split(' ');
 
     for (let i = 0; i < splitedInstruction.length; ++i){
@@ -296,7 +304,7 @@ export function compileCode(pathCode: string, pathOutput: string){
 }
 
 export function testSolution(path: string){
-    let sol = join(path, 'sol.cpp');
+    let sol = join(path, solFile());
     let out = join(path, ATTIC, 'sol');
 
     if (!existsSync(sol)){
@@ -307,7 +315,7 @@ export function testSolution(path: string){
     let xresult = compileCode(sol, out);
 
     if (xresult.status !== 0){
-        throw new Error("Compilation Error. sol.cpp");
+        throw new Error(`Compilation Error. ${sol}`);
     }
 
     let testcasesId = testcasesName(path);
@@ -364,7 +372,7 @@ function generateTestcase(path: string){
 }
 
 export function stressSolution(path: string, times: number = 10){
-    let sol = join(path, 'sol.cpp');
+    let sol = join(path, solFile());
     let out = join(path, ATTIC, 'sol');
     let brute = join(path, 'brute.cpp');
 
@@ -380,12 +388,12 @@ export function stressSolution(path: string, times: number = 10){
 
     let solCompileResult = compileCode(sol, out);
     if (solCompileResult.status !== 0){
-        throw new Error("Compilation Error. sol.cpp");
+        throw new Error(`Compilation Error. ${sol}`);
     }
 
     let bruteCompileResult = compileCode(brute, brout);
     if (bruteCompileResult.status !== 0){
-        throw new Error("Compilation Error. brute.cpp");
+        throw new Error(`Compilation Error. ${brute}`);
     }
 
     let results = [];
@@ -412,7 +420,7 @@ export function stressSolution(path: string, times: number = 10){
         writeSync(currentFd, runResult.stdout);
         closeSync(currentFd);
 
-        // Check sol.cpp report same result than brute.cpp
+        // Check sol report same result than brute
         let result = timedRun(path, 'gen', getTimeout());
 
         if (result.status !== Veredict.OK){

src/extension.ts

@@ -3,7 +3,7 @@ import * as vscode from 'vscode';
 import { existsSync, writeFileSync, readdirSync } from 'fs';
 import { join, extname } from 'path';
 import { SITES } from './conn';
-import { newContestFromId, testSolution, veredictName, stressSolution, upgradeArena, newProblemFromId, removeExtension } from './core';
+import { newContestFromId, testSolution, veredictName, stressSolution, upgradeArena, newProblemFromId, removeExtension, solFile } from './core';
 import { Veredict, SiteDescription } from './types';
 import { currentProblem, compileCode, ATTIC } from './core';
 import { getSite } from "./conn";
@@ -50,7 +50,7 @@ async function addProblem() {
     await vscode.commands.executeCommand("vscode.openFolder", vscode.Uri.file(problemPath));
     // TODO: 007
     // Just want to run two commands below
-    // await vscode.commands.executeCommand("vscode.open", vscode.Uri.file("sol.cpp"));
+    // await vscode.commands.executeCommand("vscode.open", vscode.Uri.file(solFile()));
     // vscode.window.showInformationMessage(`Add problem ${site}/${id} at ${path}`);
 }
 
@@ -101,7 +101,7 @@ async function debugTestcase(path: string, tcId: string){
     // Change editor layout to show failing test
     await vscode.commands.executeCommand("vscode.setEditorLayout", { orientation: 0, groups: [{ groups: [{}], size: 0.5 }, { groups: [{}, {}, {}], size: 0.5 }] });
 
-    let sol = join(path, `sol.cpp`);
+    let sol = join(path, solFile());
     let inp = join(path, TESTCASES, `${tcId}.in`);
     let out = join(path, TESTCASES, `${tcId}.out`);
     let cur = join(path, TESTCASES, `${tcId}.real`);
@@ -143,7 +143,7 @@ async function compile(){
         return;
     }
 
-    let sol = join(path, 'sol.cpp');
+    let sol = join(path, solFile());
     let out = join(path, ATTIC, 'sol');
 
     if (!existsSync(sol)){
@@ -154,7 +154,7 @@ async function compile(){
     let xresult = compileCode(sol, out);
 
     if (xresult.status !== 0){
-        throw new Error("Compilation Error. sol.cpp");
+        throw new Error(`Compilation Error. ${sol}`);
     }
     else{
         vscode.window.showInformationMessage("Compilation successfully.");
@@ -230,7 +230,7 @@ async function coding() {
 
     await vscode.commands.executeCommand("vscode.setEditorLayout", { groups: [{}]});
 
-    let sol = join(path, `sol.cpp`);
+    let sol = join(path, solFile());
 
     await vscode.commands.executeCommand("vscode.open", vscode.Uri.file(sol), vscode.ViewColumn.One);
 }

todo.md

@@ -1,10 +1,8 @@
 # List of TODO
 
-* **WOW** Use this tool: [caide-cpp-inliner](https://github.com/slycelote/caide-cpp-inliner). Suggestion from jcg
+* **WOW** Use this tool: [caide-cpp-inliner](https://github.com/slycelote/caide-cpp-inliner). Suggestion from jcg. Also find https://github.com/slycelote/caide
 * When a new view is activated (after run or view:code) close all open tabs. (also (maybe) collapse everything not related to the problem)
-* Allow programming in other languages than c++ (easy now)
 * Implement parser for codeforces-gym/codechef/atcoder/matcomgrader/coj (which are most popular online judges currently)
-* TODO: Test add problem/add contest with codeforces problems (mostly folder and names where are created)
 
 * [005](/src/core.ts): Restrict brute in time, and capture errors
   * Allow stopping a running program (such as sol.cpp/brute.cpp/gen.py/etc...)
@@ -12,27 +10,12 @@
 
 ## QUICK TODO
 
-
-* Update README to support multiple languages (only that need to be properly setted is compilation line. Even python is accepted) User need to provide line that take $PROGRAM file and makes and executable at $OUTPUT (this can be anything). Make an example of how to do that for python and maybe other languages. This would be good as a separate minitutorial linked here
-* Move minitutorials to doc folder and write a minitutorial on what is contest-id problem-id etc on each platform to avoid doubts
-
-* On README First steps:
-  * Folder to store contests
-  * Compilation line (in sevaral languages linking minitutorial)
-  * Path to template
-
+* Test add problem/add contest with codeforces problems (mostly folder and names where are created)
+* Test and provide example using other languages.
 * Copy to clipboard (smart copy in the future with tool suggested by jcg) (Find in examples, create shortcut)
-* Create shortcut to Run/Stress/Compile/etc...
 
 ## Settings
 
-Global settings
-
-* [x] Time Limit
-* [X] Template file
-* [X] Line to execute C++ (Upgrade this line, by increasing stack and making optimizations by default)
-* [X] Line to execute Python
-
 Particular settings (per problem) configuration on current workspace.
 This can be done creating such configurations globally and udpating them per workspace (only problem here is that in one workspace might coexist several programs so best answer is probably creating a config file inside each problem and access them through cool UI settings provided by VSCode. This can be done since GitLens already do that.) Store also problem name on this config file, maybe URL.