kitchensink
Version:
Dispatch's awesome components and style guide
208 lines (178 loc) • 15.1 kB
JavaScript
;
exports.__esModule = true;
var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
var _warning = require('./warning');
var _warning2 = _interopRequireDefault(_warning);
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
/**
* @typedef {object} Message
* @property {string} type - message type
* @property {string} plugin - source PostCSS plugin name
*/
/**
* Provides the result of the PostCSS transformations.
*
* A Result instance is returned by {@link LazyResult#then}
* or {@link Root#toResult} methods.
*
* @example
* postcss([cssnext]).process(css).then(function (result) {
* console.log(result.css);
* });
*
* @example
* var result2 = postcss.parse(css).toResult();
*/
var Result = function () {
/**
* @param {Processor} processor - processor used for this transformation.
* @param {Root} root - Root node after all transformations.
* @param {processOptions} opts - options from the {@link Processor#process}
* or {@link Root#toResult}
*/
function Result(processor, root, opts) {
_classCallCheck(this, Result);
/**
* @member {Processor} - The Processor instance used
* for this transformation.
*
* @example
* for ( let plugin of result.processor.plugins) {
* if ( plugin.postcssPlugin === 'postcss-bad' ) {
* throw 'postcss-good is incompatible with postcss-bad';
* }
* });
*/
this.processor = processor;
/**
* @member {Message[]} - Contains messages from plugins
* (e.g., warnings or custom messages).
* Each message should have type
* and plugin properties.
*
* @example
* postcss.plugin('postcss-min-browser', () => {
* return (css, result) => {
* var browsers = detectMinBrowsersByCanIUse(css);
* result.messages.push({
* type: 'min-browser',
* plugin: 'postcss-min-browser',
* browsers: browsers
* });
* };
* });
*/
this.messages = [];
/**
* @member {Root} - Root node after all transformations.
*
* @example
* root.toResult().root == root;
*/
this.root = root;
/**
* @member {processOptions} - Options from the {@link Processor#process}
* or {@link Root#toResult} call
* that produced this Result instance.
*
* @example
* root.toResult(opts).opts == opts;
*/
this.opts = opts;
/**
* @member {string} - A CSS string representing of {@link Result#root}.
*
* @example
* postcss.parse('a{}').toResult().css //=> "a{}"
*/
this.css = undefined;
/**
* @member {SourceMapGenerator} - An instance of `SourceMapGenerator`
* class from the `source-map` library,
* representing changes
* to the {@link Result#root} instance.
*
* @example
* result.map.toJSON() //=> { version: 3, file: 'a.css', … }
*
* @example
* if ( result.map ) {
* fs.writeFileSync(result.opts.to + '.map', result.map.toString());
* }
*/
this.map = undefined;
}
/**
* Returns for @{link Result#css} content.
*
* @example
* result + '' === result.css
*
* @return {string} string representing of {@link Result#root}
*/
Result.prototype.toString = function toString() {
return this.css;
};
/**
* Creates an instance of {@link Warning} and adds it
* to {@link Result#messages}.
*
* @param {string} text - warning message
* @param {Object} [opts] - warning options
* @param {Node} opts.node - CSS node that caused the warning
* @param {string} opts.word - word in CSS source that caused the warning
* @param {number} opts.index - index in CSS node string that caused
* the warning
* @param {string} opts.plugin - name of the plugin that created
* this warning. {@link Result#warn} fills
* this property automatically.
*
* @return {Warning} created warning
*/
Result.prototype.warn = function warn(text) {
var opts = arguments.length <= 1 || arguments[1] === undefined ? {} : arguments[1];
if (!opts.plugin) {
if (this.lastPlugin && this.lastPlugin.postcssPlugin) {
opts.plugin = this.lastPlugin.postcssPlugin;
}
}
var warning = new _warning2.default(text, opts);
this.messages.push(warning);
return warning;
};
/**
* Returns warnings from plugins. Filters {@link Warning} instances
* from {@link Result#messages}.
*
* @example
* result.warnings().forEach(warn => {
* console.warn(warn.toString());
* });
*
* @return {Warning[]} warnings from plugins
*/
Result.prototype.warnings = function warnings() {
return this.messages.filter(function (i) {
return i.type === 'warning';
});
};
/**
* An alias for the {@link Result#css} property.
* Use it with syntaxes that generate non-CSS output.
* @type {string}
*
* @example
* result.css === result.content;
*/
_createClass(Result, [{
key: 'content',
get: function get() {
return this.css;
}
}]);
return Result;
}();
exports.default = Result;
module.exports = exports['default'];
//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["result.es6"],"names":[],"mappings":";;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAsBM,M;;;;;;;;;AAQF,kBAAY,SAAZ,EAAuB,IAAvB,EAA6B,IAA7B,EAAmC;AAAA;;;;;;;;;;;;;AAY/B,SAAK,SAAL,GAAiB,SAAjB;;;;;;;;;;;;;;;;;;;AAmBA,SAAK,QAAL,GAAgB,EAAhB;;;;;;;AAOA,SAAK,IAAL,GAAY,IAAZ;;;;;;;;;AASA,SAAK,IAAL,GAAY,IAAZ;;;;;;;AAOA,SAAK,GAAL,GAAW,SAAX;;;;;;;;;;;;;;;AAeA,SAAK,GAAL,GAAW,SAAX;AACH;;;;;;;;;;;;mBAUD,Q,uBAAW;AACP,WAAO,KAAK,GAAZ;AACH,G;;;;;;;;;;;;;;;;;;;;mBAkBD,I,iBAAK,I,EAAkB;AAAA,QAAZ,IAAY,yDAAL,EAAK;;AACnB,QAAK,CAAC,KAAK,MAAX,EAAoB;AAChB,UAAK,KAAK,UAAL,IAAmB,KAAK,UAAL,CAAgB,aAAxC,EAAwD;AACpD,aAAK,MAAL,GAAc,KAAK,UAAL,CAAgB,aAA9B;AACH;AACJ;;AAED,QAAI,UAAU,sBAAY,IAAZ,EAAkB,IAAlB,CAAd;AACA,SAAK,QAAL,CAAc,IAAd,CAAmB,OAAnB;;AAEA,WAAO,OAAP;AACH,G;;;;;;;;;;;;;;;mBAaD,Q,uBAAW;AACP,WAAO,KAAK,QAAL,CAAc,MAAd,CAAsB;AAAA,aAAK,EAAE,IAAF,KAAW,SAAhB;AAAA,KAAtB,CAAP;AACH,G;;;;;;;;;;;;;;wBAUa;AACV,aAAO,KAAK,GAAZ;AACH;;;;;;kBAIU,M","file":"result.js","sourcesContent":["import Warning from './warning';\n\n/**\n * @typedef  {object} Message\n * @property {string} type   - message type\n * @property {string} plugin - source PostCSS plugin name\n */\n\n/**\n * Provides the result of the PostCSS transformations.\n *\n * A Result instance is returned by {@link LazyResult#then}\n * or {@link Root#toResult} methods.\n *\n * @example\n * postcss([cssnext]).process(css).then(function (result) {\n *    console.log(result.css);\n * });\n *\n * @example\n * var result2 = postcss.parse(css).toResult();\n */\nclass Result {\n\n    /**\n     * @param {Processor} processor - processor used for this transformation.\n     * @param {Root}      root      - Root node after all transformations.\n     * @param {processOptions} opts - options from the {@link Processor#process}\n     *                                or {@link Root#toResult}\n     */\n    constructor(processor, root, opts) {\n        /**\n         * @member {Processor} - The Processor instance used\n         *                       for this transformation.\n         *\n         * @example\n         * for ( let plugin of result.processor.plugins) {\n         *   if ( plugin.postcssPlugin === 'postcss-bad' ) {\n         *     throw 'postcss-good is incompatible with postcss-bad';\n         *   }\n         * });\n         */\n        this.processor = processor;\n        /**\n         * @member {Message[]} - Contains messages from plugins\n         *                       (e.g., warnings or custom messages).\n         *                       Each message should have type\n         *                       and plugin properties.\n         *\n         * @example\n         * postcss.plugin('postcss-min-browser', () => {\n         *   return (css, result) => {\n         *     var browsers = detectMinBrowsersByCanIUse(css);\n         *     result.messages.push({\n         *       type:    'min-browser',\n         *       plugin:  'postcss-min-browser',\n         *       browsers: browsers\n         *     });\n         *   };\n         * });\n         */\n        this.messages = [];\n        /**\n         * @member {Root} - Root node after all transformations.\n         *\n         * @example\n         * root.toResult().root == root;\n         */\n        this.root = root;\n        /**\n         * @member {processOptions} - Options from the {@link Processor#process}\n         *                            or {@link Root#toResult} call\n         *                            that produced this Result instance.\n         *\n         * @example\n         * root.toResult(opts).opts == opts;\n         */\n        this.opts = opts;\n        /**\n         * @member {string} - A CSS string representing of {@link Result#root}.\n         *\n         * @example\n         * postcss.parse('a{}').toResult().css //=> \"a{}\"\n         */\n        this.css = undefined;\n        /**\n         * @member {SourceMapGenerator} - An instance of `SourceMapGenerator`\n         *                                class from the `source-map` library,\n         *                                representing changes\n         *                                to the {@link Result#root} instance.\n         *\n         * @example\n         * result.map.toJSON() //=> { version: 3, file: 'a.css', … }\n         *\n         * @example\n         * if ( result.map ) {\n         *   fs.writeFileSync(result.opts.to + '.map', result.map.toString());\n         * }\n         */\n        this.map = undefined;\n    }\n\n    /**\n     * Returns for @{link Result#css} content.\n     *\n     * @example\n     * result + '' === result.css\n     *\n     * @return {string} string representing of {@link Result#root}\n     */\n    toString() {\n        return this.css;\n    }\n\n    /**\n     * Creates an instance of {@link Warning} and adds it\n     * to {@link Result#messages}.\n     *\n     * @param {string} text        - warning message\n     * @param {Object} [opts]      - warning options\n     * @param {Node}   opts.node   - CSS node that caused the warning\n     * @param {string} opts.word   - word in CSS source that caused the warning\n     * @param {number} opts.index  - index in CSS node string that caused\n     *                               the warning\n     * @param {string} opts.plugin - name of the plugin that created\n     *                               this warning. {@link Result#warn} fills\n     *                               this property automatically.\n     *\n     * @return {Warning} created warning\n     */\n    warn(text, opts = { }) {\n        if ( !opts.plugin ) {\n            if ( this.lastPlugin && this.lastPlugin.postcssPlugin ) {\n                opts.plugin = this.lastPlugin.postcssPlugin;\n            }\n        }\n\n        let warning = new Warning(text, opts);\n        this.messages.push(warning);\n\n        return warning;\n    }\n\n    /**\n     * Returns warnings from plugins. Filters {@link Warning} instances\n     * from {@link Result#messages}.\n     *\n     * @example\n     * result.warnings().forEach(warn => {\n     *   console.warn(warn.toString());\n     * });\n     *\n     * @return {Warning[]} warnings from plugins\n     */\n    warnings() {\n        return this.messages.filter( i => i.type === 'warning' );\n    }\n\n    /**\n     * An alias for the {@link Result#css} property.\n     * Use it with syntaxes that generate non-CSS output.\n     * @type {string}\n     *\n     * @example\n     * result.css === result.content;\n     */\n    get content() {\n        return this.css;\n    }\n\n}\n\nexport default Result;\n"],"sourceRoot":"/source/"}