Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
microplugin
Advanced tools
Readme
Keep code modularized & extensible. MicroPlugin is a lightweight drop-in plugin architecture for your JavaScript library. Plugins can declare dependencies to other plugins and can be initialized with options (in a variety of formats). It AMD-compatible and it works identically in Node.js and in a browser.
$ npm install microplugin
$ bower install microplugin
Using the provided mixin, extend your function with the API for declaring and loading plugins:
var TextEditor = function(options) {
this.initializePlugins(options.plugins);
};
MicroPlugin.mixin(TextEditor);
That's it for integration! Now you can selectively load the plugins on an instance-by-instance basis.
var editor = new TextEditor({
plugins: ['links','images']
});
The initializePlugins()
method sets up the plugin system and loads a list of plugins (with options). It accepts the list in three styles, depending on your preference.
["plugin_a","plugin_b","plugin_c"]
[
{name: "plugin_a", options: { /* ... */ }},
{name: "plugin_b", options: { /* ... */ }},
{name: "plugin_c", options: { /* ... */ }}
]
{
"plugin_a": { /* ... */ },
"plugin_b": { /* ... */ },
"plugin_c": { /* ... */ }
}
Plugins aren't extravagant—they are barebones by design. A plugin is simply a function that gets called when an instance of your object is being constructed. Within that function, you can manually override methods, set up event listeners, etc. The this
context will be the instance of your object.
MyLibrary.define("math", function(options) {
// You can return values which will be available to other plugins
// when they load the plugin via "require()". Explained more in
// the next section.
return {
random : Math.random,
sqrt : Math.sqrt,
sin2 : function(t) { return Math.pow(Math.sin(t), 2); },
cos2 : function(t) { return Math.pow(Math.sin(t), 2); }
};
});
Plugins can declare dependencies to other plugins (and use any exports they provide) through the require
function.
MyLibrary.define("calculations", function(options) {
var math = this.require("math");
var theta = math.random();
var success = math.sqrt(math.sin2(theta) + math.cos2(theta)) === 1;
alert("Does the law of sines work? " + success);
});
Sets up all methods on the function and its prototype for defining and loading plugins.
Declares a new plugin with the specified name.
Loads a plugin as a dependency and returns whatever it exports (if anything).
Initializes the plugin system and loads a list of plugins with the provided options. The "plugins" argument can be in a variety of formats.
Copyright © 2013 Brian Reavis & Contributors
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
FAQs
A lightweight plugin / dependency system for javascript libraries.
The npm package microplugin receives a total of 57,993 weekly downloads. As such, microplugin popularity was classified as popular.
We found that microplugin demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.