Core module should reference/import the other scope packages

README.md

@@ -5,7 +5,7 @@
 > Reliable algotrading utilities written in node
 
 ![CI Tests](https://github.com/nielse63/stonksjs/workflows/CI%20Tests/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/nielse63/stonksjs/badge.svg?branch=master)](https://coveralls.io/github/nielse63/stonksjs?branch=master)
+![Coveralls github](https://img.shields.io/coveralls/github/nielse63/stonksjs?style=flat-square)
 ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nielse63/stonksjs?style=flat-square)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 

docs/README.md

@@ -5,7 +5,7 @@
 > Reliable algotrading utilities written in node
 
 ![CI Tests](https://github.com/nielse63/stonksjs/workflows/CI%20Tests/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/nielse63/stonksjs/badge.svg?branch=master)](https://coveralls.io/github/nielse63/stonksjs?branch=master)
+![Coveralls github](https://img.shields.io/coveralls/github/nielse63/stonksjs?style=flat-square)
 ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nielse63/stonksjs?style=flat-square)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 

jest.config.js

@@ -25,14 +25,14 @@ module.exports = {
   collectCoverage: false,
 
   // An array of glob patterns indicating a set of files for which coverage information should be collected
-  collectCoverageFrom: [
-    // '<rootDir>/lib/**/*.{js,jsx}',
-    '<rootDir>/packages/**/*.{js,jsx}',
-    '!**/node_modules/**',
-    '!**/vendor/**',
-    '!**/typedef/**',
-    '!<rootDir>/**/index.js',
-  ],
+  // collectCoverageFrom: [
+  //   // '<rootDir>/lib/**/*.{js,jsx}',
+  //   '<rootDir>/**/*.{js,jsx}',
+  //   '!**/node_modules/**',
+  //   '!**/vendor/**',
+  //   '!**/typedef/**',
+  //   '!<rootDir>/**/index.js',
+  // ],
 
   // The directory where Jest should output its coverage files
   coverageDirectory: 'coverage',
@@ -138,10 +138,7 @@ module.exports = {
   // testLocationInResults: false,
 
   // The glob patterns Jest uses to detect test files
-  testMatch: [
-    '<rootDir>/packages/**/__tests__/**/*.[jt]s?(x)',
-    '<rootDir>/packages/**/?(*.)+(spec|test).[tj]s?(x)',
-  ],
+  testMatch: ['<rootDir>/**/__tests__/**/*.[jt]s?(x)', '<rootDir>/**/?(*.)+(spec|test).[tj]s?(x)'],
 
   // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
   testPathIgnorePatterns: [

packages/core/README.md

@@ -2,26 +2,47 @@
 
 > Core library for stonksjs
 
+- [Installation](#installation)
+- [API](#api)
+  - [@stonksjs/core : <code>object</code>](#stonksjscore--object)
+  - [stonks.finviz](#stonksfinviz)
+  - [stonks.quote](#stonksquote)
+  - [stonks.stockScreener](#stonksstockscreener)
+  - [stonks.robinhoodCollections](#stonksrobinhoodcollections)
+
+`@stonksjs/core` references all public packages from stonksjs. This is a convenient way to import
+all functionality from stonksjs without having to install each scoped module individually.
+
 ## Installation
 
 ```bash
 npm install --save @stonksjs/core
 ```
 
-## Usage
+## API
 
-```js
-const StonksCollection = require('@stonksjs/core');
+### @stonksjs/core : <code>object</code>
 
-const collection = new StonksCollection('reit');
+an object containing all public stonksjs modules
 
-// get list of symbols from the collection
-const symbols = await collection.getSymbols();
+### stonks.finviz
 
-// get object of with fundamental data for each item in collection
-const symbols = await collection.getQuotes();
-```
+References the [`@stonksjs/finviz`](https://nielse63.github.io/stonksjs/tree/master/packages/finviz)
+module
 
-## API
+### stonks.quote
+
+References the [`@stonksjs/quote`](https://nielse63.github.io/stonksjs/tree/master/packages/quote)
+module
+
+### stonks.stockScreener
+
+References the
+[`@stonksjs/stock-screener`](https://nielse63.github.io/stonksjs/tree/master/packages/stock-screener)
+module
+
+### stonks.robinhoodCollections
 
-Full API docs can be found in the [`docs/`](./docs/api.md) folder
+References the
+[`@stonksjs/robinhood-collections`](https://nielse63.github.io/stonksjs/tree/master/packages/robinhood-collections)
+module

packages/core/__tests__/index.spec.js

@@ -0,0 +1,11 @@
+const core = require('..');
+
+describe('@stonksjs/core', () => {
+  it('should be an object', () => {
+    expect(core).toBeObject();
+  });
+
+  it('should include all packages', () => {
+    expect(core).toContainKeys(['finviz', 'quote', 'stockScreener', 'robinhoodCollections']);
+  });
+});

packages/core/index.js

@@ -1 +1,11 @@
-module.exports = require('./lib/StonksCollection');
+const finviz = require('@stonksjs/finviz');
+const quote = require('@stonksjs/quote');
+const stockScreener = require('@stonksjs/stock-screener');
+const robinhoodCollections = require('@stonksjs/robinhood-collections');
+
+module.exports = {
+  finviz,
+  quote,
+  stockScreener,
+  robinhoodCollections,
+};