refactor(grind-example-api): updated api starter to work with monorepo

Author: shnhrrsn

.babelrc

@@ -3,14 +3,11 @@ root = true
 [*]
 charset = "utf-8"
 end_of_line = lf
-indent_style = tab
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[{package.json}]
 indent_size = 2
 indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
 
-[*.yml]
-indent_size = 2
-indent_style = space
+[*.{js,cjs}]
+indent_size = 4
+indent_style = tab

.editorconfig

@@ -1,16 +1,18 @@
 {
-	"parser": "babel-eslint",
-	"plugins": [
-		"import-auto-name"
-	],
-	"env": {
-		"node": true
-	},
-	"extends": "grind",
-	"parserOptions": {
-		"sourceType": "module"
-	},
-	"globals": {
-		"ValidationError": false
-	}
+  "plugins": ["eslint-plugin-import-auto-name", "prettier"],
+  "parser": "babel-eslint",
+  "rules": {
+    "prettier/prettier": "error"
+  },
+  "env": {
+    "node": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "globals": {
+    "ValidationError": false
+  },
+  "extends": ["plugin:prettier/recommended"]
 }

.eslintrc.json

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2017 Shaun Harrison
+Copyright (c) 2016-2020 Shaun Harrison
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

.travis.yml

@@ -9,7 +9,7 @@
 
 # Grind API Template
 
-The Grind API Template is an example project for building API’s on [Grind](https://github.com/grindjs/framework).  It’s also used as a template in [Grind Installer](https://github.com/grindjs/installer) so you can quickly setup a new API project.
+The Grind API Template is an example project for building API’s on [Grind](https://github.com/grindjs/framework). It’s also used as a template in [Grind Installer](https://github.com/grindjs/installer) so you can quickly setup a new API project.
 
 ## Installation
 
@@ -40,10 +40,10 @@ You should now be able to visit [localhost:3000/states](http://localhost:3000/st
 
 Other URLs:
 
- * Paged: [localhost:3000/states?limit=10](http://localhost:3000/states?limit=10)
- * Individual: [localhost:3000/states/ny](http://localhost:3000/states/ny)
- * Search: [localhost:3000/states/search?term=new](http://localhost:3000/states/search?term=new)
- * Swagger: [petstore.swagger.io/?url=http://localhost:3000/swagger.json](http://petstore.swagger.io/?url=http://localhost:3000/swagger.json)
+- Paged: [localhost:3000/states?limit=10](http://localhost:3000/states?limit=10)
+- Individual: [localhost:3000/states/ny](http://localhost:3000/states/ny)
+- Search: [localhost:3000/states/search?term=new](http://localhost:3000/states/search?term=new)
+- Swagger: [petstore.swagger.io/?url=http://localhost:3000/swagger.json](http://petstore.swagger.io/?url=http://localhost:3000/swagger.json)
 
 ## Documentation
 

LICENSE

@@ -3,38 +3,34 @@ import { Command, InputArgument, InputOption } from 'grind-cli'
 import 'App/Models/StateModel'
 
 export class StatesListCommand extends Command {
-
 	// Name of the command
 	name = 'states:list'
 
 	// Description of the command to show in help
 	description = 'List all states in the database'
 
 	// Arguments available for this command
-	arguments = [
-		new InputArgument('term', InputArgument.VALUE_OPTIONAL, 'Search term'),
-	]
+	arguments = [new InputArgument('term', InputArgument.VALUE_OPTIONAL, 'Search term')]
 
 	// Options for this command
 	options = [
-		new InputOption('limit', InputOption.VALUE_OPTIONAL, 'Limit the number of states', '100')
+		new InputOption('limit', InputOption.VALUE_OPTIONAL, 'Limit the number of states', '100'),
 	]
 
 	run() {
 		const limit = Number.parseInt(this.option('limit', 100))
 		let query = null
 
-		if(this.containsArgument('term')) {
+		if (this.containsArgument('term')) {
 			query = StateModel.find(this.argument('term'))
 		} else {
 			query = StateModel.query()
 		}
 
 		return query.limit(limit).then(rows => {
-			for(const row of rows) {
+			for (const row of rows) {
 				this.comment(row.name)
 			}
 		})
 	}
-
 }

README.markdown

@@ -1,7 +1,6 @@
 import { Controller } from 'grind-http'
 
 export class BaseController extends Controller {
-
 	db = null
 
 	constructor(app) {
@@ -19,7 +18,6 @@ export class BaseController extends Controller {
 
 	paginationRange(req, limit = 100) {
 		const pagination = this.pagination(req, limit)
-		return { start: pagination.offset, end: (pagination.limit + pagination.offset) - 1 }
+		return { start: pagination.offset, end: pagination.limit + pagination.offset - 1 }
 	}
-
 }

app/Commands/StatesListCommand.js

@@ -3,19 +3,20 @@ import 'App/Controllers/BaseController'
 import 'App/Models/CompanyModel'
 
 export class CompaniesController extends BaseController {
-
 	model = CompanyModel
 
 	index(req, res) {
 		const { start, end } = this.paginationRange(req)
 
-		return this.model.query().range(start, end).then(rows => {
-			if(rows.isNil) {
-				throw new NotFoundError('No companies found')
-			}
+		return this.model
+			.query()
+			.range(start, end)
+			.then(rows => {
+				if (rows.isNil) {
+					throw new NotFoundError('No companies found')
+				}
 
-			res.send(rows)
-		})
+				res.send(rows)
+			})
 	}
-
 }

app/Controllers/BaseController.js

@@ -3,19 +3,21 @@ import 'App/Controllers/BaseController'
 import 'App/Models/CountryModel'
 
 export class CountriesController extends BaseController {
-
 	model = CountryModel
 
 	index(req, res) {
 		const { start, end } = this.paginationRange(req)
 
-		return this.model.query().range(start, end).then(rows => {
-			if(rows.isNil) {
-				throw new NotFoundError('No countries found')
-			}
+		return this.model
+			.query()
+			.range(start, end)
+			.then(rows => {
+				if (rows.isNil) {
+					throw new NotFoundError('No countries found')
+				}
 
-			res.send(rows)
-		})
+				res.send(rows)
+			})
 	}
 
 	show(req, res) {
@@ -25,19 +27,21 @@ export class CountriesController extends BaseController {
 	}
 
 	search(req, res) {
-		if(req.query.term.isNil || req.query.term.length === 0) {
+		if (req.query.term.isNil || req.query.term.length === 0) {
 			throw new ValidationError({ term: 'term is required' })
 		}
 
 		const { start, end } = this.paginationRange(req)
 
-		return this.model.find(req.query.term).range(start, end).then(rows => {
-			if(rows.isNil) {
-				throw new NotFoundError('No countries found, try a different term')
-			}
+		return this.model
+			.find(req.query.term)
+			.range(start, end)
+			.then(rows => {
+				if (rows.isNil) {
+					throw new NotFoundError('No countries found, try a different term')
+				}
 
-			res.send(rows)
-		})
+				res.send(rows)
+			})
 	}
-
 }

app/Controllers/CompaniesController.js

@@ -3,19 +3,21 @@ import 'App/Controllers/BaseController'
 import 'App/Models/StateModel'
 
 export class StatesController extends BaseController {
-
 	model = StateModel
 
 	index(req, res) {
 		const { start, end } = this.paginationRange(req)
 
-		return this.model.query().range(start, end).then(rows => {
-			if(rows.isNil) {
-				throw new NotFoundError('No states found')
-			}
+		return this.model
+			.query()
+			.range(start, end)
+			.then(rows => {
+				if (rows.isNil) {
+					throw new NotFoundError('No states found')
+				}
 
-			res.send(rows)
-		})
+				res.send(rows)
+			})
 	}
 
 	show(req, res) {
@@ -25,19 +27,21 @@ export class StatesController extends BaseController {
 	}
 
 	search(req, res) {
-		if(req.query.term.isNil || req.query.term.length === 0) {
+		if (req.query.term.isNil || req.query.term.length === 0) {
 			throw new BadRequestError('`term` is required')
 		}
 
 		const { start, end } = this.paginationRange(req)
 
-		return this.model.find(req.query.term).range(start, end).then(rows => {
-			if(rows.isNil) {
-				throw new NotFoundError('No states found, try a different term')
-			}
+		return this.model
+			.find(req.query.term)
+			.range(start, end)
+			.then(rows => {
+				if (rows.isNil) {
+					throw new NotFoundError('No states found, try a different term')
+				}
 
-			res.send(rows)
-		})
+				res.send(rows)
+			})
 	}
-
 }

app/Controllers/CountriesController.js

@@ -3,26 +3,24 @@ import { Model } from 'grind-orm'
 import 'App/Models/StateModel'
 
 export class CompanyModel extends Model {
-
 	static tableName = 'companies'
 	static eager = 'locations'
 
 	static jsonSchema = {
 		type: 'object',
-		required: [ 'name' ],
+		required: ['name'],
 
 		properties: {
 			id: { type: 'integer' },
 			name: { type: 'string', maxLength: 255 },
 			created_at: { type: 'datetime', format: 'date-time' },
-			updated_at: { type: 'datetime', format: 'date-time' }
-		}
+			updated_at: { type: 'datetime', format: 'date-time' },
+		},
 	}
 
 	static buildRelations() {
 		return {
-			locations: this.belongsToMany(StateModel)
+			locations: this.belongsToMany(StateModel),
 		}
 	}
-
 }

app/Controllers/StatesController.js

@@ -3,22 +3,23 @@ import { Model } from 'grind-orm'
 import 'App/Models/StateModel'
 
 export class CountryModel extends Model {
-
 	static tableName = 'countries'
 
 	static jsonSchema = {
 		type: 'object',
-		required: [ 'name', 'abbreviation' ],
+		required: ['name', 'abbreviation'],
 
 		properties: {
 			id: { type: 'integer' },
 			name: { type: 'string', maxLength: 64 },
-			abbreviation: { type: 'string', maxLength: 2 }
-		}
+			abbreviation: { type: 'string', maxLength: 2 },
+		},
 	}
 
 	static find(term) {
-		return this.query().where('name', 'like', `%${term}%`).orWhere('abbreviation', 'like', `%${term}%`)
+		return this.query()
+			.where('name', 'like', `%${term}%`)
+			.orWhere('abbreviation', 'like', `%${term}%`)
 	}
 
 	static findByAbbreviation(abbreviation) {
@@ -31,8 +32,7 @@ export class CountryModel extends Model {
 
 	static buildRelations() {
 		return {
-			states: this.hasMany(StateModel)
+			states: this.hasMany(StateModel),
 		}
 	}
-
 }