Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
base - npm Package Compare versions
Comparing version 1.0.1 to 2.0.0
77
index.js
| 'use strict'; | ||
| const assert = require('assert'); | ||
| const typeOf = require('kind-of'); | ||
| const define = require('define-property'); | ||
| const isObject = require('isobject'); | ||
| const pascal = require('pascalcase'); | ||
@@ -18,10 +18,11 @@ const merge = require('mixin-deep'); | ||
| /** | ||
| * Create an instance of `Base` with the given `config` and `options`. | ||
| * Create an instance of `Base` with the given `cache` and `options`. | ||
| * Learn about the [cache object](#cache-object). | ||
| * | ||
| * ```js | ||
| * // initialize with `config` and `options` | ||
| * // initialize with `cache` and `options` | ||
| * const app = new Base({isApp: true}, {abc: true}); | ||
| * app.set('foo', 'bar'); | ||
| * | ||
| * // values defined with the given `config` object will be on the root of the instance | ||
| * // values defined with the given `cache` object will be on the root of the instance | ||
| * console.log(app.baz); //=> undefined | ||
@@ -51,3 +52,6 @@ * console.log(app.foo); //=> 'bar' | ||
| this.define('registered', {}); | ||
| this.constructor.run(this, 'use', fns); | ||
| if (fns.length) { | ||
| this.use(fns); | ||
| } | ||
| } | ||
@@ -73,3 +77,3 @@ | ||
| is(type) { | ||
| assert.equal(typeof type, 'string', 'expected type to be a string'); | ||
| assert.equal(typeof type, 'string', 'expected "type" to be a string'); | ||
| if (type !== 'app') delete this.isApp; | ||
@@ -122,12 +126,14 @@ this.define('type', type.toLowerCase()); | ||
| /** | ||
| * Define a plugin function to be called immediately upon init. | ||
| * Call a plugin function or array of plugin functions on the instance. Plugins | ||
| * are called with an instance of base, and options (if defined). | ||
| * | ||
| * ```js | ||
| * const app = new Base() | ||
| * .use(foo) | ||
| * .use(bar) | ||
| * .use([foo, bar]) | ||
| * .use(baz) | ||
| * ``` | ||
| * @name .use | ||
| * @param {Function} `fn` plugin function to call | ||
| * @param {String|Function|Array} `name` (optional) plugin name | ||
| * @param {Function|Array} `plugin` plugin function, or array of functions, to call. | ||
| * @param {...rest} Any additional arguments to pass to plugins(s). | ||
| * @return {Object} Returns the item instance for chaining. | ||
@@ -137,5 +143,22 @@ * @api public | ||
| use(fn) { | ||
| assert.equal(typeof fn, 'function', 'expected plugin to be a function'); | ||
| fn.call(this, this); | ||
| use(...rest) { | ||
| let name = null; | ||
| let fns = null; | ||
| if (typeof rest[0] === 'string') { | ||
| name = rest.shift(); | ||
| } | ||
| if (typeof rest[0] === 'function' || Array.isArray(rest[0])) { | ||
| fns = rest.shift(); | ||
| } | ||
| if (Array.isArray(fns)) return fns.forEach(fn => this.use(fn, ...rest)); | ||
| assert.equal(typeof fns, 'function', 'expected plugin to be a function'); | ||
| if (typeof name === 'string' && this.isRegistered(name)) { | ||
| return this; | ||
| } | ||
| fns.call(this, this, ...rest); | ||
| return this; | ||
@@ -149,6 +172,4 @@ } | ||
| * ```js | ||
| * // arbitrary `render` function using lodash `template` | ||
| * app.define('render', function(str, locals) { | ||
| * return _.template(str)(locals); | ||
| * }); | ||
| * // example of a custom arbitrary `render` function created with lodash's `template` method | ||
| * app.define('render', (str, locals) => _.template(str)(locals)); | ||
| * ``` | ||
@@ -163,3 +184,3 @@ * @name .define | ||
| define(key, val) { | ||
| if (isObject(key)) { | ||
| if (typeOf(key) === 'object') { | ||
| return this.visit('define', key); | ||
@@ -234,23 +255,5 @@ } | ||
| /** | ||
| * Run an array of functions by passing each function | ||
| * to a method on the given object specified by the given property. | ||
| * | ||
| * @param {Object} `target` Object containing method to use. | ||
| * @param {String} `key` Name of the method to call | ||
| * @param {Array} `arr` Array of functions to pass to the method. | ||
| * Delete static mixin method from cache-base, JIT | ||
| */ | ||
| static run(target, key, arr) { | ||
| assert.equal(typeof key, 'string', 'expected key to be a string'); | ||
| let len = arr.length, i = 0; | ||
| while (len--) { | ||
| target[key](arr[i++]); | ||
| } | ||
| return this; | ||
| } | ||
| /** | ||
| * Remove static mixin method from emitter | ||
| */ | ||
| static get mixin() { | ||
@@ -257,0 +260,0 @@ return undefined; |
| { | ||
| "name": "base", | ||
| "description": "Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks", | ||
| "version": "1.0.1", | ||
| "version": "2.0.0", | ||
| "homepage": "https://github.com/node-base/base", | ||
@@ -36,3 +36,3 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)", | ||
| "define-property": "^1.0.0", | ||
| "isobject": "^3.0.1", | ||
| "kind-of": "^6.0.2", | ||
| "mixin-deep": "^1.2.0", | ||
@@ -39,0 +39,0 @@ "pascalcase": "^0.1.1" |
130
README.md
@@ -23,3 +23,5 @@ <p align="center"> | ||
| - [API](#api) | ||
| - [cache object](#cache-object) | ||
| - [Toolkit suite](#toolkit-suite) | ||
| * [What is Toolkit?](#what-is-toolkit) | ||
| - [About](#about) | ||
@@ -176,5 +178,5 @@ * [Related projects](#related-projects) | ||
| ### [Base](index.js#L42) | ||
| ### [Base](index.js#L43) | ||
| Create an instance of `Base` with the given `config` and `options`. | ||
| Create an instance of `Base` with the given `cache` and `options`. Learn about the [cache object](#cache-object). | ||
@@ -189,7 +191,7 @@ **Params** | ||
| ```js | ||
| // initialize with `config` and `options` | ||
| // initialize with `cache` and `options` | ||
| const app = new Base({isApp: true}, {abc: true}); | ||
| app.set('foo', 'bar'); | ||
| // values defined with the given `config` object will be on the root of the instance | ||
| // values defined with the given `cache` object will be on the root of the instance | ||
| console.log(app.baz); //=> undefined | ||
@@ -205,3 +207,3 @@ console.log(app.foo); //=> 'bar' | ||
| ### [.is](index.js#L69) | ||
| ### [.is](index.js#L74) | ||
@@ -225,3 +227,3 @@ Set the given `name` on `app._name` and `app.is*` properties. Used for doing lookups in plugins. | ||
| ### [.isRegistered](index.js#L104) | ||
| ### [.isRegistered](index.js#L110) | ||
@@ -260,9 +262,11 @@ Returns true if a plugin has already been registered on an instance. | ||
| ### [.use](index.js#L131) | ||
| ### [.use](index.js#L139) | ||
| Define a plugin function to be called immediately upon init. | ||
| Call a plugin function or array of plugin functions on the instance. Plugins are called with an instance of base, and options (if defined). | ||
| **Params** | ||
| * `fn` **{Function}**: plugin function to call | ||
| * `name` **{String|Function|Array}**: (optional) plugin name | ||
| * `plugin` **{Function|Array}**: plugin function, or array of functions, to call. | ||
| * **{...rest}**: Any additional arguments to pass to plugins(s). | ||
| * `returns` **{Object}**: Returns the item instance for chaining. | ||
@@ -274,8 +278,7 @@ | ||
| const app = new Base() | ||
| .use(foo) | ||
| .use(bar) | ||
| .use([foo, bar]) | ||
| .use(baz) | ||
| ``` | ||
| ### [.define](index.js#L154) | ||
| ### [.define](index.js#L177) | ||
@@ -293,9 +296,7 @@ The `.define` method is used for adding non-enumerable property on the instance. Dot-notation is **not supported** with `define`. | ||
| ```js | ||
| // arbitrary `render` function using lodash `template` | ||
| app.define('render', function(str, locals) { | ||
| return _.template(str)(locals); | ||
| }); | ||
| // example of a custom arbitrary `render` function created with lodash's `template` method | ||
| app.define('render', (str, locals) => _.template(str)(locals)); | ||
| ``` | ||
| ### [.base](index.js#L196) | ||
| ### [.base](index.js#L219) | ||
@@ -331,3 +332,3 @@ Getter/setter used when creating nested instances of `Base`, for storing a reference to the first ancestor instance. This works by setting an instance of `Base` on the `parent` property of a "child" instance. The `base` property defaults to the current instance if no `parent` property is defined. | ||
| ### [Base.use](index.js#L218) | ||
| ### [Base.use](index.js#L241) | ||
@@ -352,16 +353,43 @@ Static method for adding global plugin functions that will be added to an instance when created. | ||
| ## cache object | ||
| **Cache** | ||
| User-defined properties go on the `cache` object. This keeps the root of the instance clean, so that only reserved methods and properties on the root. | ||
| ```js | ||
| Base { cache: {} } | ||
| ``` | ||
| You can pass a custom object to use as the `cache` as the first argument to the `Base` class when instantiating. | ||
| ```js | ||
| const myObject = {}; | ||
| const Base = require('base'); | ||
| const base = new Base(myObject); | ||
| ``` | ||
| ## Toolkit suite | ||
| Base is used as the foundation for all of the applications in the [toolkit suite](https://github.com/node-toolkit/getting-started) (except for [enquirer](http://enquirer.io)): | ||
| Base is part of the [Toolkit suite](https://github.com/node-toolkit/getting-started) of applications. | ||
| **Building blocks** | ||
| ### What is Toolkit? | ||
| * [base](https://github.com/node-base/base): (you are here!) framework for rapidly creating high quality node.js applications, using plugins like building blocks. | ||
| * [templates](https://github.com/jonschlinkert/templates): API for managing template collections and rendering templates with any node.js template engine. Can be used as the basis for creating a static site generator, blog framework, documentaton system, and so on. | ||
| * [enquirer](http://enquirer.io): composable, plugin-based prompt system (Base is used in [prompt-base](https://github.com/enquirer/prompt-base), the core prompt module that powers all prompt plugins) | ||
| Toolkit is a collection of node.js libraries, applications and frameworks for helping developers quickly create high quality node.js applications, web projects, and command-line experiences. There are many other libraries on NPM for handling specific tasks, Toolkit provides the _systems_ and _building blocks_ for creating higher level workflows and processes around those libraries. | ||
| **Lifecycle** | ||
| Toolkit can be used to create a static site generator, blog framework, documentaton system, command line, task or plugin runner, and more! | ||
| Developer frameworks and command line tools that address common phases of the software development lifecycle. Each of these tools can be used entirely standalone, but they work even better together. | ||
| **Building Blocks** | ||
| The following libraries can be used as "building blocks" for creating modular applications. | ||
| * [base](https://github.com/node-base/base): (you are here!) framework for rapidly creating high quality node.js applications, using plugins like building blocks. Base serves as the foundation for several other applications in the [Toolkit suite](https://github.com/node-toolkit/getting-started). | ||
| * [templates](https://github.com/jonschlinkert/templates): Render templates with any node.js template engine, create and manage template collections. Use helpers, layouts, partials, includes... | ||
| * [enquirer](http://enquirer.io): Plugin-based prompt system for creating highly customizable command line experiences. | ||
| * [composer](https://github.com/doowb/composer): Plugin-based, async task runner. | ||
| **Lifecycle Applications** | ||
| The following applications provide workflows and automation for common phases of the software development lifecycle. Each of these tools can be used entirely standalone or bundled together. | ||
| * [generate](https://github.com/generate/generate): create projects | ||
@@ -404,50 +432,4 @@ * [assemble](https://github.com/assemble/assemble): build projects | ||
| #### key | ||
| See the [changelog](CHANGELOG.md); | ||
| Changelog entries are classified using the following labels from [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog): | ||
| * `added`: for new features | ||
| * `changed`: for changes in existing functionality | ||
| * `deprecated`: for once-stable features removed in upcoming releases | ||
| * `removed`: for deprecated features removed in this release | ||
| * `fixed`: for any bug fixes | ||
| Custom labels used in this changelog: | ||
| * `dependencies`: bumps dependencies | ||
| * `housekeeping`: code re-organization, minor edits, or other changes that don't fit in one of the other categories. | ||
| **Heads up!** | ||
| Please [let us know](../../issues) if any of the following heading links are broken. Thanks! | ||
| #### [0.12.0](https://github.com/node-base/base/compare/0.11.0...0.12.0) | ||
| **Fixed** | ||
| * ensure `__callbacks` and `super_` are non-enumberable | ||
| **Added** | ||
| * Now sets `app.type` when `app.is('foo')` is called. This allows Base instances to be used more like AST nodes, which is especially helpful with [smart plugins](https://github.com/node-base/base-plugins) | ||
| #### [0.11.0](https://github.com/node-base/base/compare/0.9.0...0.11.0) | ||
| **Major breaking changes!** | ||
| * Static `.use` and `.run` methods are now non-enumerable | ||
| #### [0.9.0](https://github.com/node-base/base/compare/0.8.0...0.9.0) | ||
| **Major breaking changes!** | ||
| * `.is` no longer takes a function, a string must be passed | ||
| * all remaining `.debug` code has been removed | ||
| * `app._namespace` was removed (related to `debug`) | ||
| * `.plugin`, `.use`, and `.define` no longer emit events | ||
| * `.assertPlugin` was removed | ||
| * `.lazy` was removed | ||
| _(Changelog generated by [helper-changelog](https://github.com/helpers/helper-changelog))_ | ||
| ### Authors | ||
@@ -467,3 +449,3 @@ | ||
| Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). | ||
| Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert). | ||
| MIT | ||
@@ -473,2 +455,2 @@ | ||
| _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on December 21, 2017._ | ||
| _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 03, 2018._ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.06%
30245
Worsened metrics
- Lines of code
- decreased by-0.42%
239
- Number of lines in readme file
- decreased by-3.9%
443
Dependency changes
+ Addedkind-of@^6.0.2
+ Addedkind-of@6.0.3(transitive)
- Removedisobject@^3.0.1