@learnpack/learnpack 5.0.334 → 5.0.339

package/src/utils/errors.ts

@@ -1,108 +1,108 @@
-import Console from "./console"
-
-import { ISolution, IError } from "../models/errors"
-
-const solutions: { [key: string]: ISolution } = {
-  "install-jest": {
-    gif: "",
-    video: "",
-    message: "You need to install jest",
-  },
-}
-
-const uknown: ISolution = {
-  video: "https://www.youtube.com/watch?v=gD1Sa99GiE4",
-  message: "Uknown internal error",
-  slug: "uknown",
-  gif: "https://github.com/breatheco-de/breathecode-cli/blob/master/docs/errors/uknown.gif?raw=true",
-}
-
-export const getSolution = (slug?: string): ISolution => {
-  if (!slug) {
-    Console.debug("Getting solution templates from the learnpack repository")
-  } else {
-    Console.debug(`Getting solution for ${slug}`, solutions)
-  }
-
-  return typeof solutions[slug || ""] === "undefined" || !slug ?
-    uknown :
-    solutions[slug]
-}
-
-export const ValidationError = (error: IError | string) => {
-  const message: string = (error as IError).message || (error as string)
-  const _err = new Error(message) as IError
-  _err.status = 400
-  _err.type = "validation-error"
-
-  const sol: ISolution = getSolution((error as IError).slug)
-  _err.video = sol.video
-  _err.gif = sol.gif
-  _err.message = typeof message === "string" ? message : sol.message
-  return _err
-}
-
-export const NotFoundError = (error: IError | string) => {
-  const message = (error as IError).message || (error as string)
-  const _err = new Error(message) as IError
-  _err.status = 400
-  _err.type = "not-found-error"
-
-  const sol = getSolution((error as IError).slug)
-  _err.video = sol.video
-  _err.gif = sol.gif
-  _err.message = typeof message === "string" ? message : sol.message
-  return _err
-}
-
-export const CompilerError = (error: IError | string) => {
-  const message = (error as IError).message || (error as string)
-  const _err = new Error(message) as IError
-  _err.status = 400
-  _err.type = "compiler-error"
-
-  const sol = getSolution((error as IError).slug)
-  _err.video = sol.video
-  _err.gif = sol.gif
-  _err.message = typeof message === "string" ? message : sol.message
-  return _err
-}
-
-export const TestingError = (error: IError | string) => {
-  const message = (error as IError).message || (error as string)
-  const _err = new Error(message) as IError
-  _err.status = 400
-  _err.type = "testing-error"
-  return _err
-}
-
-export const AuthError = (error: IError | string) => {
-  const message = (error as IError).message || (error as string)
-  const _err = new Error(message) as IError
-  _err.status = 403
-  _err.type = "auth-error"
-  return _err
-}
-
-export const InternalError = (error: IError | string) => {
-  const message = (error as IError).message || (error as string)
-  const _err = new Error(message) as IError
-  _err.status = 500
-  _err.type = "internal-error"
-
-  const sol = getSolution((error as IError).slug)
-  _err.video = sol.video
-  _err.gif = sol.gif
-  _err.message = typeof message === "string" ? message : sol.message
-  return _err
-}
-
-getSolution()
-export default {
-  ValidationError,
-  CompilerError,
-  TestingError,
-  NotFoundError,
-  InternalError,
-  AuthError,
-}
+import Console from "./console"
+
+import { ISolution, IError } from "../models/errors"
+
+const solutions: { [key: string]: ISolution } = {
+  "install-jest": {
+    gif: "",
+    video: "",
+    message: "You need to install jest",
+  },
+}
+
+const uknown: ISolution = {
+  video: "https://www.youtube.com/watch?v=gD1Sa99GiE4",
+  message: "Uknown internal error",
+  slug: "uknown",
+  gif: "https://github.com/breatheco-de/breathecode-cli/blob/master/docs/errors/uknown.gif?raw=true",
+}
+
+export const getSolution = (slug?: string): ISolution => {
+  if (!slug) {
+    Console.debug("Getting solution templates from the learnpack repository")
+  } else {
+    Console.debug(`Getting solution for ${slug}`, solutions)
+  }
+
+  return typeof solutions[slug || ""] === "undefined" || !slug ?
+    uknown :
+    solutions[slug]
+}
+
+export const ValidationError = (error: IError | string) => {
+  const message: string = (error as IError).message || (error as string)
+  const _err = new Error(message) as IError
+  _err.status = 400
+  _err.type = "validation-error"
+
+  const sol: ISolution = getSolution((error as IError).slug)
+  _err.video = sol.video
+  _err.gif = sol.gif
+  _err.message = typeof message === "string" ? message : sol.message
+  return _err
+}
+
+export const NotFoundError = (error: IError | string) => {
+  const message = (error as IError).message || (error as string)
+  const _err = new Error(message) as IError
+  _err.status = 400
+  _err.type = "not-found-error"
+
+  const sol = getSolution((error as IError).slug)
+  _err.video = sol.video
+  _err.gif = sol.gif
+  _err.message = typeof message === "string" ? message : sol.message
+  return _err
+}
+
+export const CompilerError = (error: IError | string) => {
+  const message = (error as IError).message || (error as string)
+  const _err = new Error(message) as IError
+  _err.status = 400
+  _err.type = "compiler-error"
+
+  const sol = getSolution((error as IError).slug)
+  _err.video = sol.video
+  _err.gif = sol.gif
+  _err.message = typeof message === "string" ? message : sol.message
+  return _err
+}
+
+export const TestingError = (error: IError | string) => {
+  const message = (error as IError).message || (error as string)
+  const _err = new Error(message) as IError
+  _err.status = 400
+  _err.type = "testing-error"
+  return _err
+}
+
+export const AuthError = (error: IError | string) => {
+  const message = (error as IError).message || (error as string)
+  const _err = new Error(message) as IError
+  _err.status = 403
+  _err.type = "auth-error"
+  return _err
+}
+
+export const InternalError = (error: IError | string) => {
+  const message = (error as IError).message || (error as string)
+  const _err = new Error(message) as IError
+  _err.status = 500
+  _err.type = "internal-error"
+
+  const sol = getSolution((error as IError).slug)
+  _err.video = sol.video
+  _err.gif = sol.gif
+  _err.message = typeof message === "string" ? message : sol.message
+  return _err
+}
+
+getSolution()
+export default {
+  ValidationError,
+  CompilerError,
+  TestingError,
+  NotFoundError,
+  InternalError,
+  AuthError,
+}

package/src/utils/exerciseFileOrder.ts

@@ -0,0 +1,50 @@
+/**
+ * Shared ordering logic for exercise file lists (e.g. editor tabs).
+ * Ensures solution files (*.solution.hide.*) always appear after their base file.
+ */
+
+const SOLUTION_HIDE = ".solution.hide"
+
+const isSolutionFile = (name: string): boolean => name.includes(SOLUTION_HIDE)
+
+const getBaseFileName = (name: string): string =>
+  name.replace(SOLUTION_HIDE, "")
+
+const FILE_PRIORITY: { [key: string]: number } = {
+  "index.html": 1,
+  "styles.css": 2,
+  "styles.scss": 2,
+  "style.css": 2,
+  "style.scss": 2,
+  "index.css": 2,
+  "index.scss": 2,
+  "index.js": 3,
+}
+
+const DEFAULT_PRIORITY = Infinity
+
+/**
+ * Comparator for two file names. Use with Array.prototype.sort.
+ * Solution files are ordered after their base file; then by priority; then alphabetically.
+ * @param nameA - First file name.
+ * @param nameB - Second file name.
+ * @returns Negative if nameA < nameB, 0 if equal, positive if nameA > nameB.
+ */
+export function compareExerciseFileNames(nameA: string, nameB: string): number {
+  if (isSolutionFile(nameA) && getBaseFileName(nameA) === nameB) return 1
+  if (isSolutionFile(nameB) && getBaseFileName(nameB) === nameA) return -1
+
+  const s1 = FILE_PRIORITY[nameA] ?? DEFAULT_PRIORITY
+  const s2 = FILE_PRIORITY[nameB] ?? DEFAULT_PRIORITY
+  if (s1 !== s2) return s1 - s2
+  return nameA.localeCompare(nameB)
+}
+
+/**
+ * Sorts an array of file-like objects by name using exercise file ordering rules.
+ * @param files - Array of objects with a `name` property.
+ * @returns A new sorted array (original is not mutated).
+ */
+export function sortExerciseFiles<T extends { name: string }>(files: T[]): T[] {
+  return [...files].sort((a, b) => compareExerciseFileNames(a.name, b.name))
+}