diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..e99c7f5 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,11 @@ +root = true + +[*] +indent_style = space +indent_size = 4 +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false \ No newline at end of file diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..c228f00 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,19 @@ +{ + "extends": "eslint:recommended", + "env": { + "node": true + }, + "parserOptions": { + "ecmaVersion": 6, + "sourceType": "module", + "ecmaFeatures": { + } + }, + "rules": { + "semi": 2 + }, + "globals": { + "Promise": 1, + "panto": 1 + } +} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..05e43f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +*DS_Store +._* +*.swp +*.pyc +node-debug.log +npm-debug.log +node_modules +bower_components +.svn diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..8b5e138 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,10 @@ +language: node_js +before_install: + - npm install -g eslint +sudo: false +node_js: + - 6 + - stable +after_script: + - npm install -g istanbul + - npm run coveralls \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..028c34e --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# panto-transformer-stylus +[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Coverage Status][coveralls-image]][coveralls-url] + +Stylus transformer for panto. + +```js +panto.loadTransformer('stylus'); + +panto.$('**/*.styl').stylus(); +``` + +## options + - use: Function, see + +[npm-url]: https://npmjs.org/package/panto-transformer-stylus +[downloads-image]: http://img.shields.io/npm/dm/panto-transformer-stylus.svg +[npm-image]: http://img.shields.io/npm/v/panto-transformer-stylus.svg +[travis-url]: https://travis-ci.org/pantojs/panto-transformer-stylus +[travis-image]: http://img.shields.io/travis/pantojs/panto-transformer-stylus.svg +[david-dm-url]:https://david-dm.org/pantojs/panto-transformer-stylus +[david-dm-image]:https://david-dm.org/pantojs/panto-transformer-stylus.svg +[david-dm-dev-url]:https://david-dm.org/pantojs/panto-transformer-stylus#type=dev +[david-dm-dev-image]:https://david-dm.org/pantojs/panto-transformer-stylus/dev-status.svg +[coveralls-image]:https://coveralls.io/repos/github/pantojs/panto-transformer-stylus/badge.svg?branch=master +[coveralls-url]:https://coveralls.io/github/pantojs/panto-transformer-stylus?branch=master diff --git a/index.js b/index.js new file mode 100644 index 0000000..afa0441 --- /dev/null +++ b/index.js @@ -0,0 +1,54 @@ +/** + * Copyright (C) 2016 pantojs.xyz + * index.js + * + * changelog + * 2016-09-02[09:47:14]:revised + * + * @author yanni4night@gmail.com + * @version 0.1.0 + * @since 0.1.0 + */ +'use strict'; +const Transformer = require('panto-transformer'); +const stylus = require('stylus'); +const path = require('path'); + +class StylusTransformer extends Transformer { + _transform(file) { + const { + content, + filename + } = file; + + const use = this.options.use || (() => {}); + + return new Promise((resolve, reject) => { + const sty = stylus(content); + + sty.set('filename', filename).use(use); + + const deps = sty.deps().map(dep => { + return path.relative(panto.getOption('cwd'),dep); + }); + + panto.reportDependencies(filename, ...deps); + + sty.render((err, css) => { + if (err) { + return reject(err); + } else { + return resolve(panto._.extend(file, { + content: css + })); + } + + }); + }); + } + isTorrential() { + return false; + } +} + +module.exports = StylusTransformer; diff --git a/package.json b/package.json new file mode 100644 index 0000000..55cd898 --- /dev/null +++ b/package.json @@ -0,0 +1,41 @@ +{ + "name": "panto-transformer-stylus", + "version": "0.1.0", + "description": "Stylus transformer for panto", + "main": "index.js", + "scripts": { + "test": "eslint src index.js && ./node_modules/.bin/mocha", + "coveralls": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage", + "prepublish": "npm run test" + }, + "pre-commit": "test", + "repository": { + "type": "git", + "url": "https://github.com/pantojs/panto-transformer-stylus.git" + }, + "keywords": [ + "panto", + "stylus", + "transformer" + ], + "engines": { + "node": ">=6.0.0" + }, + "author": "yanni4night@gmail.com", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/pantojs/panto-transformer-stylus/issues" + }, + "homepage": "https://github.com/pantojs/panto-transformer-stylus", + "dependencies": { + "panto-transformer": "^0.2.4", + "stylus": "^0.54.5" + }, + "devDependencies": { + "panto": "0.0.33", + "coveralls": "^2.11.9", + "mocha": "^3.0.2", + "mocha-lcov-reporter": "^1.2.0", + "pre-commit": "^1.1.3" + } +} diff --git a/test/fixtures/b.styl b/test/fixtures/b.styl new file mode 100644 index 0000000..ce12cd8 --- /dev/null +++ b/test/fixtures/b.styl @@ -0,0 +1 @@ +$blue = blue diff --git a/test/test.js b/test/test.js new file mode 100644 index 0000000..bf03d19 --- /dev/null +++ b/test/test.js @@ -0,0 +1,58 @@ +/** + * Copyright (C) 2016 pantojs.xyz + * test.js + * + * changelog + * 2016-09-02[09:47:14]:revised + * + * @author yanni4night@gmail.com + * @version 0.1.0 + * @since 0.1.0 + */ +'use strict'; +const assert = require('assert'); +const panto = require('panto'); +const StylusTransformer = require('../'); + +describe('panto-transformer-stylus', () => { + describe('#transform', () => { + it('basic transpiler', done => { + new StylusTransformer().transform({ + filename: 'a.styl', + content: ` +body + color: red +` + }).then(file => { + assert.deepEqual(file.content, 'body {\n color: #f00;\n}\n'); + }).then(() => done()).catch(e => console.error(e)); + }); + it('"use" option', done => { + + panto.setOptions({ + cwd: __dirname, + src: '.' + }); + const ddeps = []; + panto.reportDependencies = (filename, ...deps) => { + ddeps.push(...deps); + }; + + new StylusTransformer({ + use: style => { + style.set('paths', [__dirname + '/fixtures']); + } + }).transform({ + filename: 'a.styl', + content: ` +@import "b" +body + color: $blue +` + }).then(file => { + assert.deepEqual(file.content, 'body {\n color: #00f;\n}\n'); + assert.deepEqual(ddeps, ['fixtures/b.styl']); + }).then(() => done()).catch(e => console.error(e)); + }); + }); +});