mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-03 00:27:50 +00:00
fp docs - Remove console.log() from examples.
This commit is contained in:
Jeroen Engels
committed by
John-David Dalton
John-David Dalton
parent
e397707dc9
commit
5062f22839
@@ -40,13 +40,9 @@ function getBaseName(entry) {
|
||||
* @return {number} Ary of the function as an integer
|
||||
*/
|
||||
function getMethodAry(mapping, name) {
|
||||
var ary = _.reduce(mapping.aryMethod, function(res, value, key) {
|
||||
if (res) {
|
||||
return res;
|
||||
}
|
||||
return _.includes(value, name) && key;
|
||||
}, '');
|
||||
return _.parseInt(ary);
|
||||
return _.find(mapping.caps, function(cap) {
|
||||
return _.includes(mapping.aryMethod[cap], name) && cap;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -62,7 +58,7 @@ function reorderParams(mapping, name, params) {
|
||||
if (!mapping || mapping.skipRearg[name]) {
|
||||
return params;
|
||||
}
|
||||
var reargOrder = mapping.methodRearg[name] || mapping.aryRearg[params.length];
|
||||
var reargOrder = mapping.methodRearg[name] || mapping.aryRearg[getMethodAry(mapping, name)];
|
||||
if (!reargOrder) {
|
||||
return params;
|
||||
}
|
||||
@@ -78,6 +74,17 @@ var dotsRegex = /^\.\.\./;
|
||||
var parensRegex = /^\((.*)\)$/;
|
||||
var arrayRegex = /\[\]$/;
|
||||
|
||||
function wrapInParensIfMultiple(types) {
|
||||
if (types.length > 1) {
|
||||
return '(' + types.join('|') + ')';
|
||||
}
|
||||
return types;
|
||||
}
|
||||
|
||||
function singleItemOrArrayOf(types) {
|
||||
return types + '|' + types + '[]';
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace parameter type from something like `...number` to `number|number[]`.
|
||||
*
|
||||
@@ -98,15 +105,8 @@ function removeDotsFromType(param) {
|
||||
return s.replace(arrayRegex, '');
|
||||
})
|
||||
.uniq()
|
||||
.thru(function(array) {
|
||||
if (array.length > 1) {
|
||||
return '(' + array.join('|') + ')';
|
||||
}
|
||||
return array;
|
||||
})
|
||||
.thru(function(subtypes) {
|
||||
return subtypes + '|' + subtypes + '[]';
|
||||
})
|
||||
.thru(wrapInParensIfMultiple)
|
||||
.thru(singleItemOrArrayOf)
|
||||
.value();
|
||||
|
||||
return [newType].concat(_.tail(param));
|
||||
@@ -157,16 +157,17 @@ function concatExtraArgs(j, mapping, name, args) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates a code sample so that the arguments in the call are reordered according to `mapping`.
|
||||
* Reorder the args in the example if needed, and eventually merges them when
|
||||
* the method is called with more args than the method's ary.
|
||||
*
|
||||
* @param {object} j JSCodeShift object.
|
||||
* @param {ASTObject} root AST representation of the example
|
||||
* @param {Object} mapping Mapping object that defines if and how the arguments will be reordered.
|
||||
* @param {string} codeSample Code sample to update.
|
||||
* @returns {string} Updated code sample.
|
||||
* @return {ASTObject} AST object where the arguments are reordered/merged
|
||||
*/
|
||||
function reorderParamsInExample(mapping, codeSample) {
|
||||
return j(codeSample)
|
||||
.find(j.CallExpression, { callee: { object: {name: '_' }}})
|
||||
.replaceWith(function(callExpr) {
|
||||
function reorderMethodArgs(j, root, mapping) {
|
||||
root.find(j.CallExpression, { callee: { object: {name: '_' }}})
|
||||
.replaceWith(function(callExpr, i) {
|
||||
var value = callExpr.value;
|
||||
var name = value.callee.property.name;
|
||||
var args = concatExtraArgs(j, mapping, name, value.arguments);
|
||||
@@ -174,8 +175,29 @@ function reorderParamsInExample(mapping, codeSample) {
|
||||
value.callee,
|
||||
reorderParams(mapping, name, args)
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
function removeConsoleLogs(codeSample) {
|
||||
return codeSample
|
||||
.split('\n')
|
||||
.filter(function(line) {
|
||||
return !line.startsWith('console.log');
|
||||
})
|
||||
.toSource();
|
||||
.join('\n');
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates a code sample so that the arguments in the call are reordered according to `mapping`.
|
||||
*
|
||||
* @param {Object} mapping Mapping object that defines if and how the arguments will be reordered.
|
||||
* @param {string} codeSample Code sample to update.
|
||||
* @returns {string} Updated code sample.
|
||||
*/
|
||||
function reorderParamsInExample(mapping, codeSample) {
|
||||
var root = j(removeConsoleLogs(codeSample));
|
||||
reorderMethodArgs(j, root, mapping);
|
||||
return root.toSource();
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
237
lib/doc/test.js
Normal file
237
lib/doc/test.js
Normal file
@@ -0,0 +1,237 @@
|
||||
var assert = require('assert');
|
||||
|
||||
var Entry = require('docdown/lib/entry');
|
||||
|
||||
var applyFPMapping = require('./apply-fp-mapping');
|
||||
var mapping = require('../../fp/_mapping');
|
||||
|
||||
function toExample(name, lines) {
|
||||
var start = [
|
||||
"/**",
|
||||
" * ",
|
||||
" * @example"
|
||||
];
|
||||
var end = [
|
||||
" */",
|
||||
"function " + name + "(a, b, c) {",
|
||||
"",
|
||||
"}"
|
||||
];
|
||||
var example = lines.map(function(line) {
|
||||
return ' * ' + line;
|
||||
});
|
||||
return [].concat(start, example, end).join('\n');
|
||||
}
|
||||
|
||||
function toParams(name, lines) {
|
||||
var start = [
|
||||
"/**",
|
||||
" * ",
|
||||
];
|
||||
var end = [
|
||||
" * @returns Foo bar",
|
||||
" */",
|
||||
"function " + name + "(a, b, c) {",
|
||||
"",
|
||||
"}"
|
||||
];
|
||||
var example = lines.map(function(line) {
|
||||
return ' * @param ' + line;
|
||||
});
|
||||
return [].concat(start, example, end).join('\n');
|
||||
}
|
||||
|
||||
describe('Docs FP mapping', function() {
|
||||
var oldgetParams;
|
||||
var oldgetExample;
|
||||
|
||||
before(function() {
|
||||
oldgetParams = Entry.prototype.getParams;
|
||||
oldgetExample = Entry.prototype.getExample;
|
||||
applyFPMapping(mapping);
|
||||
});
|
||||
|
||||
after(function() {
|
||||
Entry.prototype.getParams = oldgetParams;
|
||||
Entry.prototype.getExample = oldgetExample;
|
||||
});
|
||||
|
||||
describe('getExample', function() {
|
||||
it('should reorder parameters', function() {
|
||||
var example = toExample('differenceBy', [
|
||||
"_.differenceBy([3.1, 2.2, 1.3], [4.4, 2.5], Math.floor);",
|
||||
"// → [3.1, 1.3]",
|
||||
"",
|
||||
"// The `_.property` iteratee shorthand.",
|
||||
"_.differenceBy([{ 'x': 2 }, { 'x': 1 }], [{ 'x': 1 }], 'x');",
|
||||
"// → [{ 'x': 2 }]"
|
||||
]);
|
||||
var entry = new Entry(example, example);
|
||||
|
||||
var actual = entry.getExample();
|
||||
|
||||
assert.equal(actual, [
|
||||
"```js",
|
||||
"_.differenceBy(Math.floor, [4.4, 2.5], [3.1, 2.2, 1.3]);",
|
||||
"// → [3.1, 1.3]",
|
||||
"",
|
||||
"// The `_.property` iteratee shorthand.",
|
||||
"_.differenceBy('x', [{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }]);",
|
||||
"// → [{ 'x': 2 }]",
|
||||
"```"
|
||||
].join('\n'));
|
||||
});
|
||||
|
||||
it('should reorder parameters that have a special order', function() {
|
||||
var example = toExample('set', [
|
||||
"var object = { 'a': [{ 'b': { 'c': 3 } }] };",
|
||||
"_.set(object, 'a[0].b.c', 4);",
|
||||
"_.set(object, 'x[0].y.z', 5);",
|
||||
]);
|
||||
var entry = new Entry(example, example);
|
||||
|
||||
var actual = entry.getExample();
|
||||
|
||||
assert.equal(actual, [
|
||||
"```js",
|
||||
"var object = { 'a': [{ 'b': { 'c': 3 } }] };",
|
||||
"_.set('a[0].b.c', 4, object);",
|
||||
"_.set('x[0].y.z', 5, object);",
|
||||
"```"
|
||||
].join('\n'));
|
||||
});
|
||||
|
||||
it('should preserve comments', function() {
|
||||
var example = toExample('set', [
|
||||
"var object = { 'a': [{ 'b': { 'c': 3 } }] };",
|
||||
"_.set(object, 'a[0].b.c', 4);",
|
||||
"// => 4",
|
||||
"_.set(object, 'x[0].y.z', 5);",
|
||||
]);
|
||||
var entry = new Entry(example, example);
|
||||
|
||||
var actual = entry.getExample();
|
||||
|
||||
assert.equal(actual, [
|
||||
"```js",
|
||||
"var object = { 'a': [{ 'b': { 'c': 3 } }] };",
|
||||
"_.set('a[0].b.c', 4, object);",
|
||||
"// => 4",
|
||||
"_.set('x[0].y.z', 5, object);",
|
||||
"```"
|
||||
].join('\n'));
|
||||
});
|
||||
|
||||
it('should remove console.logs from example', function() {
|
||||
var example = toExample('set', [
|
||||
"var object = { 'a': [{ 'b': { 'c': 3 } }] };",
|
||||
"",
|
||||
"_.set(object, 'a[0].b.c', 4);",
|
||||
"console.log(object.a[0].b.c);",
|
||||
"// => 4",
|
||||
"",
|
||||
"_.set(object, 'x[0].y.z', 5);",
|
||||
"console.log(object.x[0].y.z);",
|
||||
"// => 5"
|
||||
]);
|
||||
var entry = new Entry(example, example);
|
||||
|
||||
var actual = entry.getExample();
|
||||
|
||||
assert.equal(actual, [
|
||||
"```js",
|
||||
"var object = { 'a': [{ 'b': { 'c': 3 } }] };",
|
||||
"",
|
||||
"_.set('a[0].b.c', 4, object);",
|
||||
"// => 4",
|
||||
"",
|
||||
"_.set('x[0].y.z', 5, object);",
|
||||
"// => 5",
|
||||
"```"
|
||||
].join('\n'));
|
||||
});
|
||||
|
||||
it('should merge extra arguments into an array', function() {
|
||||
var example = toExample('pullAt', [
|
||||
"var array = [5, 10, 15, 20];",
|
||||
"var evens = _.pullAt(array, 1, 3);",
|
||||
"",
|
||||
"console.log(array);",
|
||||
"// => [5, 15]",
|
||||
"",
|
||||
"console.log(evens);",
|
||||
"// => [10, 20]",
|
||||
]);
|
||||
var entry = new Entry(example, example);
|
||||
|
||||
var actual = entry.getExample();
|
||||
|
||||
assert.equal(actual, [
|
||||
"```js",
|
||||
"var array = [5, 10, 15, 20];",
|
||||
"var evens = _.pullAt([1, 3], array);",
|
||||
"",
|
||||
"// => [5, 15]",
|
||||
"",
|
||||
"// => [10, 20]",
|
||||
"```"
|
||||
].join('\n'));
|
||||
});
|
||||
});
|
||||
|
||||
describe('getParams', function() {
|
||||
it('should reorder arguments', function() {
|
||||
var example = toParams('differenceBy', [
|
||||
'{Array} array The array to inspect.',
|
||||
'{...Array} [values] The values to exclude.',
|
||||
'{Function|Object|string} [iteratee=_.identity] The iteratee invoked per element.'
|
||||
]);
|
||||
var entry = new Entry(example, example);
|
||||
|
||||
var actual = entry.getParams();
|
||||
|
||||
assert.deepEqual(actual, [
|
||||
['Function|Object|string', '[iteratee=_.identity]', 'The iteratee invoked per element. '],
|
||||
['Array|Array[]', '[values]', 'The values to exclude. '],
|
||||
['Array', 'array', 'The array to inspect. ']
|
||||
]);
|
||||
});
|
||||
|
||||
it('should reorder arguments that have a special order', function() {
|
||||
var example = toParams('set', [
|
||||
'{Object} object The object to modify.',
|
||||
'{Array|string} path The path of the property to set.',
|
||||
'{*} value The value to set.'
|
||||
]);
|
||||
var entry = new Entry(example, example);
|
||||
|
||||
var actual = entry.getParams();
|
||||
|
||||
assert.deepEqual(actual, [
|
||||
['Array|string', 'path', 'The path of the property to set. '],
|
||||
['*', 'value', 'The value to set. '],
|
||||
['Object', 'object', 'The object to modify. '],
|
||||
]);
|
||||
});
|
||||
|
||||
it('should transform rest arguments into an array', function() {
|
||||
var example = toParams('pullAt', [
|
||||
'{Array} array The array to modify.',
|
||||
'{...(number|number[])} [indexes] The indexes of elements to remove,\n' +
|
||||
' * specified individually or in arrays.'
|
||||
]);
|
||||
var entry = new Entry(example, example);
|
||||
|
||||
var actual = entry.getParams();
|
||||
|
||||
assert.deepEqual(actual, [
|
||||
// TODO Remove this line in favor of the commented one.
|
||||
// Is linked to a docdown (https://github.com/jdalton/docdown/pull/37)
|
||||
// that does not handle parens in the arguments well
|
||||
['((number|number)|((number|number)[]', '[indexes]', 'The indexes of elements to remove, specified individually or in arrays. '],
|
||||
// ['number|number[]', '[indexes]', 'The indexes of elements to remove, specified individually or in arrays. '],
|
||||
['Array', 'array', 'The array to modify. '],
|
||||
]);
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user