esrol-autoloader - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

example/app.js

 'use strict';
-var Autoloader = require ('../index.js');
-var settings = {
+let Autoloader = require ('esrol-autoloader');
+let settings = {
   getNamespaces: true,
@@ -9,7 +9,7 @@ getAsObject: true,
 };
-var folders = new Autoloader(settings);
-// console.log (folders) ->>
-// { app: 
+let folders = new Autoloader(settings);
+console.log(folders);
+// { app:
 //    { controllers: { foo: [Function: Foo] },
 //      routes: { baz: [Object], foo: [Function: Foo] } },
 //   namespaces: [ 'controllers.foo', 'routes.baz.bar', 'routes.foo' ] }

index.js

 'use strict';
-module.exports = require('./lib/index');
+module.exports = require('./lib/autoloader');

package.json

 {
   "name": "esrol-autoloader",
-  "description": "later",
-  "version": "0.0.2",
+  "description": "An Autoloader Class for automatically including files.",
+  "version": "0.0.3",
   "homepage": "https://github.com/esrol/esrol-autoloader",
-  "keywords": [],
+  "keywords": ["module", "autoloading", "esrol", "autoloader"],
   "main": "index.js",
@@ -14,8 +14,2 @@ "author": "Ivaylo Ivanov <[e-mail]>",
   },
-  "config": {
-    "blanket": {
-      "pattern": ["index.js"],
-      "data-cover-never": "node_modules"
-    }
-  },
   "repository": {
@@ -22,0 +16,0 @@ "type": "git",

README.md

@@ -1,1 +0,64 @@
-Part of esrol decoupling procedure.
+[![NPM version][npm-image]][npm-url]
+[![Build Status][travis-image]][travis-url]
+[![Test coverage][coveralls-image]][coveralls-url]
+
+# esrol-autoloader
+An Autoloader Class for automatically including files.
+
+## Installation
+
+```sh
+$ npm install --save esrol-autoloader
+```
+## Node Version Compatibility
+
+| Node Version |
+| ---- |
+| >= 4.x |
+
+## Usage
+
+```js
+'use strict';
+let Autoloader = require ('esrol-autoloader');
+let settings = {
+  getNamespaces: true, //boolean - get path as namespace
+  getAsObject: true, // boolean - get file as object
+  path: __dirname + '/app', // path to file
+  filesToSkip: ['controllers.skipMe', 'routes.skipMe'] // array - which files 
+};
+let folders = new Autoloader(settings);
+console.log(folders);
+// { app:
+//    { controllers: { foo: [Function: Foo] },
+//      routes: { baz: [Object], foo: [Function: Foo] } },
+//   namespaces: [ 'controllers.foo', 'routes.baz.bar', 'routes.foo' ] }
+```
+
+<a name="Autoloader"></a>
+## Autoloader
+<a name="new_Autoloader_new"></a>
+### new Autoloader()
+An Autoloader Class for automatically including files.
+
+## Tests
+
+  To run the test suite, first install the dependencies, then run `npm test`:
+
+```bash
+$ npm install
+$ npm test
+```
+
+## License
+
+[MIT](https://github.com/esrol/esrol-autoloader/blob/master/LICENSE)
+
+
+
+[npm-image]: https://badge.fury.io/js/esrol-autoloader.svg
+[npm-url]: https://npmjs.org/package/esrol-autoloader
+[travis-image]: https://travis-ci.org/esrol/esrol-autoloader.svg?branch=master
+[travis-url]: https://travis-ci.org/esrol/esrol-autoloader
+[coveralls-image]: https://coveralls.io/repos/esrol/esrol-autoloader/badge.svg
+[coveralls-url]: https://coveralls.io/r/esrol/esrol-autoloader

TODO.md

 #To do
-- [ ] Set comments
-- [x] Build
-- [x] Tests
-- [ ] Coverage
-- [ ] Update readme
-- [ ] Update version
+- [ ] Better examples and documentation

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21516

40.95%

Lines of code

461

38.02%

Number of lines in readme file

64

6300%

Worsened metrics

Number of medium supply chain risk alerts

1

Infinity%

No dependency changes