Skip to content

Commit

Permalink
filename --> fileLocation
Browse files Browse the repository at this point in the history
  • Loading branch information
chris48s committed Aug 12, 2024
1 parent c903eb9 commit aee7e86
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/plugins.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,18 @@ class BasePlugin {
* returns undefined, v8r will move on to the next plugin in the stack.
*
* @param {string} contents - The unparsed document file content.
* @param {string} filename - The document filename. Filenames are resolved
* and normalised by [glob](https://www.npmjs.com/package/glob) using the
* `dotRelative` option. This means relative paths in the current directory
* will be prefixed with `./` (or `.\` on Windows) even if this was not
* present in the input filename or pattern.
* @param {string} fileLocation - The document filename. Filenames are
* resolved and normalised by [glob](https://www.npmjs.com/package/glob)
* using the `dotRelative` option. This means relative paths in the current
* directory will be prefixed with `./` (or `.\` on Windows) even if this
* was not present in the input filename or pattern.
* @param {string | undefined} parser - If this filename matched a document
* parser the user has specified in a custom schema, this will be passed to
* `parseDocument` in the `parser` param.
* @returns {object | undefined} Parsed file contents
*/
// eslint-disable-next-line no-unused-vars
parseDocument(contents, filename, parser) {
parseDocument(contents, fileLocation, parser) {
return undefined;
}

Expand Down Expand Up @@ -74,17 +74,17 @@ class BasePlugin {
*
* @param {ValidationResult} result - Result of attempting to validate this
* document.
* @param {string} filename - The document filename. Filenames are resolved
* and normalised by [glob](https://www.npmjs.com/package/glob) using the
* `dotRelative` option. This means relative paths in the current directory
* will be prefixed with `./` (or `.\` on Windows) even if this was not
* present in the input filename or pattern.
* @param {string} fileLocation - The document filename. Filenames are
* resolved and normalised by [glob](https://www.npmjs.com/package/glob)
* using the `dotRelative` option. This means relative paths in the current
* directory will be prefixed with `./` (or `.\` on Windows) even if this
* was not present in the input filename or pattern.
* @param {string} format - The user's requested output format as specified in
* the config file or via the `--format` command line argument.
* @returns {string | undefined} Log message
*/
// eslint-disable-next-line no-unused-vars
getSingleResultLogMessage(result, filename, format) {
getSingleResultLogMessage(result, fileLocation, format) {
return undefined;
}

Expand Down

0 comments on commit aee7e86

Please sign in to comment.