feat(intellisense): add type comments

RomainLanz · RomainLanz · commit 9943734a7336 · 2018-09-15T09:41:46.000+02:00
diff --git a/app/Models/Token.js b/app/Models/Token.js
@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */
 const Model = use('Model')
 
 class Token extends Model {
diff --git a/app/Models/User.js b/app/Models/User.js
@@ -1,6 +1,9 @@
 'use strict'
 
+/** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */
 const Model = use('Model')
+
+/** @type {import('@adonisjs/framework/src/Hash')} */
 const Hash = use('Hash')
 
 class User extends Model {
diff --git a/config/app.js b/config/app.js
@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {import('@adonisjs/framework/src/Env')} */
 const Env = use('Env')
 
 module.exports = {
diff --git a/config/auth.js b/config/auth.js
@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {import('@adonisjs/framework/src/Env')} */
 const Env = use('Env')
 
 module.exports = {
diff --git a/config/database.js b/config/database.js
@@ -1,6 +1,9 @@
 'use strict'
 
+/** @type {import('@adonisjs/framework/src/Env')} */
 const Env = use('Env')
+
+/** @type {import('@adonisjs/ignitor/src/Helpers')} */
 const Helpers = use('Helpers')
 
 module.exports = {
diff --git a/config/hash.js b/config/hash.js
@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {import('@adonisjs/framework/src/Env')} */
 const Env = use('Env')
 
 module.exports = {
diff --git a/database/factory.js b/database/factory.js
@@ -11,12 +11,11 @@
 |
 */
 
+/** @type {import('@adonisjs/lucid/src/Factory')} */
 // const Factory = use('Factory')
 
-/**
-  Factory.blueprint('App/Models/User', (faker) => {
-    return {
-      username: faker.username()
-    }
-  })
-*/
+// Factory.blueprint('App/Models/User', (faker) => {
+//   return {
+//     username: faker.username()
+//   }
+// })
diff --git a/database/migrations/1503250034279_user.js b/database/migrations/1503250034279_user.js
@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {import('@adonisjs/lucid/src/Schema')} */
 const Schema = use('Schema')
 
 class UserSchema extends Schema {
diff --git a/database/migrations/1503250034280_token.js b/database/migrations/1503250034280_token.js
@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {import('@adonisjs/lucid/src/Schema')} */
 const Schema = use('Schema')
 
 class TokensSchema extends Schema {
diff --git a/start/kernel.js b/start/kernel.js
@@ -1,5 +1,6 @@
 'use strict'
 
+/** @type {import('@adonisjs/framework/src/Server')} */
 const Server = use('Server')
 
 /*
diff --git a/start/routes.js b/start/routes.js
@@ -13,6 +13,7 @@
 |
 */
 
+/** @type {import('@adonisjs/framework/src/Route/Manager'} */
 const Route = use('Route')
 
 Route.get('/', () => {

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`\|`
`14`	`14`	`*/`
`15`	`15`
	`16`	`+/** @type {import('@adonisjs/framework/src/Route/Manager'} */`
`16`	`17`	`const Route = use('Route')`
`17`	`18`
`18`	`19`	`Route.get('/', () => {`