A few housekeeping items

Author: samerbuna

.eslintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+  env: {
+    es6: true,
+    node: true,
+    jest: true,
+  },
+  extends: 'eslint:recommended',
+  rules: {
+    indent: ['error', 2, { SwitchCase: 1 }],
+    'linebreak-style': ['error', 'unix'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'always'],
+    'no-console': ['warn', { allow: ['info', 'error', 'dir'] }],
+    'arrow-parens': ['error', 'always'],
+    curly: 'error',
+    'no-else-return': 'error',
+    'no-unneeded-ternary': 'error',
+    'no-useless-return': 'error',
+    'no-var': 'error',
+    'one-var': ['error', 'never'],
+    'prefer-arrow-callback': 'error',
+    'prefer-const': 'error',
+    strict: 'error',
+    'symbol-description': 'error',
+    yoda: ['error', 'never', { exceptRange: true }],
+  },
+};

.gitignore

@@ -8,3 +8,4 @@ npm-debug.log*
 
 build/
 node_modules/
+coverage/

.npmignore

@@ -0,0 +1,3 @@
+node_modules/
+coverage/
+.eslintrc.js

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "node"
+before_install:
+  - npm i -g npm

LICENSE

@@ -1,30 +1,9 @@
-BSD License
+The MIT License (MIT)
 
-For GraphQL software
+Copyright (c) 2017-present Samer Buna
 
-Copyright (c) 2017, jsComplete, Inc. All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
- * Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
- * Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
- * Neither the name jsComplete nor the names of its contributors may be used to
-   endorse or promote products derived from this software without specific
-   prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,11 +1,12 @@
 # Graphfront
 
-Use a database schema information to generate a GraphQL schema.
+Use a PostgreSQL database schema information to generate a GraphQL schema.
 
 This is a work-in-progress project.
 It requires a super recent version of Node.js and using it in production is not recommended.
 
 
+[![Build Status](https://travis-ci.org/jscomplete/graphfront.svg?branch=master)](https://travis-ci.org/jscomplete/graphfront)
 [![npm version](https://badge.fury.io/js/graphfront.svg)](https://badge.fury.io/js/graphfront)
 
 ## Getting Started
@@ -33,7 +34,7 @@ import { generator } from 'graphfront';
 const { getSchema } = generator(dbPool, apiKeyValidator);
 ```
 
-This defines a a function that can be invoked to generate a schema.
+This defines a function that can be invoked to generate a schema.
 
 Or you can use request handler that automatically generates the schema
 
@@ -59,4 +60,4 @@ Changes are tracked as [Github releases](https://github.com/jscomplete/graphfron
 
 ### License
 
-Graphfront is [BSD-licensed](https://github.com/jscomplete/graphfront/blob/master/LICENSE).
+Graphfront is released under the [MIT license](https://github.com/jscomplete/graphfront/blob/master/LICENSE).

lib/__tests__/index.test.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const graphql = require('graphql');
+const graphfront = require('../index');
+const graphqlHTTP = require('express-graphql');
+
+describe('Graphfront API', () => {
+  it('exposes buildSchema and graphqlHTTP', () => {
+    expect(graphfront.buildSchema).toBe(graphql.buildSchema);
+    expect(graphfront.graphqlHTTP).toBe(graphqlHTTP);
+  });
+
+  it('must be a top-level function that receives a config object', () => {
+    expect(() => graphfront({})).not.toThrow();
+
+    expect(() => graphfront()).toThrow();
+  });
+
+  it('exposes a schemaDb function', () => {
+    expect(() => graphfront.schemaDb()).not.toThrow();
+  });
+
+  it('exposes a generator function', () => {
+    expect(() => graphfront.generator()).not.toThrow();
+  });
+});

lib/config.js

@@ -1,3 +1,5 @@
+'use strict';
+
 module.exports = {
-  recordsLimit: process.env.GF_RECORDSLIMIT || 100,
+  recordsLimit: process.env.GF_RECORDSLIMIT || 100
 };