forked from adonisjs/core
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.js
More file actions
362 lines (331 loc) · 7.58 KB
/
index.js
File metadata and controls
362 lines (331 loc) · 7.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
'use strict'
/**
* adonis-framework
*
* (c) Harminder Virk <virk@adonisjs.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
const path = require('path')
const _ = require('lodash')
const CatLog = require('cat-log')
const log = new CatLog('adonis:framework')
const NE = require('node-exceptions')
let rootPath = '' // application root path
let autoloadNameSpace = '' // autoloading namespace | required for backword compatibility
/**
* path to base directories with relative
* paths from the project root.
*
* @type {Object}
*/
let originalProjectDirectories = {
public: 'public',
storage: 'storage',
database: 'database',
resources: 'resources',
config: 'config',
app: 'app'
}
/**
* cloning over original app directories so that orignal
* reset method should be able to restore it.
*
* @type {Object}
*/
let projectDirectories = _.clone(originalProjectDirectories)
/**
* Manage commonly required methods to be used anywhere inside
* the application
* @module Helpers
*/
let Helpers = exports = module.exports = {}
/**
* loads package.json file from application and set required paths
* and namespace based on same.
*
* @method load
*
* @param {String} packagePath
* @param {Object} Ioc
*
* @throws {DomainException} If autoload is not defined in package.json file
*
* @public
*/
Helpers.load = function (packagePath, Ioc) {
Helpers.reset() // reset itself before start
log.verbose('reading autoload settings from %s', packagePath)
rootPath = path.dirname(packagePath)
const packageFile = require(packagePath)
if (!packageFile.autoload) {
throw new NE.DomainException('autoload must be enable inside package.json file')
}
const autoloadSettings = Object.keys(packageFile.autoload)
if (!autoloadSettings.length) {
throw new NE.DomainException('autoload must be enable inside package.json file')
}
autoloadNameSpace = autoloadSettings[0]
Helpers.setProjectDirectory('app', packageFile.autoload[autoloadNameSpace])
if (Ioc && Ioc.autoload) {
Ioc.autoload(autoloadNameSpace, path.join(rootPath, projectDirectories.app))
}
}
/**
* the load method to be shipped with 3.1
*
* @param {String} appRoot
*
* @public
*/
Helpers.loadInFuture = function (appRoot) {
rootPath = appRoot
}
/**
* reset helpers state back to original
*
* @public
*/
Helpers.reset = function () {
projectDirectories = _.clone(originalProjectDirectories)
rootPath = null
autoloadNameSpace = null
}
/**
* returns the current mapping of directories
*
* @return {Object}
*
* @public
*/
Helpers.getProjectDirectories = function () {
return projectDirectories
}
/**
* overrides the current mapping of directories
*
* @param {Object} directories
*
* @public
*/
Helpers.setProjectDirectories = function (directories) {
projectDirectories = directories
}
/**
* overrides a give mapping of directories.
*
* @param {String} name
* @param {String} toPath
*
* @public
*/
Helpers.setProjectDirectory = function (name, toPath) {
projectDirectories[name] = toPath
}
/**
* Returns absolute path to application root
*
* @method basePath
*
* @return {String}
*/
Helpers.basePath = function () {
return rootPath
}
/**
* Returns absolute path to application folder which is
* defined under a given namespace.
*
* @method appPath
*
* @return {String}
*/
Helpers.appPath = function () {
const toDir = projectDirectories.app
return Helpers._makePath(rootPath, toDir)
}
/**
* Returns absolute path to application public folder or path to a
* given file inside public folder.
*
* @method publicPath
*
* @param {String} [toFile] - filename to return path for
* @return {String}
*/
Helpers.publicPath = function (toFile) {
const toDir = projectDirectories.public
return Helpers._makePath(rootPath, toDir, toFile)
}
/**
* Returns application namespace , under which
* app directory is registered.
*
* @method appNameSpace
*
* @return {String}
*/
Helpers.appNameSpace = function () {
return autoloadNameSpace
}
/**
* makes complete namespace for a given path and base
* namespace
*
* @method makeNameSpace
*
* @param {String} baseNameSpace
* @param {String} toPath
* @return {String}
*
* @public
*/
Helpers.makeNameSpace = function (baseNameSpace, toPath) {
const appNameSpace = Helpers.appNameSpace()
if (toPath.startsWith(appNameSpace)) {
return toPath
}
return path.normalize(`${appNameSpace}/${baseNameSpace}/${toPath}`)
}
/**
* returns absolute path to config directory or a file inside
* config directory
*
* @method configPath
*
* @param {String} [toFile] - filename to return path for
* @return {String}
*/
Helpers.configPath = function (toFile) {
const toDir = projectDirectories.config
return Helpers._makePath(rootPath, toDir, toFile)
}
/**
* returns absolute path to storage path of application or an
* file inside the storage path.
*
* @method storagePath
*
* @param {String} [toFile] - filename to return path for
* @return {String}
*
* @public
*/
Helpers.storagePath = function (toFile) {
const toDir = projectDirectories.storage
return Helpers._makePath(rootPath, toDir, toFile)
}
/**
* returns absolute path to resources directory or a file inside
* resources directory
*
* @method resourcesPath
*
* @param {String} [toFile] - filename to return path for
* @return {String}
*
* @public
*/
Helpers.resourcesPath = function (toFile) {
const toDir = projectDirectories.resources
return Helpers._makePath(rootPath, toDir, toFile)
}
/**
* returns absolute path to database/migrations directory.
*
* @method migrationsPath
*
* @param {String} [toFile] - filename to return path for
* @return {String}
*
* @public
*/
Helpers.migrationsPath = function (toFile) {
const toDir = toFile ? `./migrations/${toFile}` : './migrations'
return Helpers.databasePath(toDir)
}
/**
* returns absolute path to database/seeds directory.
*
* @method seedsPath
*
* @param {String} [toFile] - filename to return path for
* @return {String}
*
* @public
*/
Helpers.seedsPath = function (toFile) {
const toDir = toFile ? `./seeds/${toFile}` : './seeds'
return Helpers.databasePath(toDir)
}
/**
* returns absolute path to database/factories directory.
*
* @method factoriesPath
*
* @param {String} [toFile] - filename to return path for
* @return {String}
*
* @public
*/
Helpers.factoriesPath = function (toFile) {
const toDir = toFile ? `./factories/${toFile}` : './factories'
return Helpers.databasePath(toDir)
}
/**
* returns path to the database directory.
*
* @method databasePath
*
* @param {String} toFile
* @return {String}
*
* @public
*/
Helpers.databasePath = function (toFile) {
const toDir = projectDirectories.database
return Helpers._makePath(rootPath, toDir, toFile)
}
/**
* returns whether the process belongs to ace command
* or not.
*
* @method isAceCommand
*
* @return {Boolean}
*
* @public
*/
Helpers.isAceCommand = function () {
const processFile = process.mainModule.filename
return processFile.endsWith('ace')
}
/**
* returns absolute path to views directory
*
* @method viewsPath
*
* @return {String}
*
* @public
*/
Helpers.viewsPath = function () {
return Helpers.resourcesPath('views')
}
/**
* makes path by joining two endpoints
*
* @method _makePath
*
* @param {String} base
* @param {String} toDir
* @param {String} toFile
* @return {String}
*
* @private
*/
Helpers._makePath = function (base, toDir, toFile) {
toDir = path.isAbsolute(toDir) ? toDir : path.join(base, toDir)
return toFile ? path.join(toDir, toFile) : toDir
}