Adapts a LintResult to a TodoData. FilePaths are absolute\nwhen received from a lint result, so they're converted to relative paths for stability in\nserializing the contents to disc.
\nDetermines if the .lint-todo storage file exists.
\nCreates, or ensures the creation of, the .lint-todo file.
\nDetermines if the .lint-todo storage file has conflicts.
\nResolves git conflicts in todo operations by removing any lines that match conflict markers.
\nReads the .lint-todo storage file.
\nWrites the operations to the .lint-todo storage file to the path provided by todoStorageFilePath.
\nWrites files for todo lint violations. One file is generated for each violation, using a generated\nhash to identify each.
\nGiven a list of todo lint violations, this function will also delete existing files that no longer\nhave a todo lint violation.
\nReads all todo files in the .lint-todo file.
\nReads todo files in the .lint-todo file for a specific filePath.
\nReads todos in the .lint-todo file and returns Todo data in an array.
\nReads todos for a single filePath in the .lint-todo file and returns Todo data in an array.
\nGets 4 data structures containing todo items to add, remove, those that are expired, and those that are stable (not to be modified).
\nGets 4 data structures containing todo items to add, remove, those that are expired, and those that are stable (not to be modified).
\nApplies todo changes, either adding or removing, based on batches from getTodoBatches.
Compacts the .lint-todo storage file.
\nGets the todo configuration from one of a number of locations.
\nValidates whether we have a unique config in a single location.
\nReturns the correct severity level based on the todo data's decay dates.
\nEvaluates whether a date is expired (earlier than today)
\nConverts a date to include year, month, and day values only (time is zeroed out).
\nReturns the difference in days between two dates.
\nFormats the date in short form, eg. 2021-01-01
\nConverts node positional numbers into a Range object.
\nReads a source file, optionally caching it if it's already been read.
\nExtracts a source fragment from a file's contents based on the provided Range.
\ntrue | True if the .lint-todo storage file should be locked, otherwise false. Default: true. |\n\n\n\n## readTodosForFilePath(baseDir, options, shouldLock) ⇒\nReads todo files in the .lint-todo file for a specific filePath.\n\n**Kind**: global function \n**Returns**: - A [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) of [FilePath](https://github.com/lint-todo/utils/blob/master/src/types/todo.ts#L25)/[TodoMatcher](https://github.com/lint-todo/utils/blob/master/src/todo-matcher.ts#L4). \n\n| Param | Default | Description |\n| --- | --- | --- |\n| baseDir | | The base directory that contains the .lint-todo storage file. |\n| options | | An object containing read options. |\n| shouldLock | true | True if the .lint-todo storage file should be locked, otherwise false. Default: true. |\n\n\n\n## readTodoData(baseDir, options) ⇒\nReads todos in the .lint-todo file and returns Todo data in an array.\n\n**Kind**: global function \n**Returns**: An array of [TodoData](https://github.com/lint-todo/utils/blob/master/src/types/todo.ts#L61) \n\n| Param | Description |\n| --- | --- |\n| baseDir | The base directory that contains the .lint-todo storage file. |\n| options | An object containing read options. |\n\n\n\n## readTodoDataForFilePath(baseDir, options) ⇒\nReads todos for a single filePath in the .lint-todo file and returns Todo data in an array.\n\n**Kind**: global function \n**Returns**: An array of [TodoData](https://github.com/lint-todo/utils/blob/master/src/types/todo.ts#L61) \n\n| Param | Description |\n| --- | --- |\n| baseDir | The base directory that contains the .lint-todo storage file. |\n| options | An object containing read options. |\n\n\n\n## generateTodoBatches(baseDir, maybeTodos, options) ⇒\nGets 4 data structures containing todo items to add, remove, those that are expired, and those that are stable (not to be modified).\n\n**Kind**: global function \n**Returns**: - An object of [TodoBatches](https://github.com/lint-todo/utils/blob/master/src/types/todo.ts#L36). \n\n| Param | Description |\n| --- | --- |\n| baseDir | The base directory that contains the .lint-todo storage file. |\n| maybeTodos | The linting data for violations. |\n| options | An object containing write options. |\n\n\n\n## getTodoBatches(maybeTodos, existing, options) ⇒\nGets 4 data structures containing todo items to add, remove, those that are expired, and those that are stable (not to be modified).\n\n**Kind**: global function \n**Returns**: - An object of [TodoBatches](https://github.com/lint-todo/utils/blob/master/src/types/todo.ts#L36). \n\n| Param | Description |\n| --- | --- |\n| maybeTodos | The linting data for violations. |\n| existing | Existing todo lint data. |\n| options | An object containing write options. |\n\n\n\n## applyTodoChanges(baseDir, add, remove, shouldLock)\nApplies todo changes, either adding or removing, based on batches from `getTodoBatches`.\n\n**Kind**: global function \n\n| Param | Default | Description |\n| --- | --- | --- |\n| baseDir | | The base directory that contains the .lint-todo storage file. |\n| add | | Batch of todos to add. |\n| remove | | Batch of todos to remove. |\n| shouldLock | true | True if the .lint-todo storage file should be locked, otherwise false. Default: true. |\n\n\n\n## compactTodoStorageFile(baseDir) ⇒\nCompacts the .lint-todo storage file.\n\n**Kind**: global function \n**Returns**: The count of compacted todos. \n\n| Param | Description |\n| --- | --- |\n| baseDir | The base directory that contains the .lint-todo storage file. |\n\n\n\n## getTodoConfig(baseDir, engine, customDaysToDecay) ⇒\nGets the todo configuration from one of a number of locations.\n\n**Kind**: global function \n**Returns**: - The todo config object. \n\n| Param | Description |\n| --- | --- |\n| baseDir | The base directory that contains the project's package.json. |\n| engine | The engine for this configuration, eg. eslint |\n| customDaysToDecay | The optional custom days to decay configuration. |\n\n**Example** \nUsing the package.json\n```json\n{\n \"lintTodo\": {\n \"some-engine\": {\n \"daysToDecay\": {\n \"warn\": 5,\n \"error\": 10\n },\n \"daysToDecayByRule\": {\n \"no-bare-strings\": { \"warn\": 10, \"error\": 20 }\n }\n }\n }\n}\n```\n**Example** \nUsing the .lint-todorc.js file\n```js\nmodule.exports = {\n \"some-engine\": {\n \"daysToDecay\": {\n \"warn\": 5,\n \"error\": 10\n },\n \"daysToDecayByRule\": {\n \"no-bare-strings\": { \"warn\": 10, \"error\": 20 }\n }\n }\n}\n```\n**Example** \n```js\nUsing environment variables (`TODO_DAYS_TO_WARN` or `TODO_DAYS_TO_ERROR`)\n\t- Env vars override package.json config\n```\n**Example** \n```js\nPassed in directly, such as from command line options.\n\t- Passed in options override both env vars and package.json config\n```\n\n\n## validateConfig(baseDir) ⇒\nValidates whether we have a unique config in a single location.\n\n**Kind**: global function \n**Returns**: A ConfigValidationResult that indicates whether a config is unique \n\n| Param | Description |\n| --- | --- |\n| baseDir | The base directory that contains the project's package.json. |\n\n\n\n## getSeverity(todo, today) ⇒\nReturns the correct severity level based on the todo data's decay dates.\n\n**Kind**: global function \n**Returns**: Severity - the lint severity based on the evaluation of the decay dates. \n\n| Param | Description |\n| --- | --- |\n| todo | The todo data. |\n| today | A number representing a date (UNIX Epoch - milliseconds) |\n\n\n\n## isExpired(date, today) ⇒\nEvaluates whether a date is expired (earlier than today)\n\n**Kind**: global function \n**Returns**: true if the date is earlier than today, otherwise false \n\n| Param | Description |\n| --- | --- |\n| date | The date to evaluate |\n| today | A number representing a date (UNIX Epoch - milliseconds) |\n\n\n\n## getDatePart(date) ⇒\nConverts a date to include year, month, and day values only (time is zeroed out).\n\n**Kind**: global function \n**Returns**: Date - A date with the time zeroed out eg. '2021-01-01T08:00:00.000Z' \n\n| Param | Description |\n| --- | --- |\n| date | The date to convert |\n\n\n\n## differenceInDays(startDate, endDate) ⇒\nReturns the difference in days between two dates.\n\n**Kind**: global function \n**Returns**: a number representing the days between the dates \n\n| Param | Description |\n| --- | --- |\n| startDate | The start date |\n| endDate | The end date |\n\n\n\n## format(date) ⇒\nFormats the date in short form, eg. 2021-01-01\n\n**Kind**: global function \n**Returns**: A string representing the formatted date \n\n| Param | Description |\n| --- | --- |\n| date | The date to format |\n\n\n\n## buildRange(line, column, endLine, endColumn) ⇒\nConverts node positional numbers into a Range object.\n\n**Kind**: global function \n**Returns**: A range object. \n\n| Param | Description |\n| --- | --- |\n| line | The source start line. |\n| column | The source start column. |\n| endLine | The source end line. |\n| endColumn | The source end column. |\n\n\n\n## readSource(filePath) ⇒\nReads a source file, optionally caching it if it's already been read.\n\n**Kind**: global function \n**Returns**: The file contents. \n\n| Param | Description |\n| --- | --- |\n| filePath | The path to the source file. |\n\n\n\n## getSourceForRange(source, range) ⇒\nExtracts a source fragment from a file's contents based on the provided Range.\n\n**Kind**: global function \n**Returns**: The source fragment. \n\n| Param | Description |\n| --- | --- |\n| source | The file contents. |\n| range | A Range object representing the range to extract from the file contents. |\n\n\n\n","readmeFilename":"README.md"}