JavaScript Code Assistant
其他语言 / English
格式化代码。如果提供了一个或一组源代码中的位置信息(包括行、列信息,以下称之为代码坐标),则同时返回格式化代码中的对应坐标:
const codon = require('codon');
let sourceCode = '// Minified JavaScript Source Code';
// -- return transformed position directly --
let output_1 = codon.format({
code: sourceCode,
position: { line: 1, column: 10 },
});
// RETURN: { code, position }
如果需要获取坐标转换方法,将参数对象的 position
属性赋值为 true
:
// -- to do poisition transformation by yourself --
let output_2 = codon.format({
code: sourceCode,
position: true,
});
// RETURN: { code, positionFor }
let transformedPosition = output_2.positionFor({ line: 1, column: 10 });
// RETURN: { line, column }
出于参数可扩展的考虑,该方法仅接受一个参数对象,包含以下属性:
-
string | Buffer code
源代码文本。 -
boolean | Object | [Object] position OPTIONAL
若该属性为对象或对象数组,指源代码坐标。
若该属性为布尔值且为值为true
,则返回值对象中将提供一个positionFor()
方法,可用于完成从源代码坐标到生成代码坐标的转换。
举例如下:
-
{ string code } codon.format({ string code })
生成压缩代码文本。 -
{ string code, object position } codon.format({ string code, object position })
生成压缩代码文本,及一个源代码坐标所对应的生成代码坐标。 -
{ string code, Array position } codon.format({ string code, Array position })
生成压缩代码文本,及一组源代码坐标所对应的生成代码坐标。 -
{ string code, function positionFor } codon.format({ string code, boolean position })
生成压缩代码文本,及从源代码坐标到生成代码坐标的转换方法。该方法接收坐标对象或坐标数组作为参数,相应地返回一个或一组坐标对象。
出于参数可扩展的考虑,该方法仅接受一个参数对象,包含以下属性:
-
string | Buffer code
源代码文本。 -
boolean | Object | [Object] position OPTIONAL
若该属性为对象或对象数组,指源代码坐标。
若该属性为布尔值且为值为true
,则返回值对象中将提供一个positionFor()
方法,可用于完成从源代码坐标到生成代码坐标的转换。
举例如下:
-
{ string code } codon.format({ string code })
生成格式化代码文本。 -
{ string code, object position } codon.format({ string code, object position })
生成格式化代码文本,及一个源代码坐标所对应的生成代码坐标。 -
{ string code, Array position } codon.format({ string code, Array position })
生成格式化代码文本,及一组源代码坐标所对应的生成代码坐标。 -
{ string code, function positionFor } codon.format({ string code, boolean position })
生成格式化代码文本,及从源代码坐标到生成代码坐标的转换方法。该方法接收坐标对象或坐标数组作为参数,相应地返回一个或一组坐标对象。