open-index/open-npm huggingface dataset:
npm package: @freewheel/eslint-plugin-modulajs
Description: Custom ESLint rules for modulajs
Author: eng-ui@freewheel.tv
Latest version: 1.2.0

# eslint-plugin-modulajs

[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coverage-image]][coverage-url]
[![Node version][node-image]][node-url]
[![Apache V2 License][apache-2.0]](LICENSE)

This plugin contains any custom eslint rules for use in development on the [modulajs](https://www.npmjs.com/package/modulajs).

## Installation

Prerequisites: Node.js (>=6.0), npm version 3+.

```sh
npm install --save-dev eslint eslint-plugin-modulajs
```

## Usage

Add `modulajs` to the plugins section of ESLint config:
```js
{
  "plugins": [
    "modulajs"
  ]
}
```

## Rules

### `createmodel-attrs-order` <sub>Stylistic Issues</sub>

This rule enforces the order of the keys in the object that is the argument to `createModel`.

Please go to this link [createmodel-attrs-order](docs/rules/createmodel-attrs-order.md) for more details.

### `gettext-params` <sub>Possible Errors</sub>

Note: please ignore this if you are not using `gettext` as I18n solution, [in future we might move this as a separated rule](https://github.com/freewheel/eslint-plugin-modulajs/issues/3).

This rule validates that the proper arguments are provided to the `gettext` family functions.

Please go to this link [gettext-params](docs/rules/gettext-params.md) for more details.

### `no-mutable-event-types-payload-in-models` <sub>Best Practices</sub>
this rule forbid mutable objects in eventTypes/watchEventTypes payload defination.

Please go to this link [no-mutable-event-types-payload-in-models](docs/rules/no-mutable-event-types-payload-in-models.md) for more details.

### `no-mutable-prop-types-in-models` <sub>Best Practices</sub>

By default, this rule checks for the following object-types within the `propTypes` definition in `createModel`.

Please go to this link [no-mutable-prop-types-in-models](docs/rules/no-mutable-prop-types-in-models.md) for more details.

### `use-function-in-model-defaults` <sub>Possible Errors</sub>

This rule validates that any non-primitive prop's default value defined in Model `defaults` should be defined with function.

Please go to this link [use-function-in-model-defaults](docs/rules/use-function-in-model-defaults.md) for more details.

## Contributing

Please read our [contributing guide](CONTRIBUTING.md) for details on how to contribute to our project.

## License

[Apache-2.0](LICENSE)

[npm-url]: https://www.npmjs.com/package/eslint-plugin-modulajs
[npm-image]: https://img.shields.io/npm/v/eslint-plugin-modulajs.svg

[travis-url]: https://travis-ci.org/freewheel/eslint-plugin-modulajs
[travis-image]: https://img.shields.io/travis/freewheel/eslint-plugin-modulajs/master.svg

[coverage-url]: https://coveralls.io/github/freewheel/eslint-plugin-modulajs
[coverage-image]: https://img.shields.io/coveralls/freewheel/eslint-plugin-modulajs/master.svg

[node-url]: https://nodejs.org
[node-image]: https://img.shields.io/node/v/eslint-plugin-modulajs.svg 

[apache-2.0]: http://img.shields.io/badge/license-Apache%20V2-blue.svg
npm package: @freewheel/external-requires-webpack-plugin
Description: A webpack plugin to expose modules so that they could be required externally
Author: eng-ui@freewheel.tv
Latest version: 1.1.0

# External Require Webpack Plugin
[![NPM version][npm-image]][npm-url]
[![Apache V2 License][apache-2.0]](LICENSE)

A webpack plugin to expose modules so that user could require them externally.

## Installation

Prerequisites: Node.js (>=4.x), npm version 2+.

```sh
npm install --save-dev external-requires-webpack-plugin
```

## Basic Usage

```js
var ExternalRequiresPlugin = require('external-requires-webpack-plugin');
var keys = require('lodash/keys');

var VENDORS = keys(packageJson.dependencies);

// ...
  plugins: [
    new ExternalRequiresPlugin({
      vendor: VENDORS,
      moduleA: ['pathA', 'pathB'],
      ...
    })
  ]
// ...
```

## Contributing

Please read our [contributing guide](CONTRIBUTING.md) for details on how to contribute to our project.

## License

[Apache-2.0](LICENSE)

[npm-url]: https://www.npmjs.com/package/external-requires-webpack-plugin
[npm-image]: https://img.shields.io/npm/v/external-requires-webpack-plugin.svg
[apache-2.0]: http://img.shields.io/badge/license-Apache%20V2-blue.svg
npm package: @freewheel/file-watcher-webpack-plugin
Description: A webpack plugin to simply force livereload on watched files
Author: eng-ui@freewheel.tv
Latest version: 1.2.0

# Simple Watcher Webpack Plugin
[![NPM version][npm-image]][npm-url]
[![Apache V2 License][apache-2.0]](LICENSE)

A webpack plugin tries to force livereload on watched files.

## Installation

Prerequisites: Node.js (>=4.x), npm version 2+.

```sh
npm install --save-dev simple-watcher-webpack-plugin
```

## Basic Usage

```js
var SimpleWatcherPlugin = require('simple-watcher-webpack-plugin');

// ...
  plugins: [
    new SimpleWatcherPlugin({
      pattern: '**/__tests__/*.*'
    })
  ]
// ...
```

## Options

`SimpleWatcherPlugin` takes following options:

```js
new SimpleWatcherPlugin({
  // pattern of path that needs to be watched
  // the same as `[chokidar.watch](https://github.com/paulmillr/chokidar)`
  pattern: '**/__tests__/*.*',

  // Provide if you are using a liveReload, we will force clear the `lastHash`
  liveReload: null
})
```

## Contributing

Please read our [contributing guide](CONTRIBUTING.md) for details on how to contribute to our project.

## License

[Apache-2.0](LICENSE)

[npm-url]: https://www.npmjs.com/package/simple-watcher-webpack-plugin
[npm-image]: https://img.shields.io/npm/v/simple-watcher-webpack-plugin.svg
[apache-2.0]: http://img.shields.io/badge/license-Apache%20V2-blue.svg
npm package: @freewheel/modulajs-router
Description: Manage router states in Model of modulajs
Author: eng-ui@freewheel.tv
Latest version: 1.0.0

# Modulajs Router

[![NPM version][npm-image]][npm-url]
[![Apache V2 License][apache-2.0]](LICENSE)

Manage router states in Model of [modulajs](https://www.npmjs.com/package/modulajs).

## Installation

```sh
yarn add modulajs-router
```

Or use NPM

```sh
npm install --save modulajs-router
```

## High Order Model

ModulaJS Router provides a high order helper `withRouterModel` to initialize the routing in Model tree.

TBD

## Routes

### `simpleRoute`

TBD

### `contextSwitchRoute`

TBD

### `booleanRoute`

TBD

### `redirectRoute`

TBD

### Parameters in routes

TBD

## Contributing

Please read our [contributing guide](CONTRIBUTING.md) for details on how to contribute to our project.

## License

[Apache-2.0](LICENSE)

[npm-url]: https://www.npmjs.com/package/modulajs-router
[npm-image]: https://img.shields.io/npm/v/modulajs-router.svg
[apache-2.0]: http://img.shields.io/badge/license-Apache%20V2-blue.svg