@learnpack/learnpack 2.1.39 → 2.1.40

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 (196) hide show
  1. package/README.md +370 -35
  2. package/bin/run +17 -17
  3. package/bin/run.cmd +3 -3
  4. package/lib/commands/audit.d.ts +6 -6
  5. package/lib/commands/audit.js +342 -342
  6. package/lib/commands/clean.d.ts +8 -8
  7. package/lib/commands/clean.js +25 -25
  8. package/lib/commands/download.d.ts +13 -13
  9. package/lib/commands/download.js +55 -55
  10. package/lib/commands/init.d.ts +9 -9
  11. package/lib/commands/init.js +123 -123
  12. package/lib/commands/login.d.ts +14 -14
  13. package/lib/commands/login.js +37 -37
  14. package/lib/commands/logout.d.ts +14 -14
  15. package/lib/commands/logout.js +37 -37
  16. package/lib/commands/publish.d.ts +14 -14
  17. package/lib/commands/publish.js +82 -82
  18. package/lib/commands/start.d.ts +7 -7
  19. package/lib/commands/start.js +239 -208
  20. package/lib/commands/test.d.ts +6 -6
  21. package/lib/commands/test.js +62 -62
  22. package/lib/index.d.ts +1 -1
  23. package/lib/index.js +4 -4
  24. package/lib/managers/config/allowed_files.d.ts +5 -5
  25. package/lib/managers/config/allowed_files.js +30 -30
  26. package/lib/managers/config/defaults.d.ts +41 -41
  27. package/lib/managers/config/defaults.js +44 -44
  28. package/lib/managers/config/exercise.d.ts +36 -36
  29. package/lib/managers/config/exercise.js +236 -236
  30. package/lib/managers/config/index.d.ts +3 -3
  31. package/lib/managers/config/index.js +337 -337
  32. package/lib/managers/file.d.ts +14 -14
  33. package/lib/managers/file.js +153 -153
  34. package/lib/managers/gitpod.d.ts +3 -3
  35. package/lib/managers/gitpod.js +67 -67
  36. package/lib/managers/server/index.d.ts +6 -6
  37. package/lib/managers/server/index.js +58 -58
  38. package/lib/managers/server/routes.d.ts +4 -4
  39. package/lib/managers/server/routes.js +219 -219
  40. package/lib/managers/session.d.ts +3 -3
  41. package/lib/managers/session.js +125 -125
  42. package/lib/managers/socket.d.ts +3 -3
  43. package/lib/managers/socket.js +176 -176
  44. package/lib/managers/telemetry.d.ts +74 -74
  45. package/lib/managers/telemetry.js +206 -206
  46. package/lib/managers/test.js +84 -84
  47. package/lib/models/action.d.ts +2 -2
  48. package/lib/models/action.js +2 -2
  49. package/lib/models/audit.d.ts +15 -15
  50. package/lib/models/audit.js +2 -2
  51. package/lib/models/config-manager.d.ts +21 -21
  52. package/lib/models/config-manager.js +2 -2
  53. package/lib/models/config.d.ts +68 -67
  54. package/lib/models/config.js +2 -2
  55. package/lib/models/counter.d.ts +11 -11
  56. package/lib/models/counter.js +2 -2
  57. package/lib/models/errors.d.ts +15 -15
  58. package/lib/models/errors.js +2 -2
  59. package/lib/models/exercise-obj.d.ts +30 -30
  60. package/lib/models/exercise-obj.js +2 -2
  61. package/lib/models/file.d.ts +5 -5
  62. package/lib/models/file.js +2 -2
  63. package/lib/models/findings.d.ts +17 -17
  64. package/lib/models/findings.js +2 -2
  65. package/lib/models/flags.d.ts +10 -10
  66. package/lib/models/flags.js +2 -2
  67. package/lib/models/front-matter.d.ts +11 -11
  68. package/lib/models/front-matter.js +2 -2
  69. package/lib/models/gitpod-data.d.ts +16 -16
  70. package/lib/models/gitpod-data.js +2 -2
  71. package/lib/models/language.d.ts +4 -4
  72. package/lib/models/language.js +2 -2
  73. package/lib/models/package.d.ts +7 -7
  74. package/lib/models/package.js +2 -2
  75. package/lib/models/plugin-config.d.ts +16 -16
  76. package/lib/models/plugin-config.js +2 -2
  77. package/lib/models/session.d.ts +31 -31
  78. package/lib/models/session.js +2 -2
  79. package/lib/models/socket.d.ts +36 -32
  80. package/lib/models/socket.js +2 -2
  81. package/lib/models/status.d.ts +1 -1
  82. package/lib/models/status.js +2 -2
  83. package/lib/models/success-types.d.ts +1 -1
  84. package/lib/models/success-types.js +2 -2
  85. package/lib/plugin/command/compile.d.ts +6 -6
  86. package/lib/plugin/command/compile.js +18 -18
  87. package/lib/plugin/command/test.d.ts +6 -6
  88. package/lib/plugin/command/test.js +25 -25
  89. package/lib/plugin/index.d.ts +27 -27
  90. package/lib/plugin/index.js +7 -7
  91. package/lib/plugin/plugin.d.ts +8 -8
  92. package/lib/plugin/plugin.js +68 -68
  93. package/lib/plugin/utils.d.ts +16 -16
  94. package/lib/plugin/utils.js +58 -58
  95. package/lib/ui/download.d.ts +5 -5
  96. package/lib/ui/download.js +61 -61
  97. package/lib/utils/BaseCommand.d.ts +8 -8
  98. package/lib/utils/BaseCommand.js +41 -41
  99. package/lib/utils/SessionCommand.d.ts +10 -10
  100. package/lib/utils/SessionCommand.js +43 -43
  101. package/lib/utils/api.d.ts +14 -14
  102. package/lib/utils/api.js +255 -255
  103. package/lib/utils/audit.d.ts +16 -16
  104. package/lib/utils/audit.js +303 -303
  105. package/lib/utils/checkNotInstalled.d.ts +2 -0
  106. package/lib/utils/checkNotInstalled.js +36 -0
  107. package/lib/utils/console.d.ts +12 -12
  108. package/lib/utils/console.js +19 -19
  109. package/lib/utils/errors.d.ts +17 -17
  110. package/lib/utils/errors.js +100 -100
  111. package/lib/utils/exercisesQueue.d.ts +9 -9
  112. package/lib/utils/exercisesQueue.js +38 -38
  113. package/lib/utils/fileQueue.d.ts +40 -40
  114. package/lib/utils/fileQueue.js +168 -168
  115. package/lib/utils/misc.d.ts +1 -1
  116. package/lib/utils/misc.js +23 -23
  117. package/lib/utils/osOperations.d.ts +5 -5
  118. package/lib/utils/osOperations.js +72 -72
  119. package/lib/utils/validators.d.ts +5 -5
  120. package/lib/utils/validators.js +17 -17
  121. package/lib/utils/watcher.d.ts +2 -2
  122. package/lib/utils/watcher.js +25 -25
  123. package/oclif.manifest.json +1 -1
  124. package/package.json +139 -139
  125. package/src/commands/audit.ts +443 -443
  126. package/src/commands/clean.ts +29 -29
  127. package/src/commands/download.ts +61 -61
  128. package/src/commands/init.ts +170 -170
  129. package/src/commands/login.ts +42 -42
  130. package/src/commands/logout.ts +43 -43
  131. package/src/commands/publish.ts +107 -107
  132. package/src/commands/start.ts +53 -23
  133. package/src/commands/test.ts +85 -85
  134. package/src/index.ts +1 -1
  135. package/src/managers/config/allowed_files.ts +29 -29
  136. package/src/managers/config/defaults.ts +42 -42
  137. package/src/managers/config/exercise.ts +311 -311
  138. package/src/managers/config/index.ts +455 -455
  139. package/src/managers/file.ts +196 -196
  140. package/src/managers/gitpod.ts +84 -84
  141. package/src/managers/server/index.ts +78 -78
  142. package/src/managers/server/routes.ts +330 -330
  143. package/src/managers/session.ts +145 -145
  144. package/src/managers/socket.ts +250 -250
  145. package/src/managers/telemetry.ts +346 -346
  146. package/src/managers/test.ts +83 -83
  147. package/src/models/action.ts +10 -10
  148. package/src/models/audit.ts +16 -16
  149. package/src/models/config-manager.ts +23 -23
  150. package/src/models/config.ts +5 -3
  151. package/src/models/counter.ts +11 -11
  152. package/src/models/errors.ts +22 -22
  153. package/src/models/exercise-obj.ts +29 -29
  154. package/src/models/file.ts +5 -5
  155. package/src/models/findings.ts +18 -18
  156. package/src/models/flags.ts +10 -10
  157. package/src/models/front-matter.ts +11 -11
  158. package/src/models/gitpod-data.ts +19 -19
  159. package/src/models/language.ts +4 -4
  160. package/src/models/package.ts +7 -7
  161. package/src/models/plugin-config.ts +17 -17
  162. package/src/models/session.ts +34 -34
  163. package/src/models/socket.ts +5 -0
  164. package/src/models/status.ts +16 -16
  165. package/src/models/success-types.ts +1 -1
  166. package/src/plugin/command/compile.ts +17 -17
  167. package/src/plugin/command/test.ts +30 -30
  168. package/src/plugin/index.ts +6 -6
  169. package/src/plugin/plugin.ts +94 -94
  170. package/src/plugin/utils.ts +87 -87
  171. package/src/types/node-fetch.d.ts +1 -1
  172. package/src/ui/download.ts +71 -71
  173. package/src/utils/BaseCommand.ts +48 -48
  174. package/src/utils/SessionCommand.ts +43 -43
  175. package/src/utils/api.ts +303 -303
  176. package/src/utils/audit.ts +393 -393
  177. package/src/utils/checkNotInstalled.ts +46 -0
  178. package/src/utils/console.ts +24 -24
  179. package/src/utils/errors.ts +117 -117
  180. package/src/utils/exercisesQueue.ts +51 -51
  181. package/src/utils/fileQueue.ts +198 -198
  182. package/src/utils/misc.ts +23 -23
  183. package/src/utils/osOperations.ts +79 -79
  184. package/src/utils/templates/gitignore.txt +19 -19
  185. package/src/utils/templates/incremental/.learn/exercises/01-hello-world/README.es.md +24 -24
  186. package/src/utils/templates/incremental/.learn/exercises/01-hello-world/README.md +24 -24
  187. package/src/utils/templates/incremental/README.ejs +4 -4
  188. package/src/utils/templates/incremental/README.es.ejs +4 -4
  189. package/src/utils/templates/isolated/01-hello-world/README.es.md +26 -26
  190. package/src/utils/templates/isolated/01-hello-world/README.md +26 -26
  191. package/src/utils/templates/isolated/README.ejs +4 -4
  192. package/src/utils/templates/isolated/README.es.ejs +4 -4
  193. package/src/utils/templates/no-grading/README.ejs +4 -4
  194. package/src/utils/templates/no-grading/README.es.ejs +4 -4
  195. package/src/utils/validators.ts +18 -18
  196. package/src/utils/watcher.ts +27 -27
@@ -1,145 +1,145 @@
1
- import Console from "../utils/console"
2
- import api from "../utils/api"
3
-
4
- import v from "validator"
5
- import { ValidationError, InternalError } from "../utils/errors"
6
-
7
- import * as fs from "fs"
8
- import cli from "cli-ux"
9
- import * as storage from "node-persist"
10
-
11
- import { IPayload, ISession, IStartProps } from "../models/session"
12
- import { IConfigObj } from "../models/config"
13
- import TelemetryManager from "./telemetry"
14
-
15
- const Session: ISession = {
16
- sessionStarted: false,
17
- token: null,
18
- config: null,
19
- currentCohort: null,
20
- initialize: async function () {
21
- if (!this.sessionStarted) {
22
- if (!this.config) {
23
- throw InternalError("Configuration not found")
24
- }
25
-
26
- if (!fs.existsSync(this.config.dirPath)) {
27
- fs.mkdirSync(this.config.dirPath)
28
- }
29
-
30
- await storage.init({ dir: `${this.config.dirPath}/.session` })
31
- this.sessionStarted = true
32
- }
33
-
34
- return true
35
- },
36
-
37
- setRigoToken: async function (token: string) {
38
- await this.initialize()
39
- const payload = await storage.getItem("bc-payload")
40
- await storage.setItem("bc-payload", {
41
- ...payload,
42
- rigobot: { key: token },
43
- })
44
- Console.debug("Rigobot token successfuly set")
45
- return true
46
- },
47
- setPayload: async function (value: IPayload) {
48
- await this.initialize()
49
- await storage.setItem("bc-payload", { token: this.token, ...value })
50
- Console.debug("Payload successfuly found and set for " + value.email)
51
- return true
52
- },
53
- getPayload: async function () {
54
- await this.initialize()
55
- let payload = null
56
- try {
57
- payload = await storage.getItem("bc-payload")
58
- } catch {
59
- Console.debug("Error retriving session payload")
60
- }
61
-
62
- return payload
63
- },
64
- isActive: function () {
65
- /* if (this.token) {
66
- return true
67
- } else {
68
- return false
69
- } */
70
- return !!this.token
71
- },
72
- get: async function (configObj?: IConfigObj) {
73
- if (configObj && configObj.config) {
74
- this.config = configObj.config
75
- }
76
-
77
- await this.sync()
78
- if (!this.isActive()) {
79
- return null
80
- }
81
-
82
- const payload = await this.getPayload()
83
-
84
- return {
85
- payload,
86
- token: this.token,
87
- }
88
- },
89
- login: async function () {
90
- const email = await cli.prompt("What is your email?")
91
- if (!v.isEmail(email)) {
92
- throw ValidationError("Invalid email")
93
- }
94
-
95
- const password = await cli.prompt("What is your password?", {
96
- type: "hide",
97
- })
98
-
99
- const data = await api.login(email, password)
100
- if (data) {
101
- cli.log(data)
102
- this.start({ token: data.token, payload: data })
103
- }
104
- },
105
- loginWeb: async function (email, password) {
106
- if (!v.isEmail(email)) {
107
- throw ValidationError("Invalid email")
108
- }
109
-
110
- const data = await api.login(email, password)
111
- if (data) {
112
- this.start({ token: data.token, payload: data })
113
- TelemetryManager.setStudent({
114
- user_id: data.user_id,
115
- email: data.email,
116
- token: data.token,
117
- })
118
- return data
119
- }
120
- },
121
- sync: async function () {
122
- const payload = await this.getPayload()
123
- if (payload) {
124
- this.token = payload.token
125
- }
126
- },
127
- start: async function ({ token, payload = null }: IStartProps) {
128
- if (!token) {
129
- throw new Error("A token and email is needed to start a session")
130
- }
131
-
132
- this.token = token
133
-
134
- if (payload && (await this.setPayload(payload))) {
135
- Console.success(`Successfully logged in as ${payload.email}`)
136
- }
137
- },
138
- destroy: async function () {
139
- await storage.clear()
140
- this.token = null
141
- Console.success("You have logged out")
142
- },
143
- }
144
-
145
- export default Session
1
+ import Console from "../utils/console"
2
+ import api from "../utils/api"
3
+
4
+ import v from "validator"
5
+ import { ValidationError, InternalError } from "../utils/errors"
6
+
7
+ import * as fs from "fs"
8
+ import cli from "cli-ux"
9
+ import * as storage from "node-persist"
10
+
11
+ import { IPayload, ISession, IStartProps } from "../models/session"
12
+ import { IConfigObj } from "../models/config"
13
+ import TelemetryManager from "./telemetry"
14
+
15
+ const Session: ISession = {
16
+ sessionStarted: false,
17
+ token: null,
18
+ config: null,
19
+ currentCohort: null,
20
+ initialize: async function () {
21
+ if (!this.sessionStarted) {
22
+ if (!this.config) {
23
+ throw InternalError("Configuration not found")
24
+ }
25
+
26
+ if (!fs.existsSync(this.config.dirPath)) {
27
+ fs.mkdirSync(this.config.dirPath)
28
+ }
29
+
30
+ await storage.init({ dir: `${this.config.dirPath}/.session` })
31
+ this.sessionStarted = true
32
+ }
33
+
34
+ return true
35
+ },
36
+
37
+ setRigoToken: async function (token: string) {
38
+ await this.initialize()
39
+ const payload = await storage.getItem("bc-payload")
40
+ await storage.setItem("bc-payload", {
41
+ ...payload,
42
+ rigobot: { key: token },
43
+ })
44
+ Console.debug("Rigobot token successfuly set")
45
+ return true
46
+ },
47
+ setPayload: async function (value: IPayload) {
48
+ await this.initialize()
49
+ await storage.setItem("bc-payload", { token: this.token, ...value })
50
+ Console.debug("Payload successfuly found and set for " + value.email)
51
+ return true
52
+ },
53
+ getPayload: async function () {
54
+ await this.initialize()
55
+ let payload = null
56
+ try {
57
+ payload = await storage.getItem("bc-payload")
58
+ } catch {
59
+ Console.debug("Error retriving session payload")
60
+ }
61
+
62
+ return payload
63
+ },
64
+ isActive: function () {
65
+ /* if (this.token) {
66
+ return true
67
+ } else {
68
+ return false
69
+ } */
70
+ return !!this.token
71
+ },
72
+ get: async function (configObj?: IConfigObj) {
73
+ if (configObj && configObj.config) {
74
+ this.config = configObj.config
75
+ }
76
+
77
+ await this.sync()
78
+ if (!this.isActive()) {
79
+ return null
80
+ }
81
+
82
+ const payload = await this.getPayload()
83
+
84
+ return {
85
+ payload,
86
+ token: this.token,
87
+ }
88
+ },
89
+ login: async function () {
90
+ const email = await cli.prompt("What is your email?")
91
+ if (!v.isEmail(email)) {
92
+ throw ValidationError("Invalid email")
93
+ }
94
+
95
+ const password = await cli.prompt("What is your password?", {
96
+ type: "hide",
97
+ })
98
+
99
+ const data = await api.login(email, password)
100
+ if (data) {
101
+ cli.log(data)
102
+ this.start({ token: data.token, payload: data })
103
+ }
104
+ },
105
+ loginWeb: async function (email, password) {
106
+ if (!v.isEmail(email)) {
107
+ throw ValidationError("Invalid email")
108
+ }
109
+
110
+ const data = await api.login(email, password)
111
+ if (data) {
112
+ this.start({ token: data.token, payload: data })
113
+ TelemetryManager.setStudent({
114
+ user_id: data.user_id,
115
+ email: data.email,
116
+ token: data.token,
117
+ })
118
+ return data
119
+ }
120
+ },
121
+ sync: async function () {
122
+ const payload = await this.getPayload()
123
+ if (payload) {
124
+ this.token = payload.token
125
+ }
126
+ },
127
+ start: async function ({ token, payload = null }: IStartProps) {
128
+ if (!token) {
129
+ throw new Error("A token and email is needed to start a session")
130
+ }
131
+
132
+ this.token = token
133
+
134
+ if (payload && (await this.setPayload(payload))) {
135
+ Console.success(`Successfully logged in as ${payload.email}`)
136
+ }
137
+ },
138
+ destroy: async function () {
139
+ await storage.clear()
140
+ this.token = null
141
+ Console.success("You have logged out")
142
+ },
143
+ }
144
+
145
+ export default Session