fix: automated deployment! (#44)

fix: automated deployment!

Author: wovalle

.travis.yml

@@ -3,25 +3,21 @@ node_js:
   - '10'
 
 stages:
-  - compile
   - test
   - name: deploy
     if: branch = master
 
 jobs:
   include:
-    - stage: compile
-      script: yarn build
-
     - stage: test
       script:
         - yarn lint
+        # - commitlint-travis
         - yarn test
 
     - stage: deploy
       script:
         - yarn build
         - yarn semantic-release
-        - yarn deploy:documentation
 
 cache: yarn

README.md

@@ -29,13 +29,13 @@ import * as fireorm from 'fireorm';
 const serviceAccount = require('../firestore.creds.json');
 
 admin.initializeApp({
-    credential: admin.credential.cert(serviceAccount),
-    databaseURL: `https://${serviceAccount.project_id}.firebaseio.com`,
+  credential: admin.credential.cert(serviceAccount),
+  databaseURL: `https://${serviceAccount.project_id}.firebaseio.com`,
 });
 
 const firestore = admin.firestore();
 firestore.settings({
-    timestampsInSnapshots: true,
+  timestampsInSnapshots: true,
 });
 fireorm.Initialize(firestore);
 ```
@@ -47,9 +47,9 @@ import { Collection } from 'fireorm';
 
 @Collection()
 class Todo {
-    id: string;
-    text: string;
-    done: Boolean;
+  id: string;
+  text: string;
+  done: Boolean;
 }
 ```
 
@@ -60,9 +60,9 @@ import { Collection, getRepository } from 'fireorm';
 
 @Collection()
 class Todo {
-    id: string;
-    text: string;
-    done: Boolean;
+  id: string;
+  text: string;
+  done: Boolean;
 }
 
 const todoRepository = getRepository(Todo, firestore);
@@ -103,6 +103,10 @@ yarn test # or npm test
 
 Test files must follow the naming convention `*.test.ts` and use [mocha](https://mochajs.org/) as the test runner.
 
+### Committing
+
+This repo uses [Conventional Commits](https://www.conventionalcommits.org/) as the commit messages convention.
+
 ### Release a new version
 
 This repo uses [Sematic Release](https://github.com/semantic-release/semantic-release) to automatically release new versions as soon as they land on master.

package.json

@@ -1,22 +1,51 @@
 {
   "name": "fireorm",
-  "version": "0.4.0",
   "description": "ORM for Firestore",
+  "version": "0.0.0-development",
+  "author": "Willy Ovalle <[email protected]>",
+  "homepage": "https://wovalle.github.io/fireorm/",
+  "license": "ISC",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",
+  "bugs": {
+    "url": "https://github.com/wovalle/fireorm/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wovalle/fireorm.git"
+  },
+  "keywords": [
+    "firebase",
+    "firestore",
+    "orm"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:documentation": "typedoc --out docs --name fireorm --readme README.md --mode file --gaID UA-133856278-1 --excludeNotExported --exclude examples --exclude test",
+    "build:watch": "tsc -w",
+    "lint": "tslint --project tsconfig.json",
+    "lint:md": "remark README.md -o README.md",
+    "release": "semantic-release",
+    "test": "mocha --require ts-node/register src/*.spec.ts --recursively",
+    "test:watch": "mocha --require ts-node/register src/*.spec.ts --watch-extensions ts --recursively -w"
+  },
   "dependencies": {
     "class-transformer": "^0.2.0",
     "pluralize": "^7.0.0"
   },
   "devDependencies": {
+    "@commitlint/cli": "^7.6.1",
+    "@commitlint/config-conventional": "^7.6.0",
+    "@commitlint/travis-cli": "^7.6.1",
     "@google-cloud/firestore": "^0.19.0",
+    "@qiwi/semantic-release-gh-pages-plugin": "^1.9.1",
     "@types/chai": "^4.1.7",
     "@types/mocha": "^5.2.5",
     "@types/pluralize": "^0.0.29",
     "@types/sinon": "^7.0.6",
     "chai": "^4.2.0",
     "firebase-admin": "^6.5.0",
-    "gh-pages-deploy": "^0.5.1",
+    "husky": "^2.3.0",
     "mocha": "^5.2.0",
     "mock-cloud-firestore": "^0.9.0",
     "reflect-metadata": "^0.1.13",
@@ -28,40 +57,34 @@
     "typedoc": "^0.14.2",
     "typescript": "^3.2.2"
   },
-  "scripts": {
-    "lint": "tslint --project tsconfig.json",
-    "lint:md": "remark README.md -o README.md",
-    "build": "tsc",
-    "build:watch": "tsc -w",
-    "test": "mocha --require ts-node/register src/*.spec.ts --recursively",
-    "test:watch": "mocha --require ts-node/register src/*.spec.ts --watch-extensions ts --recursively -w",
-    "build:documentation": "typedoc --out docs --name fireorm --readme README.md --mode file --gaID UA-133856278-1 --excludeNotExported --exclude examples --exclude test",
-    "deploy:documentation": "gh-pages-deploy"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/wovalle/fireorm.git"
+  "peerDependencies": {
+    "reflect-metadata": "^0.1.13"
   },
-  "keywords": [
-    "orm",
-    "firestore",
-    "firebase"
+  "files": [
+    "/lib",
+    "!**/*.map",
+    "!**/*.spec.*",
+    "!**/examples/**",
+    "!**/test/**"
   ],
-  "author": "Willy Ovalle <[email protected]>",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/wovalle/fireorm/issues"
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
   },
-  "homepage": "https://wovalle.github.io/fireorm/",
-  "gh-pages-deploy": {
-    "staticpath": "docs",
-    "prep": [
-      "build:documentation"
-    ],
-    "commit": "Releasing version",
-    "noprompt": true
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
   },
-  "peerDependencies": {
-    "reflect-metadata": "^0.1.13"
+  "release": {
+    "branch": "master",
+    "plugins": [
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@qiwi/semantic-release-gh-pages-plugin"
+    ]
   }
 }

src/types.ts

@@ -2,7 +2,7 @@ import QueryBuilder from './QueryBuilder';
 
 // TODO: separate Read/Write interfaces to achieve readonly?
 export interface IRepository<T extends { id: string }> {
-  limit(limit: number): QueryBuilder<T>;
+  limit(limitVal: number): QueryBuilder<T>;
   findById(id: string): Promise<T>;
   create(item: T): Promise<T>;
   update(item: T): Promise<T>;