mago
Process files or data strings using language processors.
Last updated 6 years ago by albertobeloni .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install mago 
SYNC missed versions from official npm registry.

Mago

Process files or data strings using language processors.

Why?

Because each language processor utilizes a different API for processing data and files. Why not use a library that handles it for you?

Features

Mago works with files and data strings. It's built to be simple, so it will not iterate over an array of files or clean up strings, you can do that the way you prefer before passing it to mago.

Mago utilizes the file extension to determine wich processors will be used, so if you are passing data strings you will need to provide the extension.

Current supported processors

Right now Mago works with:

  • Autoprefixer;
  • CoffeScript;
  • Jade;
  • Markdown;
  • Rework;
  • Sass.

Examples

Processing a Markdown file:

### Example

This is a Markdown example file.
var mago = require("mago");

mago.process("path/to/file.md", function(error, finalData, finalExtension) {

	if (error) {
		console.error(error);
	}

	console.log(finalData);
});
<h1>Examples</h1>

<p>This is a Markdown example file.</p>

Processing a Markdown data string:

var filesystem = require("fs");
var mago = require("mago");

var data = filesystem.readFileSync("path/to/file.md").toString();

mago.processData(data, "md", function(error, finalData, finalExtension) {

	if (error) {
		console.error(error);
	}

	console.log(finalData);
});

Installation

npm install --save mago

A.P.I.

canProcess(extension)

You can run any file or data string through Mago, if it can't be processed Mago will return the original content. But if for some reason you need to know beforehand if a given file will be processed, then canProcess is your friend.

process(file, callback)

Receives a file path, determines its extension, reads the file and passes its contents to be processed by processData.

processData(data, extension, callback)

Receives a data string and run it through all processors registered for its extension.

License

The MIT License (MIT)

Copyright (c) 2014 Alberto Beloni contact@albertobeloni.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Current Tags

  • 0.2.0                                ...           latest (6 years ago)

2 Versions

  • 0.2.0                                ...           6 years ago
  • 0.1.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 1
Last Week 0
Last Month 0
Dependencies (10)
Dev Dependencies (0)
None
Dependents (1)

Copyright 2014 - 2017 © taobao.org |