@ovh-ux/component-rollup-config
Extensible rollup configuration to build OVH components
Last updated a day ago by ovh-ux-cds .
BSD-3-Clause · Repository · Original npm · Tarball · package.json
$ cnpm install @ovh-ux/component-rollup-config 
SYNC missed versions from official npm registry.

Component rollup config

Extensible rollup configuration to build OVH components.

Downloads Dependencies Dev Dependencies Gitter

Install

yarn add -D @ovh-ux/component-rollup-config

Usage

import configGenerator from '@ovh-ux/component-rollup-config';

// generate your configuration with global options
const config = configGenerator({
  input: './src/my-library.js',
});

// export desired list of target(s)
export default [

  // ES6 module
  config.es(),

  // CommonJS
  config.cjs(),

  // UMD (Universal Module Definition)
  config.umd({
    output: {
      globals: {
        angular: 'angular',
        jquery: '$',
      },
    },
  }),

  // IIFE (Immediately Invoked Function Expression)
  config.iife({
    output: {
      globals: {
        angular: 'angular',
        jquery: '$',
      },
    },
  }),
];

Plugins

This configuration provides some plugins to facilitate loading and importing of ovh translations ; as well as a plugin to facilitate less imports.

translation-xml

Convert translation XML files to JavaScript.

<translations>
  <translation id="foo" qtlid="1">Foo</translation>
  <translation id="bar" qtlid="2">Bar</translation>
</translations>
export default { foo: 'Foo', bar: 'Bar' };

translation-ui-router

Handle translations property in ui-router state declaration to dynamically load ovh translations when state is resolved.

// will import `./translations` and `../common/translations` during ui-router state resolve
$stateProvider.state('my-state', {
  url: 'some-template.html',
  translations: ['.', '../common'],
});

translation-inject

Handle @ngTranslationsInject comment in order to facilitate dynamic import of ovh translations.

The format is as follows: @ngTranslationsInject:{format} [translations]

format is a string which represent the format of translations files (xml, json, ...) translations is multiple strings separated by a space

// Load .translations and ../common/translations in xml
angular
  .module('myModule', [])
  .run(/* @ngTranslationsInject ./translations ../common/translations */);

// Load .translations and ../common/translations in xml
angular
  .module('myModule', [])
  .run(/* @ngTranslationsInject:xml ./translations ../common/translations */);

// Load .translations and ../common/translations in json
angular
  .module('myModule', [])
  .run(/* @ngTranslationsInject:json ./translations ../common/translations */);
import angular from 'angular';

class MyController {
  /* @ngInject */
  constructor($injector) {
    this.$injector = $injector;
  }

  $onInit() {
    this.isLoading = true;
    return this.$injector.invoke(
      /* @ngTranslationsInject ./translations ./some/other/path */
    ).finally(() => {
      this.isLoading = false;
    });
  }
}

angular
  .module('myModule', [])
  .controller('myController', MyController);

rollup-plugin-less-tilde-importer

Provides ~ (tilde) prefix to tell less compiler that it should resolve imports using a configured array of paths.

import configGenerator from '@ovh-ux/component-rollup-config';

const config = configGenerator({
  input: './src/my-library.js',
}, {
  lessTildeImporter: {
    paths: [
      '/foo/bar',
      '/hello/world',
    ],
  },
});

export default [
  config.cjs(),
];
// try importing bootstrap from '/foo/bar/bootstrap' then from '/hello/world/bootstrap'
@import '~bootstrap';

Performance

Regarding the translations related plugins, it's possible to only process translations files for a single language. Please refer to the example below. This can be useful if you want faster builds in your development environment for example.

import configGenerator from '@ovh-ux/component-rollup-config';

const config = configGenerator({
  input: './src/my-library.js',
}, {
  translations: {
    languages: ['fr_FR', 'en_EN'], // only FR and EN translations will be provided
  },
});

export default [
  config.cjs(),
];

You can also specify languages without modifying your rollup config by using the cli and passing the LANGUAGES environment variable. See the example below.

rollup -c --environment LANGUAGES:fr_FR
rollup -c --environment LANGUAGES:fr_FR-en_GB-en_US

Test

yarn test

Related

Contributing

Always feel free to help out! Whether it's filing bugs and feature requests or working on some of the open issues, our contributing guide will help get you started.

License

BSD-3-Clause © OVH SAS

Current Tags

  • 7.0.0                                ...           latest (a day ago)

37 Versions

  • 7.0.0                                ...           a day ago
  • 6.0.2                                ...           2 months ago
  • 6.0.1 [deprecated]           ...           3 months ago
  • 6.0.0                                ...           3 months ago
  • 5.2.2                                ...           3 months ago
  • 5.2.1                                ...           3 months ago
  • 5.2.0                                ...           3 months ago
  • 5.1.0                                ...           4 months ago
  • 5.0.3                                ...           4 months ago
  • 5.0.2                                ...           4 months ago
  • 5.0.1                                ...           6 months ago
  • 5.0.0                                ...           6 months ago
  • 5.0.0-beta.9                                ...           8 months ago
  • 5.0.0-beta.8                                ...           8 months ago
  • 5.0.0-beta.7                                ...           8 months ago
  • 5.0.0-beta.6                                ...           8 months ago
  • 5.0.0-beta.5                                ...           9 months ago
  • 5.0.0-beta.4                                ...           9 months ago
  • 5.0.0-beta.3                                ...           10 months ago
  • 5.0.0-beta.2                                ...           10 months ago
  • 5.0.0-beta.1                                ...           a year ago
  • 5.0.0-beta.0                                ...           a year ago
  • 4.0.1                                ...           a year ago
  • 4.0.0                                ...           a year ago
  • 3.0.1                                ...           a year ago
  • 3.0.0                                ...           a year ago
  • 2.1.5                                ...           a year ago
  • 2.1.4                                ...           a year ago
  • 2.1.3                                ...           a year ago
  • 2.1.2                                ...           a year ago
  • 2.1.1                                ...           a year ago
  • 2.1.0                                ...           a year ago
  • 2.0.0                                ...           a year ago
  • 1.1.2                                ...           a year ago
  • 1.1.1                                ...           a year ago
  • 1.1.0                                ...           a year ago
  • 1.0.0                                ...           a year ago

Copyright 2014 - 2017 © taobao.org |