https://github.com/jjlharrison/gulp-rtlcss

Gulp plugin that uses RTLCSS to convert LTR CSS to RTL.
https://github.com/jjlharrison/gulp-rtlcss

Last synced: 2 days ago
JSON representation

Gulp plugin that uses RTLCSS to convert LTR CSS to RTL.

• Host: GitHub
• URL: https://github.com/jjlharrison/gulp-rtlcss
• Owner: jjlharrison
• License: mit
• Created: 2014-12-21T02:39:25.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2022-12-30T23:21:56.000Z (almost 2 years ago)
• Last Synced: 2024-11-07T08:07:44.922Z (7 days ago)
• Language: JavaScript
• Size: 139 KB
• Stars: 36
• Watchers: 6
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-rtlcss

[![MIT Licence][licence-image]][licence-url] [![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][librariesio-image]][librariesio-url] [![Language grade: JavaScript][lgtm-grade-image]][lgtm-url]

[Gulp](http://gulpjs.com) plugin that uses [RTLCSS](https://github.com/MohammadYounes/rtlcss) to convert LTR CSS to RTL.

## Install

```bash

$ npm install --save-dev gulp-rtlcss

```

## Basic Usage

```js

var gulp = require('gulp');

var rtlcss = require('gulp-rtlcss');

gulp.task('default', function () {

	return gulp.src('styles.css')

		.pipe(rtlcss())

		.pipe(gulp.dest('dist'));

});

```

## Configuration

The plugin optionally accepts RTLCSS configuration either as an argument or with a file named `.rtlcssrc` or `.rtlcssrc.json`.

See the [RTLCSS documentation](https://github.com/MohammadYounes/rtlcss) for more information about accepted configuration.

## Example

The below example will result in 2 copies of each stylesheet, one LTR stylesheet and one RTL stylesheet (with "-rtl" appended to the filename before the extension). The example uses autoprefixer, this is just an example of other CSS post-processing being used before rtlcss.

```js

var gulp = require('gulp');

var autoprefixer = require('gulp-autoprefixer');

var rtlcss = require('gulp-rtlcss');

var rename = require('gulp-rename');

var sourcemaps = require('gulp-sourcemaps');

gulp.task('styles', function () {

    return gulp.src(['/styles/*.css'])

		.pipe(sourcemaps.init())

        .pipe(autoprefixer(["last 2 versions", "> 1%"])) // Other post-processing.

        .pipe(gulp.dest('dist')) // Output LTR stylesheets.

        .pipe(rtlcss()) // Convert to RTL.

        .pipe(rename({ suffix: '-rtl' })) // Append "-rtl" to the filename.

		.pipe(sourcemaps.write('dist')) // Output source maps.

        .pipe(gulp.dest('dist')); // Output RTL stylesheets.

});

```

## Change Log

See [CHANGELOG.md](CHANGELOG.md).

[librariesio-image]: https://img.shields.io/librariesio/release/npm/gulp-rtlcss

[librariesio-url]: https://libraries.io/npm/gulp-rtlcss

[npm-image]: http://img.shields.io/npm/v/gulp-rtlcss.svg?style=flat

[npm-url]: https://www.npmjs.org/package/gulp-rtlcss

[travis-image]: http://img.shields.io/travis/jjlharrison/gulp-rtlcss.svg?style=flat

[travis-url]: https://travis-ci.org/jjlharrison/gulp-rtlcss

[licence-image]: http://img.shields.io/npm/l/gulp-rtlcss.svg?style=flat

[licence-url]: https://tldrlegal.com/license/mit-license

[lgtm-grade-image]: https://img.shields.io/lgtm/grade/javascript/g/jjlharrison/gulp-rtlcss.svg?logo=lgtm&logoWidth=18

[lgtm-url]: https://lgtm.com/projects/g/jjlharrison/gulp-rtlcss/context:javascript