Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misc cleanup & consistency amends #9002

Merged
merged 7 commits into from
Sep 12, 2017
Merged

Conversation

ErisDS
Copy link
Member

@ErisDS ErisDS commented Sep 12, 2017

This PR contains a collection of tiny changes to the code base - mostly around consistency of naming things / ordering things.

These things absolutely do not matter normally. When searching & comparing bits of the codebase to try to figure out how to abstract out certain concepts, which I'm doing a lot of at the moment, absolute consistency makes things clearer.

Therefore these changes just make it easier for me to do more intensive changes on top of the codebase.

There should be zero behavioural changes in here.

no issue

- makes it easier to search and inspect the various usages
no issue

- Simplifies this util to make it easier to see what it does
- add some consistency to the calls to res.render
- making it clearer what code is the same to aid in refactoring
- This was used during prototyping to differ between different ORMS!!! 😱
- Let's call it models everywhere now...
- we're no longer using alignment in vars
- always refer to local utils as apiUtils
- logical grouping of requires - dependencies, utils, "lib common" etc
- use xAPI to refer to API endpoints, e.g. mailAPI, settingsAPI for clarity
@kirrg001 kirrg001 self-assigned this Sep 12, 2017
@@ -2,7 +2,7 @@
// RESTful API for the Client resource
var Promise = require('bluebird'),
_ = require('lodash'),
dataProvider = require('../models'),
models = require('../models'),

This comment was marked as abuse.

Copy link
Contributor

@kirrg001 kirrg001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is amazing!

@kirrg001 kirrg001 merged commit 4237446 into TryGhost:master Sep 12, 2017
@ErisDS ErisDS deleted the minor-changes branch September 12, 2017 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants