@learnpack/learnpack 5.0.6 → 5.0.8

package/src/managers/test.ts

@@ -1,83 +1,83 @@
-/*
-
-import * as path from 'path'
-import * as shell from 'shelljs'
-import * as fs from 'fs'
-import { TestingError } from './errors'
-import Console from '../utils/console'
-import * as color from 'colors'
-import bcActivity from './bcActivity.js'
-import { CompilerError } from '../utils/errors'
-import { ISocket } from '../models/socket'
-import { IFile } from '../models/file'
-import { IConfig } from '@oclif/config'
-
-module.exports = async function ({ socket, files, config, slug }: {socket: ISocket, files: IFile[], config: IConfig, slug: string}) {
-
-  const configPath = path.resolve(__dirname, `./config/tester/${config.tester}/${config.language}.config.js`);
-  if (!fs.existsSync(configPath)) throw CompilerError(`Uknown testing engine for compiler: '${config.language}'`);
-
-  const testingConfig = require(configPath)(files, config, slug);
-  testingConfig.validate();
-
-  if (config.ignoreTests) throw TestingError('Grading is disabled on learn.json file.');
-
-  if (!fs.existsSync(`${config.dirPath}/reports`)) {
-    fs.mkdirSync(`${config.dirPath}/reports`);
-    Console.debug(`Creating the ${config.dirPath}/reports directory`);
-  }
-
-  Console.info('Running tests...');
-
-  const command = await testingConfig.getCommand(socket)
-  const { stdout, stderr, code } = shell.exec(command);
-
-  if (code != 0) {
-    const errors = typeof (testingConfig.getErrors === 'function') ? testingConfig.getErrors(stdout || stderr) : [];
-    socket.log('testing-error', errors);
-    console.log(errors.join('\n'))
-
-    Console.error("There was an error while testing");
-    bcActivity.error('exercise_error', {
-      message: errors,
-      name: `${config.tester}-error`,
-      framework: config.tester,
-      language: config.language,
-      data: slug,
-      compiler: config.compiler
-    });
-  }
-  else {
-    socket.log('testing-success', [stdout || stderr].concat(["😁Everything is amazing!"]));
-    Console.success("Everything is amazing!");
-
-    bcActivity.activity('exercise_success', {
-      language: config.language,
-      slug: slug,
-      editor: config.editor,
-      compiler: config.compiler
-    });
-    config.exercises = config.exercises.map(e => {
-      if (e.slug === slug) e.done = true;
-      return e;
-    });
-  }
-
-  if (typeof testingConfig.cleanup !== "undefined") {
-    if (typeof testingConfig.cleanup === 'function' || typeof testingConfig.cleanup === 'object') {
-      const clean = await testingConfig.cleanup(socket);
-      if (clean) {
-        const { stdout, stderr, code } = shell.exec(clean);
-        if (code == 0) {
-          Console.debug("The cleanup command runned successfully");
-        }
-        else Console.warning("There is an error on the cleanup command for the test");
-      }
-
-    }
-  }
-
-  return true;
-};
-
-*/
+/*
+
+import * as path from 'path'
+import * as shell from 'shelljs'
+import * as fs from 'fs'
+import { TestingError } from './errors'
+import Console from '../utils/console'
+import * as color from 'colors'
+import bcActivity from './bcActivity.js'
+import { CompilerError } from '../utils/errors'
+import { ISocket } from '../models/socket'
+import { IFile } from '../models/file'
+import { IConfig } from '@oclif/config'
+
+module.exports = async function ({ socket, files, config, slug }: {socket: ISocket, files: IFile[], config: IConfig, slug: string}) {
+
+  const configPath = path.resolve(__dirname, `./config/tester/${config.tester}/${config.language}.config.js`);
+  if (!fs.existsSync(configPath)) throw CompilerError(`Uknown testing engine for compiler: '${config.language}'`);
+
+  const testingConfig = require(configPath)(files, config, slug);
+  testingConfig.validate();
+
+  if (config.ignoreTests) throw TestingError('Grading is disabled on learn.json file.');
+
+  if (!fs.existsSync(`${config.dirPath}/reports`)) {
+    fs.mkdirSync(`${config.dirPath}/reports`);
+    Console.debug(`Creating the ${config.dirPath}/reports directory`);
+  }
+
+  Console.info('Running tests...');
+
+  const command = await testingConfig.getCommand(socket)
+  const { stdout, stderr, code } = shell.exec(command);
+
+  if (code != 0) {
+    const errors = typeof (testingConfig.getErrors === 'function') ? testingConfig.getErrors(stdout || stderr) : [];
+    socket.log('testing-error', errors);
+    console.log(errors.join('\n'))
+
+    Console.error("There was an error while testing");
+    bcActivity.error('exercise_error', {
+      message: errors,
+      name: `${config.tester}-error`,
+      framework: config.tester,
+      language: config.language,
+      data: slug,
+      compiler: config.compiler
+    });
+  }
+  else {
+    socket.log('testing-success', [stdout || stderr].concat(["😁Everything is amazing!"]));
+    Console.success("Everything is amazing!");
+
+    bcActivity.activity('exercise_success', {
+      language: config.language,
+      slug: slug,
+      editor: config.editor,
+      compiler: config.compiler
+    });
+    config.exercises = config.exercises.map(e => {
+      if (e.slug === slug) e.done = true;
+      return e;
+    });
+  }
+
+  if (typeof testingConfig.cleanup !== "undefined") {
+    if (typeof testingConfig.cleanup === 'function' || typeof testingConfig.cleanup === 'object') {
+      const clean = await testingConfig.cleanup(socket);
+      if (clean) {
+        const { stdout, stderr, code } = shell.exec(clean);
+        if (code == 0) {
+          Console.debug("The cleanup command runned successfully");
+        }
+        else Console.warning("There is an error on the cleanup command for the test");
+      }
+
+    }
+  }
+
+  return true;
+};
+
+*/

package/src/models/audit.ts

@@ -1,16 +1,16 @@
-export interface IAuditErrors {
-  exercise?: string;
-  msg: string;
-}
-
-type TType = "string" | "array" | "number" | "url" | "boolean";
-
-export interface ISchemaItem {
-  key: string;
-  mandatory: boolean;
-  type: TType;
-  max_size?: number;
-  allowed_extensions?: string[];
-  enum?: string[];
-  max_item_size?: number;
-}
+export interface IAuditErrors {
+  exercise?: string;
+  msg: string;
+}
+
+type TType = "string" | "array" | "number" | "url" | "boolean";
+
+export interface ISchemaItem {
+  key: string;
+  mandatory: boolean;
+  type: TType;
+  max_size?: number;
+  allowed_extensions?: string[];
+  enum?: string[];
+  max_item_size?: number;
+}

package/src/models/config-manager.ts

@@ -1,23 +1,23 @@
-import { IConfigObj, TGrading } from "./config"
-import { IExercise } from "./exercise-obj"
-
-export interface IConfigManagerAttributes {
-  grading: TGrading;
-  disableGrading: boolean;
-  version: string;
-  mode?: string;
-}
-
-export interface IConfigManager {
-  validLanguages?: any;
-  get: () => IConfigObj;
-  clean: () => void;
-  getExercise: (slug: string | undefined) => IExercise;
-  startExercise: (slug: string) => IExercise;
-  reset: (slug: string) => void;
-  buildIndex: () => boolean | void;
-  watchIndex: (onChange: (...args: Array<any>) => void) => void;
-  save: () => void;
-  noCurrentExercise: () => void;
-  getAllExercises: () => IExercise[];
-}
+import { IConfigObj, TGrading } from "./config"
+import { IExercise } from "./exercise-obj"
+
+export interface IConfigManagerAttributes {
+  grading: TGrading;
+  disableGrading: boolean;
+  version: string;
+  mode?: string;
+}
+
+export interface IConfigManager {
+  validLanguages?: any;
+  get: () => IConfigObj;
+  clean: () => void;
+  getExercise: (slug: string | undefined) => IExercise;
+  startExercise: (slug: string) => IExercise;
+  reset: (slug: string) => void;
+  buildIndex: () => boolean | void;
+  watchIndex: (onChange: (...args: Array<any>) => void) => void;
+  save: () => void;
+  noCurrentExercise: () => void;
+  getAllExercises: () => IExercise[];
+}

package/src/models/counter.ts

@@ -1,11 +1,11 @@
-interface ILinks {
-  error: number;
-  total: number;
-}
-
-export interface ICounter {
-  images: ILinks;
-  links: ILinks;
-  exercises: number;
-  readmeFiles: number;
-}
+interface ILinks {
+  error: number;
+  total: number;
+}
+
+export interface ICounter {
+  images: ILinks;
+  links: ILinks;
+  exercises: number;
+  readmeFiles: number;
+}

package/src/models/errors.ts

@@ -1,22 +1,22 @@
-export interface ISolution {
-  video?: string;
-  message: string;
-  slug?: string;
-  gif: string;
-}
-
-export interface IError extends TypeError {
-  status?: number;
-  type?:
-    | "validation-error"
-    | "not-found-error"
-    | "compiler-error"
-    | "testing-error"
-    | "auth-error"
-    | "internal-error";
-  slug?: string;
-  video?: string;
-  message: string;
-  gif?: string;
-  stdout?: string;
-}
+export interface ISolution {
+  video?: string;
+  message: string;
+  slug?: string;
+  gif: string;
+}
+
+export interface IError extends TypeError {
+  status?: number;
+  type?:
+    | "validation-error"
+    | "not-found-error"
+    | "compiler-error"
+    | "testing-error"
+    | "auth-error"
+    | "internal-error";
+  slug?: string;
+  video?: string;
+  message: string;
+  gif?: string;
+  stdout?: string;
+}

package/src/models/exercise-obj.ts

@@ -1,29 +1,29 @@
-import { IFile } from "./file"
-import { IConfig } from "./config"
-import { ISocket } from "./socket"
-
-export interface IExercise {
-  position?: number;
-  files: Array<IFile>;
-  slug: string;
-  path: string;
-  done: boolean;
-  language?: string | null;
-  entry?: string | null;
-  graded?: boolean;
-  translations?: { [key: string]: string };
-  title: string;
-  getReadme?: (lang: string | null) => any;
-  getFile?: (name: string) => string | Buffer;
-  saveFile?: (name: string, content: string) => void;
-  getTestReport?: () => any;
-  test?: (sessionConfig: any, config: IConfig, socket: ISocket) => void;
-}
-
-export interface IExerciseData {
-  lastMessages?: any;
-  userMessage?: string;
-  exerciseSlug: string;
-  entryPoint?: string;
-  files: string[];
-}
+import { IFile } from "./file"
+import { IConfig } from "./config"
+import { ISocket } from "./socket"
+
+export interface IExercise {
+  position?: number;
+  files: Array<IFile>;
+  slug: string;
+  path: string;
+  done: boolean;
+  language?: string | null;
+  entry?: string | null;
+  graded?: boolean;
+  translations?: { [key: string]: string };
+  title: string;
+  getReadme?: (lang: string | null) => any;
+  getFile?: (name: string) => string | Buffer;
+  saveFile?: (name: string, content: string) => void;
+  getTestReport?: () => any;
+  test?: (sessionConfig: any, config: IConfig, socket: ISocket) => void;
+}
+
+export interface IExerciseData {
+  lastMessages?: any;
+  userMessage?: string;
+  exerciseSlug: string;
+  entryPoint?: string;
+  files: string[];
+}

package/src/models/file.ts

@@ -1,5 +1,5 @@
-export interface IFile {
-  path: string;
-  name: string;
-  hidden: boolean;
-}
+export interface IFile {
+  path: string;
+  name: string;
+  hidden: boolean;
+}

package/src/models/findings.ts

@@ -1,18 +1,18 @@
-interface IFindingOption {
-  content: string;
-  absUrl: string;
-  mdUrl: string;
-  relUrl: string;
-}
-
-interface ILinks {
-  [key: string]: IFindingOption;
-}
-
-export interface IFindings {
-  relativeImages?: ILinks;
-  externalImages?: ILinks;
-  markdownLinks?: ILinks;
-  url?: ILinks;
-  uploadcare?: ILinks;
-}
+interface IFindingOption {
+  content: string;
+  absUrl: string;
+  mdUrl: string;
+  relUrl: string;
+}
+
+interface ILinks {
+  [key: string]: IFindingOption;
+}
+
+export interface IFindings {
+  relativeImages?: ILinks;
+  externalImages?: ILinks;
+  markdownLinks?: ILinks;
+  url?: ILinks;
+  uploadcare?: ILinks;
+}

package/src/models/flags.ts

@@ -1,10 +1,10 @@
-export interface IStartFlags {
-  port?: string | unknown;
-  host?: string | unknown;
-  disableGrading?: boolean | unknown;
-  watch?: boolean | unknown;
-  editor?: string | unknown;
-  version?: string | unknown;
-  grading?: string | unknown;
-  debug?: boolean | unknown;
-}
+export interface IStartFlags {
+  port?: string | unknown;
+  host?: string | unknown;
+  disableGrading?: boolean | unknown;
+  watch?: boolean | unknown;
+  editor?: string | unknown;
+  version?: string | unknown;
+  grading?: string | unknown;
+  debug?: boolean | unknown;
+}

package/src/models/front-matter.ts

@@ -1,11 +1,11 @@
-interface IAttributes {
-  intro: string;
-  tutorial: string;
-}
-
-export interface IFrontmatter {
-  attributes?: IAttributes;
-  body?: string;
-  bodyBegin?: number;
-  frontmatter?: string;
-}
+interface IAttributes {
+  intro: string;
+  tutorial: string;
+}
+
+export interface IFrontmatter {
+  attributes?: IAttributes;
+  body?: string;
+  bodyBegin?: number;
+  frontmatter?: string;
+}

package/src/models/gitpod-data.ts

@@ -1,19 +1,19 @@
-import {Server} from 'socket.io'
-import {IConfigObj} from './config'
-
-export type TFile = string;
-
-export interface IGitpodData {
-  files: Array<TFile>;
-}
-
-export interface IGitpod {
-  socket: Server | null;
-  config: IConfigObj | null;
-  initialized: boolean;
-  hasGPCommand: boolean;
-  init: (config?: IConfigObj) => void;
-  openFiles: (files: Array<TFile>) => Promise<boolean | undefined>;
-  setup: (config?: IConfigObj) => void;
-  autosave: (value: string) => void;
-}
+import {Server} from 'socket.io'
+import {IConfigObj} from './config'
+
+export type TFile = string;
+
+export interface IGitpodData {
+  files: Array<TFile>;
+}
+
+export interface IGitpod {
+  socket: Server | null;
+  config: IConfigObj | null;
+  initialized: boolean;
+  hasGPCommand: boolean;
+  init: (config?: IConfigObj) => void;
+  openFiles: (files: Array<TFile>) => Promise<boolean | undefined>;
+  setup: (config?: IConfigObj) => void;
+  autosave: (value: string) => void;
+}

package/src/models/language.ts

@@ -1,4 +1,4 @@
-export interface ILanguage {
-  title: string;
-  slug: string;
-}
+export interface ILanguage {
+  title: string;
+  slug: string;
+}

package/src/models/package.ts

@@ -1,7 +1,7 @@
-export interface IPackage {
-  title: string;
-  slug: string;
-  difficulty: string;
-  downloads: string;
-  skills: Array<any>;
-}
+export interface IPackage {
+  title: string;
+  slug: string;
+  difficulty: string;
+  downloads: string;
+  skills: Array<any>;
+}

package/src/models/plugin-config.ts

@@ -1,17 +1,17 @@
-import { IConfig } from "./config"
-import { IExercise } from "./exercise-obj"
-
-export interface IPluginConfig {
-  language: string;
-  compile?: {
-    run: () => void;
-    validate: (args: IValidate) => boolean;
-    dependencies: string[];
-  };
-  test?: () => void;
-}
-
-interface IValidate {
-  exercise: IExercise;
-  configuration: IConfig;
-}
+import { IConfig } from "./config"
+import { IExercise } from "./exercise-obj"
+
+export interface IPluginConfig {
+  language: string;
+  compile?: {
+    run: () => void;
+    validate: (args: IValidate) => boolean;
+    dependencies: string[];
+  };
+  test?: () => void;
+}
+
+interface IValidate {
+  exercise: IExercise;
+  configuration: IConfig;
+}

package/src/models/success-types.ts

@@ -1 +1 @@
-export type TSuccessType = 'compiler-success' | 'testing-success';
+export type TSuccessType = 'compiler-success' | 'testing-success';

package/src/plugin/command/compile.ts

@@ -1,17 +1,17 @@
-import { IError } from "../../models/errors"
-
-const CompilationError = (messages: string) => {
-  const _err: IError = new Error(messages)
-  _err.status = 400
-  _err.stdout = messages
-  _err.type = "compiler-error"
-  return _err
-}
-
-export default {
-  CompilationError,
-  default: async ({ action, ...rest }: any) => {
-    const stdout = await action.run(rest)
-    return stdout
-  },
-}
+import { IError } from "../../models/errors"
+
+const CompilationError = (messages: string) => {
+  const _err: IError = new Error(messages)
+  _err.status = 400
+  _err.stdout = messages
+  _err.type = "compiler-error"
+  return _err
+}
+
+export default {
+  CompilationError,
+  default: async ({ action, ...rest }: any) => {
+    const stdout = await action.run(rest)
+    return stdout
+  },
+}