Repository files navigation

Table of Contents

• Getting Started
  • To get general help
  • Generate a coding challenge selecting each parameter
  • Generate apython3 coding challenge
  • Generate ajavascript coding challenge
  • Generate ajava coding challenge
• Coding Challenge Contents
  • README File
  • Index File
  • Test File
  • Test Framework File
  • Run File
• Advanced Usage
• Judge0 Submission
• Future Roadmap

This CLI generates a challenge folder based on thechallenge-generator-backend API. The content of the folder is described in thechallenge content section.

The usual flow is the following:

graph LR    A((START)) --> B{Select Type}    B --> |Custom| E[\Answer all the questions\]    B --> |Completely Random| F[(Fetch Challenge from the API)]    E --> F    F --> G[/Create the Files/]    G --> H((END))

For further customization, go to theAdvanced Usage section.If you want to take a look at the modules documentation, clickhere.

npx @roeeyn/challenge-generator --help

# To skip a parameter just press Enternpx @roeeyn/challenge-generator

npx @roeeyn/challenge-generator --programming-language python3 -s

npx @roeeyn/challenge-generator --programming-language javascript -s

⚠️ Even if we can create a challenge for Java, we haven't tested it yet on Jude0 so the submission tools may not work correctly as the testframework and run file are not yet implemented.

npx @roeeyn/challenge-generator --programming-language java -s

The created coding challenge folder contains the following files:

• README File
• Index File
• Test File
• Test Framework File
• Run File

This is the file which contains the coding challenge description, and some of the examples provided. This is usually provided as a markdown file, so the formatted is done automatically.

The index file contains the initial function of the coding challenge, which should be given to the user directly.

This is the file which contains all the unit tests for the coding challenge. This usually make use of the custom testing framework provided, but see theTest Framework File for the details.

This file contains ourminified custom testing framework, to validate that the code uploaded from the user is correct. To see the original framework, see thetemplates folder.

⚠️ We have include the most used functions, but there are coding challenges that contains specific testing for that specific coding challenge and our test framework may not work on that.This is not usual, though.

This file contains the execution script to run whenever this coding challenge is uploaded to Judge0.

We can filter most of the params we want the coding challenge to contain. These are the following:

We created a script (judge0-submissioner) that can help you testing the submissions into judge0 easily, you can find it in theexamples folder. The basic usage of this script is the following:

# Maybe you need to give execution accesschmod +x ./examples/judge0-submissioner.sh# Set the judge0 token (auth, not user)export JUDGE0_AUTH_TOKEN='YOUR_AUTH_TOKEN'# Submit the coding challenge solution and the extension (py or js)./examples/judge0-submissioner.sh your_challenge_directory your_lang_extension# Real example./examples/judge0-submissioner.sh ./challenge-proper-modulo-operator js

• Improve Judge0 submissioner to a better CLI.
• Warn the user if some unexpected element is present in the tests.