feat: initial (#1)

.gitignore

@@ -0,0 +1,25 @@
+# OS
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+.DS_Store
+._*
+
+# Editors
+*~
+*.swp
+*.tmproj
+*.tmproject
+*.sublime-*
+.idea/
+.project/
+.settings/
+.vscode/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directories
+node_modules/

LICENSE

@@ -0,0 +1,13 @@
+Copyright Brightcove, Inc.
+
+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.

README.md

@@ -1,2 +1,303 @@
 # videojs-generate-rollup-config
-Generate a standard rollup config, so that plugins don't need the same script in every repository.
+
+Currently rollup configs are the same for most plugins, but when the default config changes a bit, every repository has
+to be updated since it is a static file. This package will provide the standard config as a module, so that updates can be
+deployed much easier.
+
+
+## Installation
+
+```
+$ npm install --save-dev rollup videojs-generate-rollup-config
+```
+
+Then in your rollup config do
+
+```js
+const generateRollupConfig = require('videojs-generate-rollup-config');
+const config = generateRollupConfig();
+
+/**
+ * Now you have:
+ * - config.settings: An object containing the settings used to generate the builds.
+ * - config.builds: An object containing the generated builds, with the name of the build as the key:
+ *   - cjs
+ *   - es
+ *   - test
+ *   - browser
+ *   - minBrowser, this will be excluded by default in watch mode. See the `checkWatch` option.
+ */
+
+// Note that you have to take the values from config.builds, since rollup takes an array.
+export default Object.values(config.builds);
+```
+
+Before you exports you can customize the builds, and you can also pass options (outlined below) to customize the builds.
+
+## Options
+options that are passed as an object to the `generateRollupConfig` function.
+
+### `input`
+
+> Type: `string`
+> Default: `src/plugin.js`
+
+The entry point for your build.
+
+### `distName`
+
+> Type: `string`
+> Default: Your package name minus scope.
+
+Determines the dist file names for your build. IE:
+`@thing/videojs-foo-bar` would have a `distName` of `videojs-foo-bar` and build to `dist/videojs-foo-var.js` etc.
+
+### `exportName`
+
+> Type: `string`
+> Default: Your package name minus scope in camel case.
+
+Determines the export name for browser and test dist files of your build. IE:
+* `@thing/videojs-foo-bar` would have a `exportName` of `videojsFooBar`.
+* The `browser`/`minBrowser` dist would be exported to window as `window.videojsFooBar`.
+* The `test` dist would be exported to window as `window.videojsFooBarTests`.
+
+### `browserslist`
+
+> Type: `string|Array`
+> Default: ['defaults', 'ie 11']
+
+What browser syntax should be supported in the browser/test dist files. Can also be specified in the package.json as a top level `browserslist` key/value. See the [browserslist repo](https://github.com/browserslist/browserslist) for more information.
+
+### `checkWatch`
+
+> Type: `boolean`
+> Default: `true`
+
+Determines if we should check if rollup is in watch mode. If it is we exclude the minBrowser build to save development time.
+
+### `banner`
+
+> Type: `string`
+> Default: `/*! @name ${pkg.name} @version ${pkg.version} @license ${pkg.license} */`
+
+The banner that should be inserted to the top of all bundles. You probably should not change this from the default!
+
+### `globals`
+
+> Type: `Function`
+> Default: no default
+
+A callback to change the build globals for the rollup build before they are used.
+
+This function takes one argument and will be passed the [defaultGlobals](###defaultGlobals). This function should return
+the final globals that should be used to create the rollup build list.
+
+Example:
+
+```js
+const config = generateRollupConfig({
+  globals(defaults) {
+    return {
+      browser: Object.assign(defaults.browser, {
+        'foo-bar': 'foo',
+      }),
+      module: Object.assign(defaults.module, {
+        'foo-bar': 'foo'
+      }),
+      test: Object.assign(defaults.test, {
+        'foo-bar': 'foo'
+      }),
+    };
+  }
+})
+};
+```
+
+### `externals`
+
+> Type: `Function`
+> Default: no default
+
+A callback to change the build externals for the rollup build before they are used.
+
+This function takes one argument and will be passed the [defaultExternals](###defaultExternals). This function should return
+the final externals that should be used to create the rollup build list.
+
+> NOTE: You do not have to re-list globals in this list, all globals will be added as external automatically!
+
+Example:
+
+```js
+const config = generateRollupConfig({
+  externals(defaults) {
+    return {
+      browser: defaults.browser.concat([
+        'foo',
+      ]),
+      module: defaults.module.concat([
+        'foo'
+      ],
+      test: defaults.test.concat([
+        'foo'
+      ],
+    };
+  }
+});
+```
+
+### `plugins`
+
+> Type: `Function`
+> Default: no default
+
+A callback to change the build plugins and plugin order for the rollup build before they are used.
+
+This function takes one argument and will be passed the [defaultPlugins](###defaultPlugins). This function should return
+the final plugins that should be used to create the rollup build list.
+
+> NOTE: Plugins can be "primed", here or in the `primedPlugins` option. By default all plugins are primed later and
+>       referenced by their key in `primedPlugins`.
+
+Example:
+
+```js
+const config = generateRollupConfig({
+  plugins(defaults) {
+    return {
+      browser: defaults.browser.concat([
+        'foo',
+      ]),
+      module: defaults.module.concat([
+        'foo'
+      ],
+      test: defaults.test.concat([
+        'foo'
+      ],
+    };
+  }
+});
+```
+
+### `primedPlugins`
+
+> Type: `Function`
+> Default: no default
+
+A callback to change the primed plugins  for the rollup build before they are used.
+
+This function takes one argument and will be passed the [defaultPrimedPlugins](###defaultPrimedPlugins). This function should return
+the final primed plugins that should be used to create the rollup build list.
+
+Example:
+
+```js
+const fooPlugin = require('rollup-plugin-foo');
+const config = generateRollupConfig({
+  primedPlugins(defaults) {
+    return Object.assign(defaults, {
+      foo: fooPlugin();
+    });
+  }
+});
+```
+
+## Defaults
+
+### defaultGlobals
+An object that contains keys for `browser`, `module`, and `test` globals that will be used by default. See the code for the more info.
+
+```js
+const defaultGlobals = {
+  browser: {
+    'video.js': 'videojs',
+    'global': 'window',
+    'global/window': 'window',
+    'global/document': 'document'
+  },
+  module: {
+    'video.js': 'videojs'
+  },
+  test: {
+    'qunit': 'QUnit',
+    'qunitjs': 'QUnit',
+    'sinon': 'sinon',
+    'video.js': 'videojs'
+  }
+};
+```
+
+### defaultExternals
+An object that contains keys for `browser`, `module`, and `test` externals that will be used by default.
+
+> NOTE: that we automatically add on any of globals provided into this list, as that is the default rollup behavior.
+
+```js
+
+const defaultExternals = {
+  browser: [],
+  module: [
+    'global',
+    'global/document',
+    'global/window'
+  ],
+  test: []
+};
+```
+
+### defaultPlugins
+An object that contains keys for `browser`, `module`, and `test` plugins that will be used by default.
+
+> NOTE: The plugins are referenced as strings that will be the keys in the primedPlugins that generateRollupConfig uses.
+
+```js
+const defaultPlugins = {
+  // note that for the minBrowser build uglify will be inserted before
+  // babel.
+  browser: [
+    'resolve',
+    'json',
+    'commonjs',
+    'babel'
+  ],
+
+  module: [
+    'resolve',
+    'json',
+    'commonjs',
+    'babel'
+  ],
+
+  test: [
+    'multiEntry',
+    'resolve',
+    'json',
+    'commonjs',
+    'babel'
+  ]
+};
+```
+
+### defaultPrimedPlugins
+An object that contains primed rollup plugins
+
+```js
+const defaultPrimedPlugins = {
+  babel: babel({
+    babelrc: false,
+    exclude: 'node_modules/**',
+    presets: [
+      [presetEnv, {loose: true, modules: false, targets: {browsers: settings.browserslist}}]
+    ],
+    plugins: [
+      externalHelpers,
+      transformObjectAssign
+    ]
+  }),
+  commonjs: commonjs({sourceMap: false}),
+  json: json(),
+  multiEntry: multiEntry({exports: false}),
+  resolve: resolve({browser: true, main: true, jsnext: true}),
+  uglify: uglify({output: {comments: 'some'}}, minify)
+};
+```