Classes

MLEngine

Constructor

new MLEngine(file, options);

file

• MLFile
• Required

Use the toMLFile static method, create a MLFile instance.

const file = await MLEngine.toMLFile('./path/to/page.html');

options

• Object
• Optional

Property	Type	Optional	Description
configFile	string	✓	The file path of the configuration. When specified, the automatic search for a configuration file is not performed.
config	Object	✓	The configuration. A relative path in it is based on the working directory.
defaultConfig	Object	✓	The Fallback configuration when the auto search finds none or is disabled. A relative path in it is based on the working directory.
noSearchConfig	boolean	✓	No search a configure file automatically.
locale	string	✓	Locale.
fix	boolean	✓	Returns the fixed code after the execution.
ignoreExt	boolean	✓	Evaluates files even though the type of extension.
rules	Object[]	✓	Additional custom rules.
importPresetRules	boolean	✓	No imports preset rules.
debug	boolean	✓	Outputs logs for debugging.
watch	boolean	✓	Fires lint event when the config file or a component file that pretenders reads is updated. The target file is not watched; tell the engine of its edits with setCode.

Methods

exec

const result = await engine.exec();

if (result) {
  const { violations, filePath, sourceCode, fixedCode } = result;
}

Parameter

None

Return

• Promise<Object|null>

Property	Type	Description
violations	Object[]	The array of results.
filePath	string	The absolute path of the target file
sourceCode	string	The original source code.
fixedCode	string	The Fixed source code. It is the same as the original code if didn't specify fix option.