open-index/open-npm huggingface dataset:
npm package: @sugarcrm/eslint-config-sugarcrm
Description: ESLint configuration file used for various SugarCRM projects
Author: SugarCRM Inc.
Latest version: 1.1.0

# eslint-config-sugarcrm

## Shared ESLint configuration for SugarCRM code

This style is based on [Airbnb's popular style](https://github.com/airbnb/javascript),
but makes a number of changes to enhance readability.
npm package: @sugarcrm/gulp-jsdoc3
Description: gulp integration for jsdoc3 cli
Author: Marc Udoff
Latest version: 0.2.4

# gulp-jsdoc3

[![NPM version][npm-image]][npm-url]

> [jsdoc](https://github.com/jsdoc3/jsdoc) plugin for [gulp](https://github.com/gulpjs/gulp)

## Installation

Install `gulp-jsdoc` as a development dependency:

```shell
npm install --save-dev @sugarcrm/gulp-jsdoc3
```

## Usage

```javascript
var jsdoc = require('gulp-jsdoc3');

gulp.task('doc', function (cb) {
    gulp.src(['README.md', './src/**/*.js'], {read: false})
        .pipe(jsdoc(cb));
});
```

You can also pass in your own config to override the defaults. All CLI options can be specified here.

```javascript
var jsdoc = require('gulp-jsdoc3');

gulp.task('doc', function (cb) {
    var config = require('./jsdoc.json');
    gulp.src(['README.md', './src/**/*.js'], {read: false})
        .pipe(jsdoc(config, cb));
});
```

Another good example is in this project's [gulpfile](https://github.com/mlucool/gulp-jsdoc3/blob/master/gulpfile.js)!

## Overriding the default layout

[ink-docstrap](https://github.com/docstrap/docstrap) is used as the default layout but you can easily override it in your config like this:

```
{
    "templates": {
        "default": {
            // Set my own layout file
            "layoutFile": "./layout.tmpl"
        }
    }
}
```

## Debugging
Set env variable: ```DEBUG=gulp-jsdoc3```  

## Notes
This is a reasonable attempt to wrap jsdoc using gulp as thinly as possible. All files are added after the cli.
i.e. `jsdoc -c config -t node_modules/ink-docstrap/template gulpFile1 gulpFile2`  
[jsdoc](https://github.com/jsdoc3/jsdoc) does not allow for piped input, so this attempt may be considered a gulp
anti-pattern. It also does not pass on output to be piped elsewhere.


I would like to thank Mangled Deutz @ [gulp-jsdoc](https://github.com/jsBoot/gulp-jsdoc) for the original implementation.

License
-------------
[Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0)

[npm-url]: https://npmjs.org/package/@sugarcrm/gulp-jsdoc3
[npm-image]: https://badge.fury.io/js/gulp-jsdoc3.png
npm package: @sugarcrm/jsdoc-baseline
Description: A basic template for JSDoc 3.
Author: Jeff Williams
Latest version: 0.0.3

# Baseline

[![Build Status](https://img.shields.io/travis/hegemonic/jsdoc-baseline.svg)](http://travis-ci.org/hegemonic/jsdoc-baseline)

An extensible template for [JSDoc 3](https://github.com/jsdoc3/jsdoc).

**This is a preview version of the Baseline template.** Baseline is still under active development.
Everything in the template is subject to change.


## What is Baseline?

Baseline is a new HTML template for [JSDoc 3][jsdoc]. It offers several benefits:

+ **Extensible from the ground up.** You can use extensions to customize your documentation's
content and appearance without changing Baseline itself. In addition, you can localize the headings
and other text that are added by the template. **Note:** Customization options are limited in this
preview version. More options will be available soon.
+ **Easy to navigate.** An expandable table of contents helps users find what they're looking for.
Also, a summary at the top of each page shows users what's documented on that page.
+ **Modern template syntax.** Baseline uses [Handlebars][handlebars], a powerful JavaScript template
engine, to define the template layout. Handlebars makes it possible to define new tags and helpers
that you can use in your customizations to Baseline.

[jsdoc]: https://github.com/jsdoc3/jsdoc
[handlebars]: http://handlebarsjs.com/


## Installing Baseline

1. Install [JSDoc](https://github.com/jsdoc3/jsdoc).

    **Note**: Baseline currently requires JSDoc 3.4.0 or later.

    To install JSDoc globally (may require `sudo`):

        npm install -g jsdoc

    To add JSDoc to your Node.js project as a development dependency:

        npm install --save-dev jsdoc

2. Add the Baseline template to your Node.js project as a development dependency:

        npm install --save-dev @sugarcrm/jsdoc-baseline


## Configuring and Using Baseline

To use the Baseline template with its default settings, simply run JSDoc with the `--template`
(or `-t`) command-line option:

    jsdoc --template <path/to/baseline> <path/to/js-files>

To use the Baseline template with customized settings:

1. Copy `baseline-config.json.EXAMPLE` to a new file (for example, `baseline-config.json`).
2. Modify the configuration file as needed. See `baseline-config.json.EXAMPLE` for information about
the supported options. You can use comments in the configuration file.
3. Update your JSDoc `conf.json` file to include a `templates.baseline` property. This property
must contain the path to your Baseline configuration file.
4. Run JSDoc as shown above, using the `--configure` (or `-c`) option to tell JSDoc where to find
your `conf.json` file:

        jsdoc --configure <path/to/conf.json> --template <path/to/baseline> <path/to/js-files>

**Note**: Future versions of Baseline will provide additional configuration settings, including
settings for overriding and modifying portions of the template.


## Legal stuff

Copyright 2014-2015 Google Inc. Licensed under the Apache License, Version 2.0.

See [LICENSE.md][license] for more information.

[license]: LICENSE.md
npm package: @sugarcrm/thorn
Description: Set of helper abstractions built to ease the process of setting up a SugarCRM instance's REST API testing environment and interacting with it.
Author: SugarCRM Inc.
Latest version: 0.6.0

# Thorn [![Build Status](https://travis-ci.org/sugarcrm/thorn.svg?branch=master)](https://travis-ci.org/sugarcrm/thorn) [![Coverage Status](https://coveralls.io/repos/github/sugarcrm/thorn/badge.svg?branch=master)](https://coveralls.io/github/sugarcrm/thorn?branch=master)

Thorn is composed of a set of helper abstractions built to ease the process of setting up a [SugarCRM](https://www.sugarcrm.com) instance's REST API testing environment and interacting with it.

## Installation

```bash
$ yarn add --dev '@sugarcrm/thorn'
```

## Documentation

See [the Thorn website](http://sugarcrm.github.io/thorn).

## Contributing

See [Contributing guidelines](CONTRIBUTING.md).
npm package: @sugarcrm/ventana
Description: SugarCRM REST API client
Author: SugarCRM Inc.
Latest version: 1.1.25

# Ventana [![Build Status](https://travis-ci.org/sugarcrm/ventana.svg?branch=master)](https://travis-ci.org/sugarcrm/ventana) [![Coverage Status](https://coveralls.io/repos/github/sugarcrm/ventana/badge.svg?branch=master)](https://coveralls.io/github/sugarcrm/ventana?branch=master) [![Sauce Test Status](https://saucelabs.com/buildstatus/hackers-sugarcrm)](https://saucelabs.com/u/hackers-sugarcrm)

Ventana is a client to help connecting and making requests to a SugarCRM REST
API on multiple versions.

Currently this library provides a JavaScript connector.

Alternatively, a PHP connector is available [here](https://github.com/sugarcrm/rest-php-client).

Please contribute to help us grow this client connector.

[![Sauce Test Status](https://saucelabs.com/browser-matrix/hackers-sugarcrm.svg)](https://saucelabs.com/u/hackers-sugarcrm)

### Usage example
You just need to require the module and create an instance of the [Api](https://sugarcrm.github.io/ventana/Api.html) class:

```js
    const Ventana = require('@sugarcrm/ventana');
    const SugarApi = Ventana.getInstance({
        serverUrl: app.config.serverUrl,
        platform: app.config.platform,
        timeout: app.config.serverTimeout,
        clientID: app.config.clientID,
    });

    // Fetch the app metadata
    SugarApi.getMetadata();

    // Fetch `Accounts` records
    SugarApi.records('read', 'Accounts');

    // Favorite a specific contact
    SugarApi.favorite('Contacts', <recordId>, true);
```

**You can find the full documentation [here](https://sugarcrm.github.io/ventana/).**

## Contributing

See [Contributing guidelines](CONTRIBUTING.md).