ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Make code prettier

Browse Source 
This updates ESLint and our shared eslint-config-openlayers to use Prettier.  Most formatting changes were automatically applied with this:

    npm run lint -- --fix

A few manual changes were required:

 * In `examples/offscreen-canvas.js`, the `//eslint-disable-line` comment needed to be moved to the appropriate line to disable the error about the `'worker-loader!./offscreen-canvas.worker.js'` import.
 * In `examples/webpack/exapmle-builder.js`, spaces could not be added after a couple `function`s for some reason.  While editing this, I reworked `ExampleBuilder` to be a class.
 * In `src/ol/format/WMSGetFeatureInfo.js`, the `// @ts-ignore` comment needed to be moved down one line so it applied to the `parsersNS` argument.
This commit is contained in:
Tim Schaub
2020-04-06 12:25:12 -06:00
parent 53b48baf62
commit 054af09032
790 changed files with 46833 additions and 33765 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/xml.js
+120 -64
View File
@@ -3,7 +3,6 @@
*/
import {extend} from './array.js';
/**
* When using {@link module:ol/xml~makeChildAppender} or
* {@link module:ol/xml~makeSimpleNodeFactory}, the top `objectStack` item needs
@@ -12,22 +11,19 @@ import {extend} from './array.js';
* @property {Node} node
*/
/**
* @typedef {function(Element, Array<*>): void} Parser
*/
/**
* @typedef {function(Element, *, Array<*>): void} Serializer
*/
/**
* @type {string}
*/
export const XML_SCHEMA_INSTANCE_URI = 'http://www.w3.org/2001/XMLSchema-instance';
export const XML_SCHEMA_INSTANCE_URI =
'http://www.w3.org/2001/XMLSchema-instance';
/**
* @param {string} namespaceURI Namespace URI.
@@ -38,7 +34,6 @@ export function createElementNS(namespaceURI, qualifiedName) {
return getDocument().createElementNS(namespaceURI, qualifiedName);
}
/**
* Recursively grab all text content of child nodes into a single string.
* @param {Node} node Node.
@@ -51,7 +46,6 @@ export function getAllTextContent(node, normalizeWhitespace) {
return getAllTextContent_(node, normalizeWhitespace, []).join('');
}
/**
* Recursively grab all text content of child nodes into a single string.
* @param {Node} node Node.
@@ -62,8 +56,10 @@ export function getAllTextContent(node, normalizeWhitespace) {
* @return {Array<string>} Accumulator.
*/
export function getAllTextContent_(node, normalizeWhitespace, accumulator) {
if (node.nodeType == Node.CDATA_SECTION_NODE ||
node.nodeType == Node.TEXT_NODE) {
if (
node.nodeType == Node.CDATA_SECTION_NODE ||
node.nodeType == Node.TEXT_NODE
) {
if (normalizeWhitespace) {
accumulator.push(String(node.nodeValue).replace(/(\r\n|\r|\n)/g, ''));
} else {
@@ -78,7 +74,6 @@ export function getAllTextContent_(node, normalizeWhitespace, accumulator) {
return accumulator;
}
/**
* @param {Object} object Object.
* @return {boolean} Is a document.
@@ -87,7 +82,6 @@ export function isDocument(object) {
return 'documentElement' in object;
}
/**
* @param {Element} node Node.
* @param {?string} namespaceURI Namespace URI.
@@ -98,7 +92,6 @@ export function getAttributeNS(node, namespaceURI, name) {
return node.getAttributeNS(namespaceURI, name) || '';
}
/**
* Parse an XML string to an XML Document.
* @param {string} xml XML.
@@ -109,7 +102,6 @@ export function parse(xml) {
return new DOMParser().parseFromString(xml, 'application/xml');
}
/**
* Make an array extender function for extending the array at the top of the
* object stack.
@@ -124,17 +116,22 @@ export function makeArrayExtender(valueReader, opt_this) {
* @param {Node} node Node.
* @param {Array<*>} objectStack Object stack.
*/
function(node, objectStack) {
const value = valueReader.call(opt_this !== undefined ? opt_this : this, node, objectStack);
function (node, objectStack) {
const value = valueReader.call(
opt_this !== undefined ? opt_this : this,
node,
objectStack
);
if (value !== undefined) {
const array = /** @type {Array<*>} */ (objectStack[objectStack.length - 1]);
const array = /** @type {Array<*>} */ (objectStack[
objectStack.length - 1
]);
extend(array, value);
}
}
);
}
/**
* Make an array pusher function for pushing to the array at the top of the
* object stack.
@@ -149,16 +146,22 @@ export function makeArrayPusher(valueReader, opt_this) {
* @param {Element} node Node.
* @param {Array<*>} objectStack Object stack.
*/
function(node, objectStack) {
const value = valueReader.call(opt_this !== undefined ? opt_this : this, node, objectStack);
function (node, objectStack) {
const value = valueReader.call(
opt_this !== undefined ? opt_this : this,
node,
objectStack
);
if (value !== undefined) {
const array = /** @type {Array<*>} */ (objectStack[objectStack.length - 1]);
const array = /** @type {Array<*>} */ (objectStack[
objectStack.length - 1
]);
array.push(value);
}
});
}
);
}
/**
* Make an object stack replacer function for replacing the object at the
* top of the stack.
@@ -173,15 +176,19 @@ export function makeReplacer(valueReader, opt_this) {
* @param {Node} node Node.
* @param {Array<*>} objectStack Object stack.
*/
function(node, objectStack) {
const value = valueReader.call(opt_this !== undefined ? opt_this : this, node, objectStack);
function (node, objectStack) {
const value = valueReader.call(
opt_this !== undefined ? opt_this : this,
node,
objectStack
);
if (value !== undefined) {
objectStack[objectStack.length - 1] = value;
}
});
}
);
}
/**
* Make an object property pusher function for adding a property to the
* object at the top of the stack.
@@ -197,11 +204,18 @@ export function makeObjectPropertyPusher(valueReader, opt_property, opt_this) {
* @param {Element} node Node.
* @param {Array<*>} objectStack Object stack.
*/
function(node, objectStack) {
const value = valueReader.call(opt_this !== undefined ? opt_this : this, node, objectStack);
function (node, objectStack) {
const value = valueReader.call(
opt_this !== undefined ? opt_this : this,
node,
objectStack
);
if (value !== undefined) {
const object = /** @type {!Object} */ (objectStack[objectStack.length - 1]);
const property = opt_property !== undefined ? opt_property : node.localName;
const object = /** @type {!Object} */ (objectStack[
objectStack.length - 1
]);
const property =
opt_property !== undefined ? opt_property : node.localName;
let array;
if (property in object) {
array = object[property];
@@ -211,10 +225,10 @@ export function makeObjectPropertyPusher(valueReader, opt_property, opt_this) {
}
array.push(value);
}
});
}
);
}
/**
* Make an object property setter function.
* @param {function(this: T, Element, Array<*>): *} valueReader Value reader.
@@ -229,17 +243,24 @@ export function makeObjectPropertySetter(valueReader, opt_property, opt_this) {
* @param {Element} node Node.
* @param {Array<*>} objectStack Object stack.
*/
function(node, objectStack) {
const value = valueReader.call(opt_this !== undefined ? opt_this : this, node, objectStack);
function (node, objectStack) {
const value = valueReader.call(
opt_this !== undefined ? opt_this : this,
node,
objectStack
);
if (value !== undefined) {
const object = /** @type {!Object} */ (objectStack[objectStack.length - 1]);
const property = opt_property !== undefined ? opt_property : node.localName;
const object = /** @type {!Object} */ (objectStack[
objectStack.length - 1
]);
const property =
opt_property !== undefined ? opt_property : node.localName;
object[property] = value;
}
});
}
);
}
/**
* Create a serializer that appends nodes written by its `nodeWriter` to its
* designated parent. The parent is the `node` of the
@@ -250,15 +271,21 @@ export function makeObjectPropertySetter(valueReader, opt_property, opt_this) {
* @template T, V
*/
export function makeChildAppender(nodeWriter, opt_this) {
return function(node, value, objectStack) {
nodeWriter.call(opt_this !== undefined ? opt_this : this, node, value, objectStack);
const parent = /** @type {NodeStackItem} */ (objectStack[objectStack.length - 1]);
return function (node, value, objectStack) {
nodeWriter.call(
opt_this !== undefined ? opt_this : this,
node,
value,
objectStack
);
const parent = /** @type {NodeStackItem} */ (objectStack[
objectStack.length - 1
]);
const parentNode = parent.node;
parentNode.appendChild(node);
};
}
/**
* Create a serializer that calls the provided `nodeWriter` from
* {@link module:ol/xml~serialize}. This can be used by the parent writer to have the
@@ -273,7 +300,7 @@ export function makeChildAppender(nodeWriter, opt_this) {
*/
export function makeArraySerializer(nodeWriter, opt_this) {
let serializersNS, nodeFactory;
return function(node, value, objectStack) {
return function (node, value, objectStack) {
if (serializersNS === undefined) {
serializersNS = {};
const serializers = {};
@@ -285,7 +312,6 @@ export function makeArraySerializer(nodeWriter, opt_this) {
};
}
/**
* Create a node factory which can use the `opt_keys` passed to
* {@link module:ol/xml~serialize} or {@link module:ol/xml~pushSerializeAndPop} as node names,
@@ -308,21 +334,23 @@ export function makeSimpleNodeFactory(opt_nodeName, opt_namespaceURI) {
* @param {string=} opt_nodeName Node name.
* @return {Node} Node.
*/
function(value, objectStack, opt_nodeName) {
const context = /** @type {NodeStackItem} */ (objectStack[objectStack.length - 1]);
function (value, objectStack, opt_nodeName) {
const context = /** @type {NodeStackItem} */ (objectStack[
objectStack.length - 1
]);
const node = context.node;
let nodeName = fixedNodeName;
if (nodeName === undefined) {
nodeName = opt_nodeName;
}
const namespaceURI = opt_namespaceURI !== undefined ? opt_namespaceURI : node.namespaceURI;
const namespaceURI =
opt_namespaceURI !== undefined ? opt_namespaceURI : node.namespaceURI;
return createElementNS(namespaceURI, /** @type {string} */ (nodeName));
}
);
}
/**
* A node factory that creates a node using the parent's `namespaceURI` and the
* `nodeName` passed by {@link module:ol/xml~serialize} or
@@ -332,7 +360,6 @@ export function makeSimpleNodeFactory(opt_nodeName, opt_namespaceURI) {
*/
export const OBJECT_PROPERTY_NODE_FACTORY = makeSimpleNodeFactory();
/**
* Create an array of `values` to be used with {@link module:ol/xml~serialize} or
* {@link module:ol/xml~pushSerializeAndPop}, where `orderedKeys` has to be provided as
@@ -353,7 +380,6 @@ export function makeSequence(object, orderedKeys) {
return sequence;
}
/**
* Create a namespaced structure, using the same values for each namespace.
* This can be used as a starting point for versioned parsers, when only a few
@@ -376,7 +402,6 @@ export function makeStructureNS(namespaceURIs, structure, opt_structureNS) {
return structureNS;
}
/**
* Parse a node using the parsers and object stack.
* @param {Object<string, Object<string, Parser>>} parsersNS
@@ -398,7 +423,6 @@ export function parseNode(parsersNS, node, objectStack, opt_this) {
}
}
/**
* Push an object on top of the stack, parse and return the popped object.
* @param {T} object Object.
@@ -410,13 +434,18 @@ export function parseNode(parsersNS, node, objectStack, opt_this) {
* @return {T} Object.
* @template T
*/
export function pushParseAndPop(object, parsersNS, node, objectStack, opt_this) {
export function pushParseAndPop(
object,
parsersNS,
node,
objectStack,
opt_this
) {
objectStack.push(object);
parseNode(parsersNS, node, objectStack, opt_this);
return /** @type {T} */ (objectStack.pop());
}
/**
* Walk through an array of `values` and call a serializer for each value.
* @param {Object<string, Object<string, Serializer>>} serializersNS
@@ -440,23 +469,36 @@ export function pushParseAndPop(object, parsersNS, node, objectStack, opt_this)
* @template T
*/
export function serialize(
serializersNS, nodeFactory, values, objectStack, opt_keys, opt_this) {
serializersNS,
nodeFactory,
values,
objectStack,
opt_keys,
opt_this
) {
const length = (opt_keys !== undefined ? opt_keys : values).length;
let value, node;
for (let i = 0; i < length; ++i) {
value = values[i];
if (value !== undefined) {
node = nodeFactory.call(opt_this !== undefined ? opt_this : this, value, objectStack,
opt_keys !== undefined ? opt_keys[i] : undefined);
node = nodeFactory.call(
opt_this !== undefined ? opt_this : this,
value,
objectStack,
opt_keys !== undefined ? opt_keys[i] : undefined
);
if (node !== undefined) {
serializersNS[node.namespaceURI][node.localName]
.call(opt_this, node, value, objectStack);
serializersNS[node.namespaceURI][node.localName].call(
opt_this,
node,
value,
objectStack
);
}
}
}
}
/**
* @param {O} object Object.
* @param {Object<string, Object<string, Serializer>>} serializersNS
@@ -480,9 +522,24 @@ export function serialize(
* @return {O|undefined} Object.
* @template O, T
*/
export function pushSerializeAndPop(object, serializersNS, nodeFactory, values, objectStack, opt_keys, opt_this) {
export function pushSerializeAndPop(
object,
serializersNS,
nodeFactory,
values,
objectStack,
opt_keys,
opt_this
) {
objectStack.push(object);
serialize(serializersNS, nodeFactory, values, objectStack, opt_keys, opt_this);
serialize(
serializersNS,
nodeFactory,
values,
objectStack,
opt_keys,
opt_this
);
return /** @type {O|undefined} */ (objectStack.pop());
}
@@ -509,7 +566,6 @@ export function getXMLSerializer() {
return xmlSerializer_;
}
let document_ = undefined;
/**