Merge pull request #100 from AthennaIO/develop

feat(path): add models method

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/common",
-  "version": "4.21.0",
+  "version": "4.22.0",
   "description": "The Athenna common helpers to use in any Node.js ESM project.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",

src/helpers/Path.ts

@@ -19,6 +19,7 @@ export class Path {
     bin: 'bin',
     src: 'src',
     app: 'app',
+    models: 'app/models',
     services: 'app/services',
     exceptions: 'app/exceptions',
     repositories: 'app/repositories',
@@ -526,6 +527,22 @@ export class Path {
     return this
   }
 
+  /**
+   * Return the models' path of your project.
+   */
+  public static models(subPath: string = sep): string {
+    return this.pwd(this.dirs.models + sep + normalize(subPath))
+  }
+
+  /**
+   * Set the directory of models folder.
+   */
+  public static setModels(directory: string): typeof Path {
+    this.dirs.models = directory
+
+    return this
+  }
+
   /**
    * Return the services' path of your project.
    */

src/types/PathDirs.ts

@@ -11,6 +11,7 @@ export interface PathDirs {
   bin?: string
   src?: string
   app?: string
+  models?: string
   services?: string
   exceptions?: string
   repositories?: string

tests/unit/PathTest.ts

@@ -75,6 +75,7 @@ export default class PathTest {
 
     assert.equal(Path.http(), mainPath.concat(sep, 'http'))
     assert.equal(Path.console(), mainPath.concat(sep, 'console'))
+    assert.equal(Path.models(), mainPath.concat(sep, 'models'))
     assert.equal(Path.services(), mainPath.concat(sep, 'services'))
     assert.equal(Path.exceptions(), mainPath.concat(sep, 'exceptions'))
     assert.equal(Path.repositories(), mainPath.concat(sep, 'repositories'))
@@ -154,6 +155,7 @@ export default class PathTest {
     Path.setBin('build/bin')
       .setSrc('build/src')
       .setApp('build/app')
+      .setModels('build/app/models')
       .setServices('build/app/services')
       .setExceptions('build/app/exceptions')
       .setRepositories('build/app/repositories')
@@ -190,6 +192,7 @@ export default class PathTest {
     assert.isTrue(Path.bin().endsWith(`build${sep}bin`))
     assert.isTrue(Path.src().endsWith(`build${sep}src`))
     assert.isTrue(Path.app().endsWith(`build${sep}app`))
+    assert.isTrue(Path.models().endsWith(`build${sep}app${sep}models`))
     assert.isTrue(Path.services().endsWith(`build${sep}app${sep}services`))
     assert.isTrue(Path.exceptions().endsWith(`build${sep}app${sep}exceptions`))
     assert.isTrue(Path.repositories().endsWith(`build${sep}app${sep}repositories`))