@learnpack/learnpack 2.1.26 → 2.1.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (154) hide show
  1. package/README.md +10 -10
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +2 -1
  4. package/src/commands/audit.ts +113 -113
  5. package/src/commands/clean.ts +10 -10
  6. package/src/commands/download.ts +18 -18
  7. package/src/commands/init.ts +39 -39
  8. package/src/commands/login.ts +13 -13
  9. package/src/commands/logout.ts +9 -9
  10. package/src/commands/publish.ts +25 -25
  11. package/src/commands/start.ts +101 -75
  12. package/src/commands/test.ts +34 -34
  13. package/src/managers/config/allowed_files.ts +2 -2
  14. package/src/managers/config/defaults.ts +2 -2
  15. package/src/managers/config/exercise.ts +79 -79
  16. package/src/managers/config/index.ts +145 -145
  17. package/src/managers/file.ts +74 -65
  18. package/src/managers/server/index.ts +32 -31
  19. package/src/managers/server/routes.ts +139 -90
  20. package/src/managers/session.ts +53 -24
  21. package/src/managers/socket.ts +92 -79
  22. package/src/models/action.ts +8 -1
  23. package/src/models/config-manager.ts +2 -2
  24. package/src/models/config.ts +7 -2
  25. package/src/models/exercise-obj.ts +6 -3
  26. package/src/models/plugin-config.ts +2 -2
  27. package/src/models/session.ts +5 -2
  28. package/src/models/socket.ts +12 -6
  29. package/src/models/status.ts +15 -14
  30. package/src/plugin/command/compile.ts +10 -10
  31. package/src/plugin/command/test.ts +14 -14
  32. package/src/plugin/index.ts +5 -5
  33. package/src/plugin/plugin.ts +26 -26
  34. package/src/plugin/utils.ts +23 -23
  35. package/src/utils/BaseCommand.ts +16 -16
  36. package/src/utils/api.ts +143 -91
  37. package/src/utils/audit.ts +93 -96
  38. package/src/utils/exercisesQueue.ts +15 -15
  39. package/src/utils/fileQueue.ts +85 -85
  40. package/src/utils/watcher.ts +14 -14
  41. package/lib/commands/audit.d.ts +0 -6
  42. package/lib/commands/audit.js +0 -342
  43. package/lib/commands/clean.d.ts +0 -8
  44. package/lib/commands/clean.js +0 -25
  45. package/lib/commands/download.d.ts +0 -13
  46. package/lib/commands/download.js +0 -55
  47. package/lib/commands/init.d.ts +0 -9
  48. package/lib/commands/init.js +0 -123
  49. package/lib/commands/login.d.ts +0 -14
  50. package/lib/commands/login.js +0 -37
  51. package/lib/commands/logout.d.ts +0 -14
  52. package/lib/commands/logout.js +0 -37
  53. package/lib/commands/publish.d.ts +0 -14
  54. package/lib/commands/publish.js +0 -82
  55. package/lib/commands/start.d.ts +0 -7
  56. package/lib/commands/start.js +0 -165
  57. package/lib/commands/test.d.ts +0 -6
  58. package/lib/commands/test.js +0 -62
  59. package/lib/index.d.ts +0 -1
  60. package/lib/index.js +0 -4
  61. package/lib/managers/config/allowed_files.d.ts +0 -5
  62. package/lib/managers/config/allowed_files.js +0 -30
  63. package/lib/managers/config/defaults.d.ts +0 -39
  64. package/lib/managers/config/defaults.js +0 -40
  65. package/lib/managers/config/exercise.d.ts +0 -36
  66. package/lib/managers/config/exercise.js +0 -233
  67. package/lib/managers/config/index.d.ts +0 -3
  68. package/lib/managers/config/index.js +0 -320
  69. package/lib/managers/file.d.ts +0 -13
  70. package/lib/managers/file.js +0 -134
  71. package/lib/managers/gitpod.d.ts +0 -3
  72. package/lib/managers/gitpod.js +0 -67
  73. package/lib/managers/server/index.d.ts +0 -6
  74. package/lib/managers/server/index.js +0 -58
  75. package/lib/managers/server/routes.d.ts +0 -4
  76. package/lib/managers/server/routes.js +0 -167
  77. package/lib/managers/session.d.ts +0 -3
  78. package/lib/managers/session.js +0 -104
  79. package/lib/managers/socket.d.ts +0 -3
  80. package/lib/managers/socket.js +0 -164
  81. package/lib/managers/test.d.ts +0 -0
  82. package/lib/managers/test.js +0 -84
  83. package/lib/models/action.d.ts +0 -2
  84. package/lib/models/action.js +0 -2
  85. package/lib/models/audit.d.ts +0 -15
  86. package/lib/models/audit.js +0 -2
  87. package/lib/models/config-manager.d.ts +0 -21
  88. package/lib/models/config-manager.js +0 -2
  89. package/lib/models/config.d.ts +0 -62
  90. package/lib/models/config.js +0 -2
  91. package/lib/models/counter.d.ts +0 -11
  92. package/lib/models/counter.js +0 -2
  93. package/lib/models/errors.d.ts +0 -15
  94. package/lib/models/errors.js +0 -2
  95. package/lib/models/exercise-obj.d.ts +0 -27
  96. package/lib/models/exercise-obj.js +0 -2
  97. package/lib/models/file.d.ts +0 -5
  98. package/lib/models/file.js +0 -2
  99. package/lib/models/findings.d.ts +0 -17
  100. package/lib/models/findings.js +0 -2
  101. package/lib/models/flags.d.ts +0 -10
  102. package/lib/models/flags.js +0 -2
  103. package/lib/models/front-matter.d.ts +0 -11
  104. package/lib/models/front-matter.js +0 -2
  105. package/lib/models/gitpod-data.d.ts +0 -16
  106. package/lib/models/gitpod-data.js +0 -2
  107. package/lib/models/language.d.ts +0 -4
  108. package/lib/models/language.js +0 -2
  109. package/lib/models/package.d.ts +0 -7
  110. package/lib/models/package.js +0 -2
  111. package/lib/models/plugin-config.d.ts +0 -16
  112. package/lib/models/plugin-config.js +0 -2
  113. package/lib/models/session.d.ts +0 -23
  114. package/lib/models/session.js +0 -2
  115. package/lib/models/socket.d.ts +0 -31
  116. package/lib/models/socket.js +0 -2
  117. package/lib/models/status.d.ts +0 -1
  118. package/lib/models/status.js +0 -2
  119. package/lib/models/success-types.d.ts +0 -1
  120. package/lib/models/success-types.js +0 -2
  121. package/lib/plugin/command/compile.d.ts +0 -6
  122. package/lib/plugin/command/compile.js +0 -18
  123. package/lib/plugin/command/test.d.ts +0 -6
  124. package/lib/plugin/command/test.js +0 -25
  125. package/lib/plugin/index.d.ts +0 -27
  126. package/lib/plugin/index.js +0 -7
  127. package/lib/plugin/plugin.d.ts +0 -8
  128. package/lib/plugin/plugin.js +0 -68
  129. package/lib/plugin/utils.d.ts +0 -16
  130. package/lib/plugin/utils.js +0 -58
  131. package/lib/ui/download.d.ts +0 -5
  132. package/lib/ui/download.js +0 -61
  133. package/lib/utils/BaseCommand.d.ts +0 -8
  134. package/lib/utils/BaseCommand.js +0 -41
  135. package/lib/utils/SessionCommand.d.ts +0 -10
  136. package/lib/utils/SessionCommand.js +0 -47
  137. package/lib/utils/api.d.ts +0 -12
  138. package/lib/utils/api.js +0 -173
  139. package/lib/utils/audit.d.ts +0 -16
  140. package/lib/utils/audit.js +0 -302
  141. package/lib/utils/console.d.ts +0 -12
  142. package/lib/utils/console.js +0 -19
  143. package/lib/utils/errors.d.ts +0 -17
  144. package/lib/utils/errors.js +0 -100
  145. package/lib/utils/exercisesQueue.d.ts +0 -9
  146. package/lib/utils/exercisesQueue.js +0 -38
  147. package/lib/utils/fileQueue.d.ts +0 -40
  148. package/lib/utils/fileQueue.js +0 -168
  149. package/lib/utils/misc.d.ts +0 -1
  150. package/lib/utils/misc.js +0 -23
  151. package/lib/utils/validators.d.ts +0 -5
  152. package/lib/utils/validators.js +0 -17
  153. package/lib/utils/watcher.d.ts +0 -2
  154. package/lib/utils/watcher.js +0 -23
@@ -1,100 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.InternalError = exports.AuthError = exports.TestingError = exports.CompilerError = exports.NotFoundError = exports.ValidationError = exports.getSolution = void 0;
4
- const console_1 = require("./console");
5
- // eslint-disable-next-line
6
- const fetch = require("node-fetch");
7
- let solutions = null;
8
- const uknown = {
9
- video: 'https://www.youtube.com/watch?v=gD1Sa99GiE4',
10
- message: 'Uknown internal error',
11
- slug: 'uknown',
12
- gif: 'https://github.com/breatheco-de/breathecode-cli/blob/master/docs/errors/uknown.gif?raw=true',
13
- };
14
- exports.getSolution = (slug) => {
15
- if (!slug) {
16
- console_1.default.debug('Getting solution templates from the learnpack repository');
17
- }
18
- else {
19
- console_1.default.debug(`Getting solution for ${slug}`, solutions);
20
- }
21
- if (!solutions) {
22
- console_1.default.debug('Fetching for errors.json on github');
23
- fetch('https://raw.githubusercontent.com/breatheco-de/breathecode-cli/master/docs/errors/errors.json')
24
- .then((r) => r.json())
25
- .then(function (_s) {
26
- solutions = _s;
27
- });
28
- return uknown;
29
- }
30
- return typeof solutions[slug || ''] === 'undefined' || !slug ?
31
- uknown :
32
- solutions[slug];
33
- };
34
- exports.ValidationError = (error) => {
35
- const message = error.message || error;
36
- const _err = new Error(message);
37
- _err.status = 400;
38
- _err.type = 'validation-error';
39
- const sol = exports.getSolution(error.slug);
40
- _err.video = sol.video;
41
- _err.gif = sol.gif;
42
- _err.message = typeof message === 'string' ? message : sol.message;
43
- return _err;
44
- };
45
- exports.NotFoundError = (error) => {
46
- const message = error.message || error;
47
- const _err = new Error(message);
48
- _err.status = 400;
49
- _err.type = 'not-found-error';
50
- const sol = exports.getSolution(error.slug);
51
- _err.video = sol.video;
52
- _err.gif = sol.gif;
53
- _err.message = typeof message === 'string' ? message : sol.message;
54
- return _err;
55
- };
56
- exports.CompilerError = (error) => {
57
- const message = error.message || error;
58
- const _err = new Error(message);
59
- _err.status = 400;
60
- _err.type = 'compiler-error';
61
- const sol = exports.getSolution(error.slug);
62
- _err.video = sol.video;
63
- _err.gif = sol.gif;
64
- _err.message = typeof message === 'string' ? message : sol.message;
65
- return _err;
66
- };
67
- exports.TestingError = (error) => {
68
- const message = error.message || error;
69
- const _err = new Error(message);
70
- _err.status = 400;
71
- _err.type = 'testing-error';
72
- return _err;
73
- };
74
- exports.AuthError = (error) => {
75
- const message = error.message || error;
76
- const _err = new Error(message);
77
- _err.status = 403;
78
- _err.type = 'auth-error';
79
- return _err;
80
- };
81
- exports.InternalError = (error) => {
82
- const message = error.message || error;
83
- const _err = new Error(message);
84
- _err.status = 500;
85
- _err.type = 'internal-error';
86
- const sol = exports.getSolution(error.slug);
87
- _err.video = sol.video;
88
- _err.gif = sol.gif;
89
- _err.message = typeof message === 'string' ? message : sol.message;
90
- return _err;
91
- };
92
- exports.getSolution();
93
- exports.default = {
94
- ValidationError: exports.ValidationError,
95
- CompilerError: exports.CompilerError,
96
- TestingError: exports.TestingError,
97
- NotFoundError: exports.NotFoundError,
98
- InternalError: exports.InternalError,
99
- AuthError: exports.AuthError,
100
- };
@@ -1,9 +0,0 @@
1
- import { IExercise } from "../models/exercise-obj";
2
- declare class ExercisesQueue {
3
- exercises: IExercise[];
4
- constructor(exercises: any);
5
- pop(): IExercise | undefined;
6
- isEmpty(): boolean;
7
- size(): number;
8
- }
9
- export default ExercisesQueue;
@@ -1,38 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- class Exercise {
4
- constructor(exercise) {
5
- this.exercise = exercise;
6
- }
7
- test(sessionConfig, config, socket) {
8
- if (this.exercise.language) {
9
- socket.log("testing", `Testing exercise ${this.exercise.slug} using ${this.exercise.language} engine`);
10
- sessionConfig.runHook("action", {
11
- action: "test",
12
- socket,
13
- configuration: config,
14
- exercise: this.exercise,
15
- });
16
- }
17
- else {
18
- socket.onTestingFinished({ result: "success" });
19
- }
20
- }
21
- }
22
- class ExercisesQueue {
23
- constructor(exercises) {
24
- this.exercises = exercises.map((exercise) => {
25
- return new Exercise(exercise);
26
- });
27
- }
28
- pop() {
29
- return this.exercises.shift();
30
- }
31
- isEmpty() {
32
- return this.size() === 0;
33
- }
34
- size() {
35
- return this.exercises.length;
36
- }
37
- }
38
- exports.default = ExercisesQueue;
@@ -1,40 +0,0 @@
1
- declare const _default: {
2
- events: {
3
- START_EXERCISE: string;
4
- INIT: string;
5
- RUNNING: string;
6
- END: string;
7
- RESET_EXERCISE: string;
8
- OPEN_FILES: string;
9
- OPEN_WINDOW: string;
10
- INSTRUCTIONS_CLOSED: string;
11
- };
12
- dispatcher: (opts?: any) => {
13
- enqueue: (name: string, data?: any) => void;
14
- events: {
15
- START_EXERCISE: string;
16
- INIT: string;
17
- RUNNING: string;
18
- END: string;
19
- RESET_EXERCISE: string;
20
- OPEN_FILES: string;
21
- OPEN_WINDOW: string;
22
- INSTRUCTIONS_CLOSED: string;
23
- };
24
- };
25
- listener: (opts?: any) => {
26
- onPull: (callback: (T?: any) => any) => boolean;
27
- onReset: (callback: (T?: any) => any) => boolean;
28
- events: {
29
- START_EXERCISE: string;
30
- INIT: string;
31
- RUNNING: string;
32
- END: string;
33
- RESET_EXERCISE: string;
34
- OPEN_FILES: string;
35
- OPEN_WINDOW: string;
36
- INSTRUCTIONS_CLOSED: string;
37
- };
38
- };
39
- };
40
- export default _default;
@@ -1,168 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const console_1 = require("../utils/console");
4
- const fs = require("fs");
5
- // import em from "events"
6
- const XXH = require("xxhashjs");
7
- // possible events to dispatch
8
- const events = {
9
- START_EXERCISE: "start_exercise",
10
- INIT: "initializing",
11
- RUNNING: "configuration_loaded",
12
- END: "connection_ended",
13
- RESET_EXERCISE: "reset_exercise",
14
- OPEN_FILES: "open_files",
15
- OPEN_WINDOW: "open_window",
16
- INSTRUCTIONS_CLOSED: "instructions_closed",
17
- };
18
- let options = {
19
- path: null,
20
- create: false,
21
- };
22
- let lastHash = null;
23
- let watcher = null; // subscribe to file and listen to changes
24
- let actions = null; // action queue
25
- const loadDispatcher = (opts) => {
26
- actions = [{ name: "initializing", time: now() }];
27
- console_1.default.debug(`Loading from ${opts.path}`);
28
- let exists = fs.existsSync(opts.path);
29
- if (opts.create) {
30
- if (exists)
31
- actions.push({ name: "reset", time: now() });
32
- fs.writeFileSync(opts.path, JSON.stringify(actions), { flag: "w" });
33
- exists = true;
34
- }
35
- if (!exists)
36
- throw new Error(`Invalid queue path, missing file at: ${opts.path}`);
37
- let incomingActions = [];
38
- try {
39
- const content = fs.readFileSync(opts.path, "utf-8");
40
- incomingActions = JSON.parse(content);
41
- if (!Array.isArray(incomingActions))
42
- incomingActions = [];
43
- }
44
- catch (_a) {
45
- incomingActions = [];
46
- console_1.default.debug("Error loading VSCode Actions file");
47
- }
48
- console_1.default.debug("Actions load ", incomingActions);
49
- return incomingActions;
50
- };
51
- // eslint-disable-next-line
52
- const enqueue = (name, data = undefined) => {
53
- if (!Object.values(events).includes(name)) {
54
- console_1.default.debug(`Invalid event ${name}`);
55
- throw new Error(`Invalid action ${name}`);
56
- }
57
- if (!actions)
58
- actions = [];
59
- actions.push({ name, time: now(), data: data });
60
- console_1.default.debug(`EMIT -> ${name}:Exporting changes to ${options.path}`);
61
- return fs.writeFileSync(options.path || "", JSON.stringify(actions));
62
- };
63
- const now = () => {
64
- const hrTime = process.hrtime();
65
- // eslint-disable-next-line
66
- const htTime0 = hrTime[0] * 1000000;
67
- return (htTime0 + hrTime[1]) / 1000;
68
- };
69
- const loadFile = (filePath) => {
70
- if (!fs.existsSync(filePath))
71
- throw new Error(`No queue.json file to load on ${filePath}`);
72
- const content = fs.readFileSync(filePath, "utf8");
73
- const newHash = XXH.h32(content, 43981).toString(16);
74
- const isUpdated = lastHash !== newHash;
75
- lastHash = newHash;
76
- const incomingActions = JSON.parse(content);
77
- return { isUpdated, incomingActions };
78
- };
79
- const dequeue = () => {
80
- // first time dequeue loads
81
- if (!actions)
82
- actions = [];
83
- const { isUpdated, incomingActions } = loadFile(options.path || "");
84
- if (!isUpdated) {
85
- /**
86
- * make sure no tasks are executed from the queue by matching both
87
- * queues (the incoming with current one)
88
- */
89
- actions = incomingActions;
90
- console_1.default.debug(`No new actions to process: ${actions.length}/${incomingActions.length}`);
91
- return null;
92
- }
93
- // do i need to reset actions to zero?
94
- if (actions.length > 0 && actions[0].time !== incomingActions[0].time) {
95
- actions = [];
96
- }
97
- const action = incomingActions[incomingActions.length - 1];
98
- console_1.default.debug("Dequeing action ", action);
99
- actions.push(action);
100
- return action;
101
- };
102
- const pull = (callback) => {
103
- console_1.default.debug("Pulling actions");
104
- let incoming = dequeue();
105
- while (incoming) {
106
- callback(incoming);
107
- incoming = dequeue();
108
- }
109
- };
110
- const reset = (callback) => {
111
- console_1.default.debug("Queue reseted");
112
- actions = [];
113
- if (fs.existsSync(options.path || "")) {
114
- fs.writeFileSync(options.path || "", "[]");
115
- callback();
116
- }
117
- };
118
- const onPull = (callback) => {
119
- // eslint-disable-next-line
120
- const chokidar = require("chokidar");
121
- console_1.default.debug("Starting to listen...");
122
- try {
123
- loadFile(options.path || "");
124
- }
125
- catch (_a) {
126
- console_1.default.debug("No previoues queue file, waiting for it to be created...");
127
- }
128
- if (!watcher) {
129
- console_1.default.debug(`Watching ${options.path}`);
130
- watcher = chokidar.watch(`${options.path}`, {
131
- persistent: true,
132
- });
133
- }
134
- else
135
- console_1.default.debug("Already watching queue path");
136
- watcher.on("add", () => pull(callback)).on("change", () => pull(callback));
137
- return true;
138
- };
139
- const onReset = (callback) => {
140
- // eslint-disable-next-line
141
- const chokidar = require("chokidar");
142
- if (!watcher) {
143
- console_1.default.debug(`Watching ${options.path}`);
144
- watcher = chokidar.watch(`${options.path}`, {
145
- persistent: true,
146
- });
147
- }
148
- watcher.on("unlink", () => reset(callback));
149
- return true;
150
- };
151
- exports.default = {
152
- events,
153
- dispatcher: (opts = {}) => {
154
- if (!actions) {
155
- options = Object.assign(Object.assign({}, options), opts);
156
- console_1.default.debug("Initializing queue dispatcher", options);
157
- actions = loadDispatcher(options);
158
- }
159
- return { enqueue, events };
160
- },
161
- listener: (opts = {}) => {
162
- if (!actions) {
163
- options = Object.assign(Object.assign({}, options), opts);
164
- console_1.default.debug("Initializing queue listener", options);
165
- }
166
- return { onPull, onReset, events };
167
- },
168
- };
@@ -1 +0,0 @@
1
- export declare const prioritizeHTMLFile: (entryFiles: string[]) => string[];
package/lib/utils/misc.js DELETED
@@ -1,23 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.prioritizeHTMLFile = void 0;
4
- exports.prioritizeHTMLFile = (entryFiles) => {
5
- let files = [];
6
- // Find the html file and put it as latest in the files array
7
- // in order to keep the html file opened in vscode plugin
8
- const index = entryFiles.findIndex(file => {
9
- return /.*\.html$/.test(file);
10
- });
11
- if (index !== -1) {
12
- for (const [i, entryFile] of entryFiles.entries()) {
13
- if (i !== index) {
14
- files.push(entryFile);
15
- }
16
- }
17
- files.push(entryFiles[index]);
18
- }
19
- else {
20
- files = entryFiles;
21
- }
22
- return files;
23
- };
@@ -1,5 +0,0 @@
1
- export declare function validURL(str: string): boolean;
2
- declare const _default: {
3
- validURL: typeof validURL;
4
- };
5
- export default _default;
@@ -1,17 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.validURL = void 0;
4
- function validURL(str) {
5
- if (!str.includes('github.com')) {
6
- return false;
7
- }
8
- const pattern = new RegExp('^(https?:\\/\\/)?' + // protocol
9
- '((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|' + // domain name
10
- '((\\d{1,3}\\.){3}\\d{1,3}))' + // OR ip (v4) address
11
- '(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*' + // port and path
12
- '(\\?[;&a-z\\d%_.~+=-]*)?' + // query string
13
- '(\\#[-a-z\\d_]*)?$', 'i'); // fragment locator
14
- return !!pattern.test(str);
15
- }
16
- exports.validURL = validURL;
17
- exports.default = { validURL };
@@ -1,2 +0,0 @@
1
- declare const _default: (path: string, reloadSocket: () => void) => Promise<unknown>;
2
- export default _default;
@@ -1,23 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const chokidar = require("chokidar");
4
- const console_1 = require("./console");
5
- const debounce = require("debounce");
6
- exports.default = (path, reloadSocket) => new Promise((resolve /* , reject */) => {
7
- console_1.default.debug("PATH:", path);
8
- const watcher = chokidar.watch(path, {
9
- // TODO: This watcher is not ready yet
10
- ignored: /^(?=.*(\.\w+)$)(?!.*\.md$).*$/gm,
11
- ignoreInitial: true,
12
- });
13
- const onChange = (eventname, _filename) => {
14
- resolve(eventname /* , filename */);
15
- reloadSocket();
16
- };
17
- watcher.on("all", debounce(onChange, 500, true));
18
- // watcher.on('all', onChange)
19
- process.on("SIGINT", function () {
20
- watcher.close();
21
- process.exit();
22
- });
23
- });