-
processor
(Processor
)
— Unified processor to transform files.
-
cwd
(string
, default: process.cwd()
)
— Directory to search files in, load plug-ins from, and more.
-
globs
(Array.<string>
, optional)
— Paths or globs to files and directories to process.
-
extensions
(Array.<string>
, optional)
— If globs
matches directories, include files with extensions
-
streamIn
(ReadableStream
, default: process.stdin
)
— Stream to read from if no files are found or given.
-
filePath
(string
, optional)
— File path to process the given file on streamIn
as.
-
streamOut
(WritableStream
, default: process.stdout
)
— Stream to write processed files to.
-
streamError
(WritableStream
, default:
process.stderr
)
— Stream to write the report (if any) to.
-
out
(boolean
, default: depends)
— Whether to write the processed file to streamOut
.
-
output
(boolean
or string
, default: false
)
— Whether to write successfully processed files, and where to.
-
alwaysStringify
(boolean
, default: false
)
— Whether to always compile successfully processed files.
-
tree
(boolean
, default: false
)
— Whether to treat both input and output as a syntax tree.
-
treeIn
(boolean
, default: tree
)
— Whether to treat input as a syntax tree.
-
treeOut
(boolean
, default: tree
)
— Whether to treat output as a syntax tree.
-
rcName
(string
, optional)
— Name of configuration files to load.
-
packageField
(string
, optional)
— Property at which configuration can be found in package.json
files.
-
detectConfig
(boolean
, default: whether
rcName
or packageField
is given)
— Whether to search for configuration files.
-
rcPath
(string
, optional)
— File-path to a configuration file to load.
-
settings
(Object
, optional)
— Configuration for the parser and compiler of the processor.
-
ignoreName
(string
, optional)
— Name of ignore files to load.
-
detectIgnore
(boolean
, default: whether
ignoreName
is given)
— Whether to search for ignore files.
-
ignorePath
(string
, optional)
— File-path to a ignore file to load.
-
silentlyIgnore
(boolean
, default: false
)
— Skip given files if they are ignored.
-
plugins
(Object
, optional)
— Map of plug-in names or paths and options to use.
-
pluginPrefix
(string
, optional)
— When given, optional prefix to use when searching for plug-ins.
-
injectedPlugins
(Array
, optional)
— List of loaded plug-ins to use.
-
color
(boolean
, default: false
)
— Whether to report with ANSI colour sequences.
-
silent
(boolean
, default: false
)
— Report only fatal errors.
-
quiet
(boolean
, default: silent
)
— Do not report successful files.
-
frail
(boolean
, default: false
)
— Treat warnings as errors.
-
files
(Array.<VFile>
, optional)
— Use the given files (in addition to searching for globs
).