--------------------------------------------------------------------------------

Contains sections of eslint

ESLint

Copyright JS Foundation and other contributors, https://js.foundation

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

Base assumptions:

* documentation.js subsists on a combination of _source comments_ and

_smart inferences from source code_.

* The default mode of documentation.js is parsing JavaScript, but it has another

mode, called `--polyglot` mode, that doesn't include any inference at all

and lets you document other kinds of source code.

* The default settings for everything should work for most projects, but

this is a guide for if you have a particular setup.

Let's talk about file extensions. We have two different flags for controlling

file extensions: `requireExtension` and `parseExtension`.

* requireExtension adds additional filetypes to the node.js `require()` method.

By default, you can call, for instance, `require('foo')`, and the require algorithm

will look for `foo.js`, `foo` the module, and `foo.json`. Adding another

extension in requireExtension lets it look for `foo.otherextension`.

* parseExtension adds additional filetypes to the list of filetypes documentation.js

thinks it can parse, and it also adds those additional filetypes to the default

files it looks for when you specify a directory or glob as input.

Polyglot mode switches documentation.js from running on babylon and [babel](https://babeljs.io/)

as a JavaScript parser, to using [get-comments](https://github.com/tunnckocore/get-comments).

This lets it grab comments formatted in the `/** Comment */` style from source

code that _isn't_ JavaScript, like C++ or CSS code.

Since documentation.js doesn't _parse_ C++ and lots of other languages (parsing JavaScript is complicated enough!),

it can't make any of its smart inferences about their source code: it just

takes documentation comments and shows them as-is.

You _can_ use polyglot mode to turn off inference across the board, but I don't recommend

it. See the 'too much inference' topic in [TROUBLESHOOTING.md](TROUBLESHOOTING.md)

for detail about that.

var parseExtensions = ['js', 'jsx', 'es5', 'es6'];

options.parseExtensions = parseExtensions

.concat(options.parseExtension || []);

'requireExtension': {

describe: 'additional extensions to include in require() and import\'s search algorithm.' +

'For instance, adding .es5 would allow require("adder") to find "adder.es5"',

coerce: function (value) {

// Ensure that the value is an array

return [].concat(value);

},

alias: 're'

},

'parseExtension': {

describe: 'additional extensions to parse as source code.',

coerce: function (value) {

// Ensure that the value is an array

return [].concat(value);

},

alias: 'pe'

var mdeps = require('module-deps-sortable');

var fs = require('fs');

var path = require('path');

var babelify = require('babelify');

var concat = require('concat-stream');

var moduleFilters = require('../../lib/module_filters');

var smartGlob = require('../smart_glob.js');

extensions: [].concat(options.requireExtension || [])

return '.' + ext.replace(/^\./, '');

})

.concat(['.js', '.json', '.es6', '.jsx']),

smartGlob(indexes, options.parseExtensions).forEach(function (index) {

callback(null, inputs

.filter(function (input) {

// At this point, we may have allowed a JSON file to be caught by

// module-deps, or anything else allowed by requireExtension.

// otherwise module-deps would complain about

// it not being found. But Babel can't parse JSON, so we filter non-JavaScript

// files away.

return options.parseExtensions.indexOf(

path.extname(input.file).replace(/^\./, '')

) > -1;

})

.map(function (input) {

// un-transform babelify transformed source

input.source = fs.readFileSync(input.file, 'utf8');

return input;

}));

var smartGlob = require('../smart_glob.js');

var objects = [];

var strings = [];

indexes.forEach(function (index) {

if (typeof index === 'string') {

strings.push(index);

} else if (typeof index === 'object') {

objects.push(index);

} else {

throw new Error('Indexes should be either strings or objects');

}

});

return callback(null, objects.concat(smartGlob(strings, options.parseExtensions)));