@learnpack/learnpack 1.0.0 → 2.0.0

package/plugin/utils.js

@@ -1,78 +0,0 @@
-const chalk = require("chalk")
-
-const getMatches = (reg, content) => {
-    let inputs = [];
-    let m;
-    while ((m = reg.exec(content)) !== null) {
-        // This is necessary to avoid infinite loops with zero-width matches
-        if (m.index === reg.lastIndex) reg.lastIndex++;
-
-        // The result can be accessed through the `m`-variable.
-        inputs.push(m[1] || null);
-    }
-    return inputs;
-}
-
-const cleanStdout = (buffer, inputs) => {
-  if(Array.isArray(inputs))
-    for(let i = 0; i < inputs.length; i++)
-      if(inputs[i]) buffer = buffer.replace(inputs[i],'');
-
-  return buffer;
-}
-
-const indent = (string, count = 1, options) => {
-	options = {
-		indent: ' ',
-		includeEmptyLines: false,
-		...options
-	};
-
-	if (typeof string !== 'string') {
-		throw new TypeError(
-			`Expected \`input\` to be a \`string\`, got \`${typeof string}\``
-		);
-	}
-
-	if (typeof count !== 'number') {
-		throw new TypeError(
-			`Expected \`count\` to be a \`number\`, got \`${typeof count}\``
-		);
-	}
-
-	if (count < 0) {
-		throw new RangeError(
-			`Expected \`count\` to be at least 0, got \`${count}\``
-		);
-	}
-
-	if (typeof options.indent !== 'string') {
-		throw new TypeError(
-			`Expected \`options.indent\` to be a \`string\`, got \`${typeof options.indent}\``
-		);
-	}
-
-	if (count === 0) {
-		return string;
-	}
-
-	const regex = options.includeEmptyLines ? /^/gm : /^(?!\s*$)/gm;
-
-	return string.replace(regex, options.indent.repeat(count));
-};
-
-const Console = {
-    // _debug: true,
-    _debug: process.env.DEBUG == 'true',
-    startDebug: function(){ this._debug = true; },
-    log: (msg, ...args) => console.log(chalk.gray(msg), ...args),
-    error: (msg, ...args) => console.log(chalk.red('⨉ '+msg), ...args),
-    success: (msg, ...args) => console.log(chalk.green('✓ '+msg), ...args),
-    info: (msg, ...args) => console.log(chalk.blue('ⓘ '+msg), ...args),
-    help: (msg) => console.log(`${chalk.white.bold('⚠ help:')} ${chalk.white(msg)}`),
-    debug(...args){
-        this._debug && console.log(chalk.magentaBright(`⚠ debug: `), args)
-    }
-}
-
-module.exports = { getMatches, cleanStdout, indent, Console };

package/src/commands/audit.js

@@ -1,243 +0,0 @@
-const fs = require('fs')
-const fetch = require('node-fetch')
-const {validateExerciseDirectoryName} = require('../managers/config/exercise.js')
-const { flags } = require('@oclif/command')
-const Console = require('../utils/console')
-const { isUrl, findInFile, checkLearnpackClean, checkForEmptySpaces, showErrors, showWarnings } = require('../utils/audit')
-const SessionCommand = require('../utils/SessionCommand');
-const fm = require("front-matter")
-const path = require('path')
-
-class AuditCommand extends SessionCommand {
-    async init() {
-        const { flags } = this.parse(AuditCommand)
-        await this.initSession(flags)
-    }
-    async run() {
-        const { flags } = this.parse(AuditCommand)
-        
-        Console.log("Running command audit...")
-
-        // Get configuration object.
-        const config = this.configManager.get();
-        
-        let errors = []
-        let warnings = []
-        let counter = {
-            images: {
-                error: 0,
-                total: 0,
-            },
-            links: {
-                error: 0,
-                total: 0,
-            },
-            exercises: 0,
-            readmeFiles: 0
-        }
-        
-        // Checks if learnpack clean has been run
-        checkLearnpackClean(config, errors)
-
-        // Build exercises if they are not built yet.
-        if (!this.configManager.get().exercises) this.configManager.buildIndex()
-        
-        // Check if the exercises folder has some files within any ./exercise
-        const exercisesPath = config.config.exercisesPath
-        fs.readdir(exercisesPath, (err, files) => {
-            if (err) {
-                return console.log('Unable to scan directory: ' + err);
-            }
-            //listing all files using forEach
-            files.forEach(function (file) {
-                // Do whatever you want to do with the file
-                let filePath = path.join(exercisesPath, file)
-                if (fs.statSync(filePath).isFile()) warnings.push({ exercise: file, msg: `This file is not inside any exercise folder.` })
-            });
-        })
-
-        // This function checks that each of the url's are working.
-        const checkUrl = async (file, exercise) => {
-            if (!fs.existsSync(file.path)) return false
-            const content = fs.readFileSync(file.path).toString();
-            let isEmpty = checkForEmptySpaces(content);
-            if (isEmpty === true || content == false) errors.push({ exercise: exercise.title, msg: `This file (${file.name}) doesn't have any content inside.` })
-            const frontmatter = fm(content).attributes
-            for (const attribute in frontmatter) {
-                if (attribute === "intro" || attribute === "tutorial") {
-                    counter.links.total++
-                    try {
-                        let res = await fetch(frontmatter[attribute], { method: "HEAD" });
-                        if (!res.ok) {
-                            counter.links.error++;
-                            errors.push({ exercise: exercise.title, msg: `This link is broken (${res.ok}): ${frontmatter[attribute]}` })
-                        }
-                    }
-                    catch (error) {
-                        counter.links.error++;
-                        errors.push({ exercise: exercise.title, msg: `This link is broken: ${frontmatter[attribute]}` })
-                    }
-                }
-            }
-
-            // Check url's of each README file.
-            const findings = findInFile(["relative_images", "external_images", "markdown_links"], content);
-            for (const finding in findings) {
-                let obj = findings[finding];
-                // Valdites all the relative path images.
-                if (finding === "relative_images" && Object.keys(obj).length > 0) {
-                    for (const img in obj) {
-                        // Validates if the image is in the assets folder.
-                        counter.images.total++
-                        let relativePath = path.relative(exercise.path.replace(/\\/gm, "/"), `${config.config.dirPath}/assets/${obj[img].relUrl}`).replace(/\\/gm, "/")
-                        if (relativePath != obj[img].absUrl.split("?").shift()) {
-                            counter.images.error++;
-                            errors.push({ exercise: exercise.title, msg: `This relative path (${obj[img].relUrl}) is not pointing to the assets folder.` })
-                        }
-                        if (!fs.existsSync(`${config.config.dirPath}/assets/${obj[img].relUrl}`)) {
-                            counter.images.error++;
-                            errors.push({ exercise: exercise.title, msg: `The file ${obj[img].relUrl} doesn't exist in the assets folder.` })
-                        }
-                    }
-                } else if (finding === "external_images" && Object.keys(obj).length > 0) {
-                    // Valdites all the aboslute path images.
-                    for (const img in obj) {
-                        counter.images.total++
-                        try {
-                            let res = await fetch(obj[img].absUrl, { method: "HEAD" });
-                            if (!res.ok) {
-                                counter.images.error++;
-                                errors.push({ exercise: exercise.title, msg: `This link is broken: ${obj[img].absUrl}` })
-                            }
-                        }
-                        catch (error) {
-                            counter.images.error++;
-                            errors.push({ exercise: exercise.title, msg: `This link is broken: ${obj[img].absUrl}` })
-                        }
-                    }
-                } else if (finding === "markdown_links" && Object.keys(obj).length > 0) {
-                    for (const link in obj) {
-                        counter.links.total++
-                        try {
-                            let res = await fetch(obj[link].mdUrl, { method: "HEAD" });
-                            if (res.status > 399 && res.status < 200) {
-                                counter.links.error++;
-                                errors.push({ exercise: exercise.title, msg: `This link is broken: ${obj[link].mdUrl}` })
-                            }
-                        }
-                        catch (error) {
-                            counter.links.error++;
-                            errors.push({ exercise: exercise.title, msg: `This link is broken: ${obj[link].mdUrl}` })
-                        }
-                    }
-                }
-            }
-            return true
-        }
-
-        // This function is being created because the find method doesn't work with promises.
-        const find = async (file, lang, exercise) => {
-            if (file.name === lang) {
-                await checkUrl(file, exercise)
-                return true
-            }
-            return false
-        }
-
-        Console.info(' Checking if the config file is fine...')
-        // These two lines check if the 'slug' property is inside the configuration object.
-        Console.debug("Checking if the slug property is inside the configuration object...")
-        if (!config.config.slug) errors.push({ exercise: null, msg: "The slug property is not in the configuration object" })
-
-        // These two lines check if the 'repository' property is inside the configuration object.
-        Console.debug("Checking if the repository property is inside the configuration object...")
-        if (!config.config.repository) errors.push({ exercise: null, msg: "The repository property is not in the configuration object" })
-        else isUrl(config.config.repository, errors, counter)
-
-        // These two lines check if the 'description' property is inside the configuration object.
-        Console.debug("Checking if the description property is inside the configuration object...")
-        if (!config.config.description) errors.push({ exercise: null, msg: "The description property is not in the configuration object" })
-
-        if (errors.length == 0) Console.log("The config file is ok")
-
-        // Validates if images and links are working at every README file.
-        const exercises = config.exercises
-        let readmeFiles = []
-
-        if (exercises.length > 0) {
-            Console.info(' Checking if the images are working...')
-            for (const index in exercises) {
-                let exercise = exercises[index]
-                if (!validateExerciseDirectoryName(exercise.title)) errors.push({exercise: exercise.title, msg: `The exercise ${exercise.title} has an invalid name.`})
-                let readmeFilesCount = { exercise: exercise.title, count: 0 };
-                if (Object.keys(exercise.translations).length == 0) errors.push({ exercise: exercise.title, msg: `The exercise ${exercise.title} doesn't have a README.md file.` })
-
-                if (exercise.language == "python3" || exercise.language == "python") {
-                    exercise.files.map(f => f).find(f => {
-                        if (f.path.includes('test.py') || f.path.includes('tests.py')) {
-                            const content = fs.readFileSync(f.path).toString();
-                            let isEmpty = checkForEmptySpaces(content);
-                            if (isEmpty === true || content == false) errors.push({ exercise: exercise.title, msg: `This file (${f.name}) doesn't have any content inside.` })
-                        }
-                    });
-                }
-                else {
-                    exercise.files.map(f => f).find(f => {
-                        if (f.path.includes('test.js') || f.path.includes('tests.js')) {
-                            const content = fs.readFileSync(f.path).toString();
-                            let isEmpty = checkForEmptySpaces(content);
-                            if (isEmpty === true || content == false) errors.push({ exercise: exercise.title, msg: `This file (${f.name}) doesn't have any content inside.` })
-                        }
-                    });
-                }
-
-                for (const lang in exercise.translations) {
-                    let files = []
-                    for (const file of exercise.files) {
-                        let found = await find(file, exercise.translations[lang], exercise)
-                        if (found == true) readmeFilesCount = { ...readmeFilesCount, count: readmeFilesCount.count + 1 }
-                        files.push(found)
-                    }
-                    if (!files.includes(true)) errors.push({ exercise: exercise.title, msg: `This exercise doesn't have a README.md file.` })
-
-                }
-                readmeFiles.push(readmeFilesCount)
-            }
-        } else errors.push({ exercise: null, msg: "The exercises array is empty." })
-
-        Console.log(`${counter.images.total - counter.images.error} images ok from ${counter.images.total}`)
-
-        Console.info(" Checking if important files are missing... (README's, translations, gitignore...)")
-        // Check if all the exercises has the same ammount of README's, this way we can check if they have the same ammount of translations.
-        let files = [];
-        readmeFiles.map((item, i, arr) => {
-            if (item.count !== arr[0].count) files.push(` ${item.exercise}`)
-        })
-        if (files.length > 0) {
-            files = files.join()
-            warnings.push({ exercise: null, msg: `These exercises are missing translations: ${files}` })
-        }
-
-        // Checks if the .gitignore file exists.
-        if (!fs.existsSync(`.gitignore`)) warnings.push(".gitignore file doesn't exist")
-
-        counter.exercises = exercises.length;
-        readmeFiles.forEach((readme) => {
-            counter.readmeFiles += readme.count
-        })
-
-        await showWarnings(warnings)
-        await showErrors(errors, counter)
-    }
-}
-
-AuditCommand.description = `Check if the configuration object has slug, description and repository property
-...
-Extra documentation goes here
-`
-
-AuditCommand.flags = {
-    // name: flags.string({char: 'n', description: 'name to print'}),
-}
-
-module.exports = AuditCommand

package/src/commands/clean.js

@@ -1,27 +0,0 @@
-const {flags} = require('@oclif/command')
-const Console = require('../utils/console')
-const SessionCommand = require('../utils/SessionCommand')
-class CleanCommand extends SessionCommand {
-  async init() {
-    const {flags} = this.parse(CleanCommand)
-    await this.initSession(flags)
-  }
-  async run() {
-    const {flags} = this.parse(CleanCommand)
-    
-    this.configManager.clean()
-
-    Console.success("Package cleaned successfully, ready to publish")
-  }
-}
-
-CleanCommand.description = `Clean the configuration object
-...
-Extra documentation goes here
-`
-
-CleanCommand.flags = {
-  // name: flags.string({char: 'n', description: 'name to print'}),
-}
-
-module.exports = CleanCommand

package/src/commands/download.js

@@ -1,52 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const fetch = require('node-fetch');
-const { clone } = require('../managers/file.js')
-const Console = require('../utils/console')
-const api = require('../utils/api')
-const getRepoInfo = require('git-repo-info')
-const { askPackage } = require('../ui/download')
-
-class DownloadCommand extends Command {
-  // async init() {
-  //   const {flags} = this.parse(DownloadCommand)
-  //   await this.initSession(flags)
-  // }
-  async run() {
-    const {flags, args} = this.parse(DownloadCommand)
-    // start watching for file changes
-    let _package = args.package
-    if(!_package) _package = await askPackage()
-    
-    if(!_package) return null
-
-    try{
-      _package = _package.pack;
-      clone(_package.repository)
-        .then(result => {
-          Console.success(`Successfully downloaded`)
-          const folder = _package.repository.substring(_package.repository.lastIndexOf('/') + 1).split(".")[0];
-          Console.info(`You can now CD into the folder like this: $ cd ${folder}`)
-        })
-        .catch(error => Console.error(error.message || error))
-    }
-    catch(error){}
-  }
-}
-
-DownloadCommand.description = `Describe the command here
-...
-Extra documentation goes here
-`
-DownloadCommand.flags = {
-  // name: flags.string({char: 'n', description: 'name to print'}),
-}
-DownloadCommand.args =[
-  {
-    name: 'package',               // name of arg to show in help and reference with args[name]
-    required: false,            // make the arg required with `required: true`
-    description: 'The unique string that identifies this package on learnpack', // help description
-    hidden: false               // hide this arg from help
-  }
-]
-
-module.exports = DownloadCommand

package/src/commands/hello.js

@@ -1,20 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-
-class HelloCommand extends Command {
-  async run() {
-    const {flags} = this.parse(HelloCommand)
-    const name = flags.name || 'world'
-    this.log(`hello ${name} from ./src/commands/hello.js`)
-  }
-}
-
-HelloCommand.description = `Describe the command here
-...
-Extra documentation goes here
-`
-
-HelloCommand.flags = {
-  name: flags.string({char: 'n', description: 'name to print'}),
-}
-
-module.exports = HelloCommand

package/src/commands/init.js

@@ -1,133 +0,0 @@
-const {flags} = require('@oclif/command')
-const BaseCommand = require('../utils/BaseCommand')
-
-const fs = require('fs-extra')
-const prompts = require('prompts')
-const cli = require("cli-ux").default
-const eta = require("eta")
-
-const Console = require('../utils/console')
-const { ValidationError } = require('../utils/errors')
-let defaults = require('../managers/config/defaults.js')
-
-const path = require('path')
-const { resolve } = require('path')
-
-class InitComand extends BaseCommand {
-  async run() {
-    const {flags} = this.parse(InitComand)
-
-    try{
-      // if the folder/file .learn or .breathecode aleady exists
-      await alreadyInitialized();
-    }
-    catch(error){
-      Console.error(error.message)
-      return false
-    }
-
-    let choices = await prompts([
-        {
-          type: 'select',
-          name: 'grading',
-          message: 'Is the auto-grading going to be isolated or incremental?',
-          choices: [
-            { title: 'Incremental: Build on top of each other like a tutorial', value: 'incremental' },
-            { title: 'Isolated: Small isolated exercises', value: 'isolated' },
-            { title: 'No grading: No feedback or testing whatsoever', value: null },
-          ],
-        },{
-          type: 'text',
-          name: 'title',
-          initial: 'My Interactive Tutorial',
-          message: 'Title for your tutorial? Press enter to leave as it is'
-        },{
-          type: 'text',
-          name: 'description',
-          initial: '',
-          message: 'Description for your tutorial? Press enter to leave blank'
-        },{
-          type: 'select',
-          name: 'difficulty',
-          message: 'How difficulty will be to complete the tutorial?',
-          choices: [
-            { title: 'Begginer (no previous experience)', value: 'beginner' },
-            { title: 'Easy (just a bit of experience required)', value: 'easy' },
-            { title: 'Intermediate (you need experience)', value: 'intermediate' },
-            { title: 'Hard (master the topic)', value: 'hard' },
-          ],
-        },{
-          type: 'text',
-          name: 'duration',
-          initial: "1",
-          message: 'How many hours avg it takes to complete (number)?',
-          validate: value => {
-            var n = Math.floor(Number(value))
-            return n !== Infinity && String(n) === value && n >= 0
-          }
-        }
-    ])
-
-    const packageInfo = {
-      ...defaults.config,
-      grading: choices.grading,
-      difficulty: choices.difficulty,
-      duration: parseInt(choices.duration),
-      description: choices.description,
-      title: choices.title,
-      slug: choices.title.toLowerCase().replace(/ /g,'-').replace(/[^\w-]+/g,'')
-    }
-
-    cli.action.start('Initializing package')
-
-    const languages = ['en', 'es']
-    
-    try{
-      const templatesDir = path.resolve(__dirname,"../utils/templates/"+choices.grading || "no-grading")
-      if(!fs.existsSync(templatesDir)) throw ValidationError(`Template ${templatesDir} does not exists`)
-      await fs.copySync(templatesDir, './')
-      
-      // Creating README files
-      languages.forEach((language) => {
-        const readmeFilename = `README${language !== 'en' ? `.${language}` : ''}`
-        fs.writeFileSync(`./${readmeFilename}.md`, eta.render(fs.readFileSync(path.resolve(__dirname,`${templatesDir}/${readmeFilename}.ejs`),'utf-8'), packageInfo))
-        if(fs.existsSync(`./${readmeFilename}.ejs`)) fs.removeSync(`./${readmeFilename}.ejs`)
-      })
-
-      if(!fs.existsSync('./.gitignore')) fs.copyFile(path.resolve(__dirname,'../utils/templates/gitignore.txt'), './.gitignore')
-      fs.writeFileSync('./learn.json', JSON.stringify(packageInfo, null, 2))
-    }
-    catch(error){
-      Console.error(error.message || error)
-      return false
-    }
-
-    cli.action.stop()                
-    Console.success(`😋 Package initialized successfully`)
-    Console.help(`Start the exercises by running the following command on your terminal: $ learnpack start`)
-
-  }
-}
-
-InitComand.description = 'Create a new learning package: Book, Tutorial or Exercise'
-InitComand.flags = {
-  ...BaseCommand.flags,
-  grading: flags.help({char:'h'}),
-}
-
-const alreadyInitialized = () => new Promise((resolve, reject) => {
-  fs.readdir('./', function(err, files) {
-    files = files.filter(f => ['.learn', 'learn.json', 'bc.json', '.breathecode', '.gitignore'].includes(f))
-    if (err) {
-      reject(ValidationError(err.message))
-      return true
-    } else if (files.length > 0){
-      reject(ValidationError("It seems the package is already initialized because we've found the following files: "+files.join(',')))
-      return true
-    } 
-
-    resolve(false)
-  })
-})
-
-module.exports = InitComand

package/src/commands/login.js

@@ -1,45 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const { prompt } = require("enquirer")
-const fetch = require('node-fetch');
-const SessionCommand = require('../utils/SessionCommand')
-const SessionManager = require('../managers/session.js')
-const Console = require('../utils/console');
-const { replace } = require('node-emoji');
-const { validURL } = require("../utils/validators")
-// const BaseCommand = require('../utils/BaseCommand');
-
-class PublishCommand extends SessionCommand {
-  async init() {
-    const {flags} = this.parse(PublishCommand)
-    await this.initSession(flags)
-  }
-  async run() {
-    const {flags, args} = this.parse(PublishCommand)
-
-    try{
-      await SessionManager.login();
-    }
-    catch(error){
-      Console.error("Error trying to authenticate")
-      Console.error(error.message || error)
-    }
-  }
-}
-
-PublishCommand.description = `Describe the command here
-...
-Extra documentation goes here
-`
-PublishCommand.flags = {
-  // name: flags.string({char: 'n', description: 'name to print'}),
-}
-PublishCommand.args =[
-  {
-    name: 'package',               // name of arg to show in help and reference with args[name]
-    required: false,            // make the arg required with `required: true`
-    description: 'The unique string that identifies this package on learnpack', // help description
-    hidden: false               // hide this arg from help
-  }
-]
-
-module.exports = PublishCommand

package/src/commands/logout.js

@@ -1,39 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const { prompt } = require("enquirer")
-const fetch = require('node-fetch');
-const SessionCommand = require('../utils/SessionCommand')
-const SessionManager = require('../managers/session.js')
-const Console = require('../utils/console');
-const { replace } = require('node-emoji');
-const { validURL } = require("../utils/validators")
-// const BaseCommand = require('../utils/BaseCommand');
-
-class PublishCommand extends SessionCommand {
-  async init() {
-    const {flags} = this.parse(PublishCommand)
-    await this.initSession(flags)
-  }
-  async run() {
-    const {flags, args} = this.parse(PublishCommand)
-
-    SessionManager.destroy();
-  }
-}
-
-PublishCommand.description = `Describe the command here
-...
-Extra documentation goes here
-`
-PublishCommand.flags = {
-  // name: flags.string({char: 'n', description: 'name to print'}),
-}
-PublishCommand.args =[
-  {
-    name: 'package',               // name of arg to show in help and reference with args[name]
-    required: false,            // make the arg required with `required: true`
-    description: 'The unique string that identifies this package on learnpack', // help description
-    hidden: false               // hide this arg from help
-  }
-]
-
-module.exports = PublishCommand