postcss-px-to-viewport/spec/px-to-viewport.spec.js

// To run tests, run these commands from the project root:
// 1. `npm install`
// 2. `npm test`

/* global describe, it, expect */

var postcss = require('postcss');
var pxToViewport = require('..');
var basicCSS = '.rule { font-size: 15px }';
var { filterPropList } = require('../src/prop-list-matcher');

describe('px-to-viewport', function() {
  it('should work on the readme example', function () {
    var input = 'h1 { margin: 0 0 20px; font-size: 32px; line-height: 2; letter-spacing: 1px; }';
    var output = 'h1 { margin: 0 0 6.25vw; font-size: 10vw; line-height: 2; letter-spacing: 1px; }';
    var processed = postcss(pxToViewport()).process(input).css;

    expect(processed).toBe(output);
  });

  it('should replace the px unit with vw', function () {
    var processed = postcss(pxToViewport()).process(basicCSS).css;
    var expected = '.rule { font-size: 4.6875vw }';

    expect(processed).toBe(expected);
  });

  it('should handle < 1 values and values without a leading 0', function () {
    var rules = '.rule { margin: 0.5rem .5px -0.2px -.2em }';
    var expected = '.rule { margin: 0.5rem 0.15625vw -0.0625vw -.2em }';
    var options = {
        minPixelValue: 0
    };
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });

  it('should remain unitless if 0', function () {
    var expected = '.rule { font-size: 0px; font-size: 0; }';
    var processed = postcss(pxToViewport()).process(expected).css;

    expect(processed).toBe(expected);
  });

  it('should not add properties that already exist', function () {
    var expected = '.rule { font-size: 16px; font-size: 5vw; }';
    var processed = postcss(pxToViewport()).process(expected).css;

    expect(processed).toBe(expected);
  });

  it('should not replace units inside mediaQueries by default', function() {
    var expected = '@media (min-width: 500px) { .rule { font-size: 16px } }';
    var processed = postcss(pxToViewport()).process('@media (min-width: 500px) { .rule { font-size: 16px } }').css;

    expect(processed).toBe(expected);
  })
});

describe('value parsing', function() {
  it('should not replace values in double quotes or single quotes', function () {
    var options = {
        propList: ['*']
    };
    var rules = '.rule { content: \'16px\'; font-family: "16px"; font-size: 16px; }';
    var expected = '.rule { content: \'16px\'; font-family: "16px"; font-size: 5vw; }';
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });

  it('should not replace values in `url()`', function () {
    var rules = '.rule { background: url(16px.jpg); font-size: 16px; }';
    var expected = '.rule { background: url(16px.jpg); font-size: 5vw; }';
    var processed = postcss(pxToViewport()).process(rules).css;

    expect(processed).toBe(expected);
  });

  it('should not replace values with an uppercase P or X', function () {
    var rules = '.rule { margin: 12px calc(100% - 14PX); height: calc(100% - 20px); font-size: 12Px; line-height: 16px; }';
    var expected = '.rule { margin: 3.75vw calc(100% - 14PX); height: calc(100% - 6.25vw); font-size: 12Px; line-height: 5vw; }';
    var processed = postcss(pxToViewport()).process(rules).css;

    expect(processed).toBe(expected);
  });
});

describe('unitToConvert', function() {
  it('should ignore non px values by default', function () {
    var expected = '.rule { font-size: 2em }';
    var processed = postcss(pxToViewport()).process(expected).css;

    expect(processed).toBe(expected);
  });

  it('should convert only values described in options', function () {
    var rules = '.rule { font-size: 5em; line-height: 2px }';
    var expected = '.rule { font-size: 1.5625vw; line-height: 2px }';
    var options = {
      unitToConvert: 'em'
    };
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });
});

describe('viewportWidth', function() {
  it('should should replace using 320px by default', function() {
    var expected = '.rule { font-size: 4.6875vw }';
    var processed = postcss(pxToViewport()).process(basicCSS).css;

    expect(processed).toBe(expected);
  });

  it('should replace using viewportWidth from options', function() {
    var expected = '.rule { font-size: 3.125vw }';
    var options = {
      viewportWidth: 480
    };
    var processed = postcss(pxToViewport(options)).process(basicCSS).css;

    expect(processed).toBe(expected);
  })
});

describe('unitPrecision', function () {
  it('should replace using a decimal of 2 places', function () {
    var expected = '.rule { font-size: 4.69vw }';
    var options = {
        unitPrecision: 2
    };
    var processed = postcss(pxToViewport(options)).process(basicCSS).css;

    expect(processed).toBe(expected);
  });
});

describe('viewportUnit', function() {
  it('should replace using unit from options', function() {
    var rules = '.rule { margin-top: 15px }';
    var expected = '.rule { margin-top: 4.6875vh }';
    var options = {
        viewportUnit: 'vh'
    };
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });
});

describe('fontViewportUnit', function() {
  it('should replace only font-size using unit from options', function() {
    var rules = '.rule { margin-top: 15px; font-size: 8px; }';
    var expected = '.rule { margin-top: 4.6875vw; font-size: 2.5vmax; }';
    var options = {
      fontViewportUnit: 'vmax'
    };
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });
});

describe('selectorBlackList', function () {
  it('should ignore selectors in the selector black list', function () {
    var rules = '.rule { font-size: 15px } .rule2 { font-size: 15px }';
    var expected = '.rule { font-size: 4.6875vw } .rule2 { font-size: 15px }';
    var options = {
        selectorBlackList: ['.rule2']
    };
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });

  it('should ignore every selector with `body$`', function () {
    var rules = 'body { font-size: 16px; } .class-body$ { font-size: 16px; } .simple-class { font-size: 16px; }';
    var expected = 'body { font-size: 5vw; } .class-body$ { font-size: 16px; } .simple-class { font-size: 5vw; }';
    var options = {
        selectorBlackList: ['body$']
    };
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });

  it('should only ignore exactly `body`', function () {
    var rules = 'body { font-size: 16px; } .class-body { font-size: 16px; } .simple-class { font-size: 16px; }';
    var expected = 'body { font-size: 16px; } .class-body { font-size: 5vw; } .simple-class { font-size: 5vw; }';
    var options = {
        selectorBlackList: [/^body$/]
    };
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });
});

describe('mediaQuery', function () {
  it('should replace px inside media queries if opts.mediaQuery', function() {
    var options = {
        mediaQuery: true
    };
    var processed = postcss(pxToViewport(options)).process('@media (min-width: 500px) { .rule { font-size: 16px } }').css;
    var expected = '@media (min-width: 500px) { .rule { font-size: 5vw } }';

    expect(processed).toBe(expected);
  });

  it('should not replace px inside media queries if not opts.mediaQuery', function() {
    var options = {
      mediaQuery: false
    };
    var processed = postcss(pxToViewport(options)).process('@media (min-width: 500px) { .rule { font-size: 16px } }').css;
    var expected = '@media (min-width: 500px) { .rule { font-size: 16px } }';

    expect(processed).toBe(expected);
  });

  it('should replace px inside media queries if it has params orientation landscape and landscape option', function() {
    var options = {
      mediaQuery: true,
      landscape: true
    };
    var processed = postcss(pxToViewport(options)).process('@media (orientation-landscape) and (min-width: 500px) { .rule { font-size: 16px } }').css;
    var expected = '@media (orientation-landscape) and (min-width: 500px) { .rule { font-size: 2.8169vw } }';

    expect(processed).toBe(expected);
  });
});

describe('propList', function () {
  it('should only replace properties in the prop list', function () {
    var css = '.rule { font-size: 16px; margin: 16px; margin-left: 5px; padding: 5px; padding-right: 16px }';
    var expected = '.rule { font-size: 5vw; margin: 5vw; margin-left: 5px; padding: 5px; padding-right: 5vw }';
    var options = {
        propList: ['*font*', 'margin*', '!margin-left', '*-right', 'pad']
    };
    var processed = postcss(pxToViewport(options)).process(css).css;

    expect(processed).toBe(expected);
  });

  it('should only replace properties in the prop list with wildcard', function () {
    var css = '.rule { font-size: 16px; margin: 16px; margin-left: 5px; padding: 5px; padding-right: 16px }';
    var expected = '.rule { font-size: 16px; margin: 5vw; margin-left: 5px; padding: 5px; padding-right: 16px }';
    var options = {
        propList: ['*', '!margin-left', '!*padding*', '!font*']
    };
    var processed = postcss(pxToViewport(options)).process(css).css;

    expect(processed).toBe(expected);
  });

  it('should replace all properties when prop list is not given', function () {
    var rules = '.rule { margin: 16px; font-size: 15px }';
    var expected = '.rule { margin: 5vw; font-size: 4.6875vw }';
    var processed = postcss(pxToViewport()).process(rules).css;

    expect(processed).toBe(expected);
  });
});

describe('minPixelValue', function () {
  it('should not replace values below minPixelValue', function () {
    var options = {
        propWhiteList: [],
        minPixelValue: 2
    };
    var rules = '.rule { border: 1px solid #000; font-size: 16px; margin: 1px 10px; }';
    var expected = '.rule { border: 1px solid #000; font-size: 5vw; margin: 1px 3.125vw; }';
    var processed = postcss(pxToViewport(options)).process(rules).css;

    expect(processed).toBe(expected);
  });
});

describe('exclude', function () {
  var rules = '.rule { border: 1px solid #000; font-size: 16px; margin: 1px 10px; }';
  var covered = '.rule { border: 1px solid #000; font-size: 5vw; margin: 1px 3.125vw; }';
  it('when using regex at the time, the style should not be overwritten.', function () {
    var options = {
      exclude: /\/node_modules\//
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/node_modules/main.css'
    }).css;

    expect(processed).toBe(rules);
  });

  it('when using regex at the time, the style should be overwritten.', function () {
    var options = {
      exclude: /\/node_modules\//
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/example/main.css'
    }).css;

    expect(processed).toBe(covered);
  });

  it('when using array at the time, the style should not be overwritten.', function () {
    var options = {
      exclude: [/\/node_modules\//, /\/exclude\//]
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/exclude/main.css'
    }).css;

    expect(processed).toBe(rules);
  });

  it('when using array at the time, the style should be overwritten.', function () {
    var options = {
      exclude: [/\/node_modules\//, /\/exclude\//]
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/example/main.css'
    }).css;

    expect(processed).toBe(covered);
  });
});

describe('include', function () {
  var rules = '.rule { border: 1px solid #000; font-size: 16px; margin: 1px 10px; }';
  var covered = '.rule { border: 1px solid #000; font-size: 5vw; margin: 1px 3.125vw; }';
  it('when using regex at the time, the style should not be overwritten.', function () {
    var options = {
      include: /\/mobile\//
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/pc/main.css'
    }).css;

    expect(processed).toBe(rules);
  });

  it('when using regex at the time, the style should be overwritten.', function () {
    var options = {
      include: /\/mobile\//
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/mobile/main.css'
    }).css;

    expect(processed).toBe(covered);
  });

  it('when using array at the time, the style should not be overwritten.', function () {
    var options = {
      include: [/\/flexible\//, /\/mobile\//]
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/pc/main.css'
    }).css;

    expect(processed).toBe(rules);
  });

  it('when using array at the time, the style should be overwritten.', function () {
    var options = {
      include: [/\/flexible\//, /\/mobile\//]
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/flexible/main.css'
    }).css;

    expect(processed).toBe(covered);
  });
});

describe('include-and-exclude', function () {
  var rules = '.rule { border: 1px solid #000; font-size: 16px; margin: 1px 10px; }';
  var covered = '.rule { border: 1px solid #000; font-size: 5vw; margin: 1px 3.125vw; }';

  it('when using regex at the time, the style should not be overwritten.', function () {
    var options = {
      include: /\/mobile\//,
      exclude: /\/not-transform\//
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/mobile/not-transform/main.css'
    }).css;

    expect(processed).toBe(rules);
  });

  it('when using regex at the time, the style should be overwritten.', function () {
    var options = {
      include: /\/mobile\//,
      exclude: /\/not-transform\//
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/mobile/style/main.css'
    }).css;

    expect(processed).toBe(covered);
  });

  it('when using array at the time, the style should not be overwritten.', function () {
    var options = {
      include: [/\/flexible\//, /\/mobile\//],
      exclude: [/\/not-transform\//, /pc/]
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/flexible/not-transform/main.css'
    }).css;

    expect(processed).toBe(rules);
  });

  it('when using regex at the time, the style should be overwritten.', function () {
    var options = {
      include: [/\/flexible\//, /\/mobile\//],
      exclude: [/\/not-transform\//, /pc/]
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/mobile/style/main.css'
    }).css;

    expect(processed).toBe(covered);
  });
});

describe('regex', function () {
  var rules = '.rule { border: 1px solid #000; font-size: 16px; margin: 1px 10px; }';
  var covered = '.rule { border: 1px solid #000; font-size: 5vw; margin: 1px 3.125vw; }';

  it('when using regex at the time, the style should not be overwritten.', function () {
    var options = {
      exclude: /pc/
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/pc-project/main.css'
    }).css;

    expect(processed).toBe(rules);
  });

  it('when using regex at the time, the style should be overwritten.', function () {
    var options = {
      exclude: /\/pc\//
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/pc-project/main.css'
    }).css;

    expect(processed).toBe(covered);
  });

  it('when using regex at the time, the style should not be overwritten.', function () {
    var options = {
      include: /\/pc\//
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/pc-project/main.css'
    }).css;

    expect(processed).toBe(rules);
  });

  it('when using regex at the time, the style should be overwritten.', function () {
    var options = {
      include: /pc/
    };
    var processed = postcss(pxToViewport(options)).process(rules, {
      from: '/pc-project/main.css'
    }).css;

    expect(processed).toBe(covered);
  });
});

describe('replace', function () {
  it('should leave fallback pixel unit with root em value', function () {
    var options = {
      replace: false
    };
    var processed = postcss(pxToViewport(options)).process(basicCSS).css;
    var expected = '.rule { font-size: 15px; font-size: 4.6875vw }';

    expect(processed).toBe(expected);
  });
});

describe('filter-prop-list', function () {
  it('should find "exact" matches from propList', function () {
    var propList = ['font-size', 'margin', '!padding', '*border*', '*', '*y', '!*font*'];
    var expected = 'font-size,margin';
    expect(filterPropList.exact(propList).join()).toBe(expected);
  });

  it('should find "contain" matches from propList and reduce to string', function () {
    var propList = ['font-size', '*margin*', '!padding', '*border*', '*', '*y', '!*font*'];
    var expected = 'margin,border';
    expect(filterPropList.contain(propList).join()).toBe(expected);
  });

  it('should find "start" matches from propList and reduce to string', function () {
    var propList = ['font-size', '*margin*', '!padding', 'border*', '*', '*y', '!*font*'];
    var expected = 'border';
    expect(filterPropList.startWith(propList).join()).toBe(expected);
  });

  it('should find "end" matches from propList and reduce to string', function () {
    var propList = ['font-size', '*margin*', '!padding', 'border*', '*', '*y', '!*font*'];
    var expected = 'y';
    expect(filterPropList.endWith(propList).join()).toBe(expected);
  });

  it('should find "not" matches from propList and reduce to string', function () {
    var propList = ['font-size', '*margin*', '!padding', 'border*', '*', '*y', '!*font*'];
    var expected = 'padding';
    expect(filterPropList.notExact(propList).join()).toBe(expected);
  });

  it('should find "not contain" matches from propList and reduce to string', function () {
    var propList = ['font-size', '*margin*', '!padding', '!border*', '*', '*y', '!*font*'];
    var expected = 'font';
    expect(filterPropList.notContain(propList).join()).toBe(expected);
  });

  it('should find "not start" matches from propList and reduce to string', function () {
    var propList = ['font-size', '*margin*', '!padding', '!border*', '*', '*y', '!*font*'];
    var expected = 'border';
    expect(filterPropList.notStartWith(propList).join()).toBe(expected);
  });

  it('should find "not end" matches from propList and reduce to string', function () {
    var propList = ['font-size', '*margin*', '!padding', '!border*', '*', '!*y', '!*font*'];
    var expected = 'y';
    expect(filterPropList.notEndWith(propList).join()).toBe(expected);
  });
});

describe('landscape', function() {
  it('should add landscape atRule', function() {
    var css = '.rule { font-size: 16px; margin: 16px; margin-left: 5px; padding: 5px; padding-right: 16px }';
    var expected = '.rule { font-size: 5vw; margin: 5vw; margin-left: 1.5625vw; padding: 1.5625vw; padding-right: 5vw }@media (orientation: landscape) {.rule { font-size: 2.8169vw; margin: 2.8169vw; margin-left: 0.88028vw; padding: 0.88028vw; padding-right: 2.8169vw } }';
    var options = {
      landscape: true
    };
    var processed = postcss(pxToViewport(options)).process(css).css;

    expect(processed).toBe(expected);
  });

  it('should add landscape atRule with specified landscapeUnits', function() {
    var css = '.rule { font-size: 16px; margin: 16px; margin-left: 5px; padding: 5px; padding-right: 16px }';
    var expected = '.rule { font-size: 5vw; margin: 5vw; margin-left: 1.5625vw; padding: 1.5625vw; padding-right: 5vw }@media (orientation: landscape) {.rule { font-size: 2.8169vh; margin: 2.8169vh; margin-left: 0.88028vh; padding: 0.88028vh; padding-right: 2.8169vh } }';
    var options = {
      landscape: true,
      landscapeUnit: 'vh'
    };
    var processed = postcss(pxToViewport(options)).process(css).css;

    expect(processed).toBe(expected);
  });

  it('should not add landscape atRule in mediaQueries', function() {
    var css = '@media (min-width: 500px) { .rule { font-size: 16px } }';
    var expected = '@media (min-width: 500px) { .rule { font-size: 5vw } }';
    var options = {
      landscape: true,
      mediaQuery: true
    };
    var processed = postcss(pxToViewport(options)).process(css).css;

    expect(processed).toBe(expected);
  });

  it('should not replace values inside landscape atRule', function() {
    var options = {
      replace: false,
      landscape: true
    };
    var processed = postcss(pxToViewport(options)).process(basicCSS).css;
    var expected = '.rule { font-size: 15px; font-size: 4.6875vw }@media (orientation: landscape) {.rule { font-size: 2.64085vw } }';

    expect(processed).toBe(expected);
  });

  it('should add landscape atRule with specified landscapeWidth', function() {
    var options = {
      landscape: true,
      landscapeWidth: 768
    };
    var processed = postcss(pxToViewport(options)).process(basicCSS).css;
    var expected = '.rule { font-size: 4.6875vw }@media (orientation: landscape) {.rule { font-size: 1.95313vw } }';

    expect(processed).toBe(expected);
  });

  it('should not add landscape atRule if it has no nodes', function() {
    var css = '.rule { font-size: 15vw }';
    var options = {
      landscape: true
    };
    var processed = postcss(pxToViewport(options)).process(css).css;
    var expected = '.rule { font-size: 15vw }';

    expect(processed).toBe(expected);
  });
});

describe('/* px-to-viewport-ignore */ & /* px-to-viewport-ignore-next */', function() {
  it('should ignore right-commented', function() {
    var css = '.rule { font-size: 15px; /* simple comment */ width: 100px; /* px-to-viewport-ignore */ height: 50px; }';
    var expected = '.rule { font-size: 4.6875vw; /* simple comment */ width: 100px; height: 15.625vw; }';

    var processed = postcss(pxToViewport()).process(css).css;

    expect(processed).toBe(expected);
  });

  it('should ignore right-commented in multiline-css', function() {
    var css = '.rule {\n  font-size: 15px;\n  width: 100px; /*px-to-viewport-ignore*/\n  height: 50px;\n}';
    var expected = '.rule {\n  font-size: 4.6875vw;\n  width: 100px;\n  height: 15.625vw;\n}';

    var processed = postcss(pxToViewport()).process(css).css;

    expect(processed).toBe(expected);
  });

  it('should ignore before-commented in multiline-css', function() {
    var css = '.rule {\n  font-size: 15px;\n  /*px-to-viewport-ignore-next*/\n  width: 100px;\n  /*px-to-viewport-ignore*/\n  height: 50px;\n}';
    var expected = '.rule {\n  font-size: 4.6875vw;\n  width: 100px;\n  /*px-to-viewport-ignore*/\n  height: 15.625vw;\n}';

    var processed = postcss(pxToViewport()).process(css).css;

    expect(processed).toBe(expected);
  });
});