open-index/open-npm huggingface dataset:
npm package: @ngirl/eslint-config
Description: Extensible code style guide for Naughty Girl
Author: Jeffrey Carpenter
Latest version: 1.5.3

# @ngirl/eslint-config-ngirl

[![NPM](https://nodei.co/npm/@ngirl/eslint-config-ngirl.png)](https://npmjs.org/package/@ngirl/eslint-config-ngirl)

This package provides the Naughty Girl project's `.eslintrc` as an extensible
shared configuration across all of the project modules.

## Usage

```shell
yarn add @ngirl/eslint-config-ngirl@latest -D
```

1. The correct peer dependency versions listed in this package must be
installed in **your** project's directory.

1a. Manually install the list of peer dependencies given when querying the npm
registry.

```shell
npm info @ngirl/eslint-config-ngirl peerDependencies
```

1b. Use a npm package, such as `install-peerdeps` that assists in installing
peer dependencies.

```shell
npm install -g install-peerdeps
install-peerdeps --yarn --only-peers --dev @ngirl/eslint-config-ngirl
```

1c. Or, via npx to avoid permanently installing `install-peerdeps`.

```shell
npx install-peerdeps --yarn --only-peers --dev @ngirl/eslint-config-ngirl
```

1d. Or, use the provided helper script to mimic the above process.

```shell
DRY_RUN=1 bin/install-peerdeps.js
```

1. Add `"extends": "@ngirl/eslint-config-ngirl"` to your project's
`.eslintrc` config.

## Cheat Sheet

```js
/* eslint no-undef: ['off'] */
/* eslint no-undef: ['error'] */
/* eslint-disable no-alert */
/* eslint-disable no-alert, no-console */
/* eslint-enable no-alert, no-console */
/* eslint-disable */
/* eslint-enable */
// eslint-disable-line
// eslint-disable-next-line
```

## References

- <https://github.com/eslint/eslint>
    - <http://eslint.org/docs/rules/>

- <https://gist.github.com/cletusw/e01a85e399ab563b1236>
    - <https://gist.githubusercontent.com/cletusw/e01a85e399ab563b1236/raw/1d10c27a505f0fba1ea9bfd60313f00ea57639b1/.eslintrc>

- <https://github.com/benmosher/eslint-plugin-import>
    - <https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules>

- <https://github.com/nodesecurity/eslint-plugin-security>
    - <https://github.com/nodesecurity/eslint-plugin-security/tree/master/rules>

## Projects Using @ngirl/eslint-config-ngirl

- [@ngirl/naughty.im](https://git.imbue.studio/ngirl/naughty.im/)
- [@ngirl/api.naughty.im](https://git.imbue.studio/ngirl/api.naughty.im/)
- [@ngirl/cdn.naughty.im](https://git.imbue.studio/ngirl/cdn.naughty.im/)
- [@ngirl/db-models](https://git.imbue.studio/ngirl/naughty.im/modules/db-models/)
- [@ngirl/nom-utils](https://git.imbue.studio/ngirl/naughty.im/modules/nom-utils/)
npm package: @ngirl/eslint-config-ngirl
Description: Extensible code style guide for Naughty Girl
Author: Jeffrey Carpenter
Latest version: 1.5.2

# @ngirl/eslint-config-ngirl

[![NPM](https://nodei.co/npm/@ngirl/eslint-config-ngirl.png)](https://npmjs.org/package/@ngirl/eslint-config-ngirl)

This package provides the Naughty Girl project's `.eslintrc` as an extensible
shared configuration across all of the project modules.

## Usage

```shell
yarn add @ngirl/eslint-config-ngirl@latest -D
```

1. The correct peer dependency versions listed in this package must be
installed in **your** project's directory.

1a. Manually install the list of peer dependencies given when querying the npm
registry.

```shell
npm info @ngirl/eslint-config-ngirl peerDependencies
```

1b. Use a npm package, such as `install-peerdeps` that assists in installing
peer dependencies.

```shell
npm install -g install-peerdeps
install-peerdeps --yarn --only-peers --dev @ngirl/eslint-config-ngirl
```

1c. Or, via npx to avoid permanently installing `install-peerdeps`.

```shell
npx install-peerdeps --yarn --only-peers --dev @ngirl/eslint-config-ngirl
```

1d. Or, use the provided helper script to mimic the above process.

```shell
DRY_RUN=1 bin/install-peerdeps.js
```

1. Add `"extends": "@ngirl/eslint-config-ngirl"` to your project's
`.eslintrc` config.

## Cheat Sheet

```js
/* eslint no-undef: ['off'] */
/* eslint no-undef: ['error'] */
/* eslint-disable no-alert */
/* eslint-disable no-alert, no-console */
/* eslint-enable no-alert, no-console */
/* eslint-disable */
/* eslint-enable */
// eslint-disable-line
// eslint-disable-next-line
```

## References

- <https://github.com/eslint/eslint>
    - <http://eslint.org/docs/rules/>

- <https://gist.github.com/cletusw/e01a85e399ab563b1236>
    - <https://gist.githubusercontent.com/cletusw/e01a85e399ab563b1236/raw/1d10c27a505f0fba1ea9bfd60313f00ea57639b1/.eslintrc>

- <https://github.com/benmosher/eslint-plugin-import>
    - <https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules>

- <https://github.com/nodesecurity/eslint-plugin-security>
    - <https://github.com/nodesecurity/eslint-plugin-security/tree/master/rules>

## Projects Using @ngirl/eslint-config-ngirl

- [@ngirl/naughty.im](https://git.imbue.studio/ngirl/naughty.im/)
- [@ngirl/api.naughty.im](https://git.imbue.studio/ngirl/api.naughty.im/)
- [@ngirl/cdn.naughty.im](https://git.imbue.studio/ngirl/cdn.naughty.im/)
- [@ngirl/db-models](https://git.imbue.studio/ngirl/naughty.im/modules/db-models/)
- [@ngirl/nom-utils](https://git.imbue.studio/ngirl/naughty.im/modules/nom-utils/)
npm package: @ngirl/nom-events
Description: Key codes and symbol definitions and touch events
Author: Jeffrey Carpenter
Latest version: 0.2.7

# nom-events

Key codes and symbol definitions and touch events.

# Projects Using nom-events

- [naughty.im](https://git.imbue.studio/ngirl)

# Reference Documents

1. https://www.w3.org/TR/DOM-Level-3-Events/
1. https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code
1. https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location
1. http://api.jquerymobile.com/category/events/
npm package: @ngirl/nom-livereload
Description: Site live reload module
Author: Jeffrey Carpenter
Latest version: 0.2.0
Deprecated: This package has been deprecated and has been shelved away. Thanks for all the fish\!

# nom-livereload

A custom, pluggable server and client software for simple setup and forget of hot module reloads with modern web application [1] development. 

1. See software requirements.

## Software requirements

- Modern JavaScript (ES2015 with *JavaScript Modules*) 
- CSS Level 3+
- HTML 5.

## Usage

A local bin script -- `nom-reload` ~~~and `nom-rpc-clear-cache`~~~ -- can be
installed either as a local or global node module script with `npm install -g`.

```shell
nom-reload ws://localhost:9090
```

```shell
npm install git+https://git.imbue.studio/ngirl/nom-livereload.git#latest
```

### Import module

```js
import NomLiveReload from 'nom-livereload';
NomLiveReload(url, opts);
```

### Development

1. ~~~One-time~~~ `npm` package link. This must be ran from this package's **parent directory**.

```bash
# cd /Projects/naughty.im.git/src/app/modules/nom-livereload
npm link
```

2. ~~~One-time~~~ `jspm` package link. This must be ran from your 
**parent project root**.

```bash
# cd /Projects/naughty.im.git/
jspm link src/app/modules/nom-livereload asshats:ngirl/nom-livereload
```

3. Every modification to the source files in the `lib` directory require 
linking this module from the root project directory, 
i.e.: [ngirl/www](https://git.imbue.studio/ngirl/naughty.im.git).

```bash
npm link @ngirl/nom-livereload
``` 

4. Last, but not least, your project's web application must be restarted, 
i.e.: `pm2 restart ndev_${appName}`.

**IMPORTANT:** Local modifications made to this module's `package.json` 
require a re-link; see the depicted [BASH](https://en.wikipedia.org/wiki/Bash_(Unix_shell\)) 
shell commands outlined in steps one (1) and two (2).

### Testing

```sh
npm run test
```

### Distribution

Check the dist directory for the build results.

```sh
npm run build

```

## TODO

[TODO.md](./TODO.md)

## Roadmap

I wish for supporting hot module reloading of server-side Node.JS applications some day, too. 

# Projects using nom-livereload

- [naughty.im](https://git.imbue.studio/ngirl)

## Reference Documents

1. http://webpack.github.io/docs/hot-module-replacement.html
1. https://github.com/glenjamin/webpack-hot-middleware
1. http://pm2.keymetrics.io/docs/usage/pm2-api/
1. https://github.com/jlongster/monkey-hot-loader
1. https://github.com/jlongster/backend-with-webpack
npm package: @ngirl/nom-utils
Description: Site helper module
Author: Jeffrey Carpenter
Latest version: 0.2.5

# nom-utils

General site utility functions.

# Projects Using nom-utils

- [naughty.im](https://git.imbue.studio/ngirl)

## Usage

```shell
jspm install asshats:@ngirl/nom-utils
```

### es6 module

```js
import utils from '@ngirl/nom-utils';
import * as utils from '@ngirl/nom-utils';
```

### cjs module

```js
const utils = require('@ngirl/nom-utils').default;
```

## Reference Documents

## DataStore.js

- [node.js ](https://github.com/andrewhayward/js-config-store)
- [Google Authentication - offline web app](https://github.com/gbraad/gauth)
  - [StorageService: localStorage](https://github.com/gbraad/gauth/blob/master/js/gauth.js)
  - [FileSaver: Client Download](https://github.com/gbraad/gauth/blob/master/lib/FileSaver.js)
- Polyfills
  - [Memory Storage #1)](https://gist.github.com/remy/350433)
  - [Cookie Storage #1](https://developer.mozilla.org/en-US/docs/Web/API/Storage/LocalStorage)
  - [Cookie Storage #2](https://github.com/inexorabletash/polyfill/blob/master/obsolete/storage.js)

## TODO

- [ ] Rename `dist` to `build`.
- [ ] Relocate Markdown components outside of this project.