Coder Social home page Coder Social logo

Agrarium

Toolkit to collect information about components with microplugin infrastructure.

Usage

npm i agrarium

CLI

Put .agrarium.js config to the root of your project.

const { presetDefault, PluginDTS } = require('agrarium');

module.exports = {
    src: ['./src/components'],
    plugins: [
        presetDefault({/* options */}),
        new PluginDTS({/* options */})
    ]
};

Read more info about config here.

Run in terminal:

$ agrarium harvest --json -o data.json

Read more about CLI commands here.

Node API

const { agrarium, presetDefault, PluginDTS } = require('agrarium');

agrarium({
    src: ['./src/components'],
    plugins: [
        presetDefault({/* options */}),
        new PluginDTS({/* options */})
    ]
}); // -> Readable Stream

Read more about NodeJS usage here.

Plugins

Not enough? Build your own plugin!

Presets

Examples

Build your own plugin

const { Plugin } = require('agrarium');

class AwesomePlugin extends Plugin {
    async gather({ key, files }) {
        return { filesQty: files.length };
    }
}

agrarium({
    src: ['./src/components' ],
    plugins: [
        new AwesomePlugin()
    ]
}).on('data', ({ key, files, data }) => {
    console.log(data); // { filesQty }
}).resume();

Read more about plugins API here.

License MIT

Agrarium's Projects

agrarium icon agrarium

Tool for transform information with JS plugins.

jsoak icon jsoak

JS tree based on AST and JSDoc

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.