@ember-template-lint/todo-utils

@ember-template-lint/todo-utils

A collection of utilities to generate and store lint item metadata.

Those utilities are:

Functions

buildTodoData(baseDir, lintResults, todoConfig) ⇒

Adapts a list of LintResult to a map of FilePath, TodoData.

_buildTodoDatum(lintResult, lintMessage, todoConfig) ⇒

Adapts an LintResult to a TodoData. FilePaths are absolute when received from a lint result, so they're converted to relative paths for stability in serializing the contents to disc.

todoStorageDirExists(baseDir) ⇒

Determines if the .lint-todo storage directory exists.

ensureTodoStorageDirSync(baseDir) ⇒

Creates, or ensures the creation of, the .lint-todo directory.

ensureTodoStorageDir(baseDir) ⇒

Creates, or ensures the creation of, the .lint-todo directory.

getTodoStorageDirPath(baseDir) ⇒

todoFilePathFor(baseDir, todoData) ⇒

Creates a file path from the linting data. Excludes extension.

todoDirFor(filePath) ⇒

Creates a short hash for the todo's file path.

todoFileNameFor(todoData) ⇒

Generates a unique filename for a todo lint data.

writeTodosSync(baseDir, lintResults, options) ⇒

Writes files for todo lint violations. One file is generated for each violation, using a generated hash to identify each.

Given a list of todo lint violations, this function will also delete existing files that no longer have a todo lint violation.

writeTodos(baseDir, lintResults, options) ⇒

Writes files for todo lint violations. One file is generated for each violation, using a generated hash to identify each.

Given a list of todo lint violations, this function will also delete existing files that no longer have a todo lint violation.

readTodosSync(baseDir) ⇒

Reads all todo files in the .lint-todo directory.

readTodos(baseDir) ⇒

Reads all todo files in the .lint-todo directory.

readTodosForFilePathSync(todoStorageDir, filePath) ⇒

Reads todo files in the .lint-todo directory for a specific filePath.

readTodosForFilePath(todoStorageDir, filePath) ⇒

Reads todo files in the .lint-todo directory for a specific filePath.

getTodoBatchesSync(lintResults, existing) ⇒

Gets 3 maps containing todo items to add, remove, or those that are stable (not to be modified).

getTodoBatches(lintResults, existing) ⇒

Gets 3 maps containing todo items to add, remove, or those that are stable (not to be modified).

applyTodoChangesSync(todoStorageDir, add, remove)

Applies todo changes, either adding or removing, based on batches from getTodoBatches.

applyTodoChanges(todoStorageDir, add, remove)

Applies todo changes, either adding or removing, based on batches from getTodoBatches.

getTodoConfig(baseDir, todoConfig) ⇒

Gets the todo configuration. Config values can be present in

The package.json

ensureTodoConfig(baseDir)

Ensures that a valid todo config exists in the project by writing one to the package.json if we're invoking the todos functionality for the first time (there is no .lint-todo directory).

writeTodoConfig(baseDir, todoConfig)

Writes a todo config to the package.json located at the provided baseDir.

getSeverity(todo, today) ⇒

Returns the correct severity level based on the todo data's decay dates.

getDatePart(date) ⇒

Converts a date to include year, month, and day values only (time is zeroed out).

buildTodoData(baseDir, lintResults, todoConfig) ⇒

Adapts a list of LintResult to a map of FilePath, TodoData.

Kind: global function
Returns: - A Promise resolving to a Map of FilePath/TodoData.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.
lintResults	A list of LintResult objects to convert to TodoData objects.
todoConfig	An object containing the warn or error days, in integers.

_buildTodoDatum(lintResult, lintMessage, todoConfig) ⇒

Adapts an LintResult to a TodoData. FilePaths are absolute when received from a lint result, so they're converted to relative paths for stability in serializing the contents to disc.

Kind: global function
Returns: - A TodoData object.

Param	Description
lintResult	The lint result object.
lintMessage	A lint message object representing a specific violation for a file.
todoConfig	An object containing the warn or error days, in integers.

todoStorageDirExists(baseDir) ⇒

Determines if the .lint-todo storage directory exists.

Kind: global function
Returns: - true if the todo storage directory exists, otherwise false.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.

ensureTodoStorageDirSync(baseDir) ⇒

Creates, or ensures the creation of, the .lint-todo directory.

Kind: global function
Returns: - The todo storage directory path.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.

ensureTodoStorageDir(baseDir) ⇒

Creates, or ensures the creation of, the .lint-todo directory.

Kind: global function
Returns: - A promise that resolves to the todo storage directory path.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.

getTodoStorageDirPath(baseDir) ⇒

Kind: global function
Returns: - The todo storage directory path.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.

todoFilePathFor(baseDir, todoData) ⇒

Creates a file path from the linting data. Excludes extension.

Kind: global function
Returns: - The todo file path for a TodoData object.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.
todoData	The linting data for an individual violation.

Example

42b8532cff6da75c5e5895a6f33522bf37418d0c/6e3be839

todoDirFor(filePath) ⇒

Creates a short hash for the todo's file path.

Kind: global function
Returns: - The todo directory for a specific filepath.

Param	Description
filePath	The filePath from linting data for an individual violation.

todoFileNameFor(todoData) ⇒

Generates a unique filename for a todo lint data.

Kind: global function
Returns: - The todo file name for a TodoData object.

Param	Description
todoData	The linting data for an individual violation.

writeTodosSync(baseDir, lintResults, options) ⇒

Writes files for todo lint violations. One file is generated for each violation, using a generated hash to identify each.

Given a list of todo lint violations, this function will also delete existing files that no longer have a todo lint violation.

Kind: global function
Returns: - The counts of added and removed todos.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.
lintResults	The raw linting data.
options	An object containing write options.

writeTodos(baseDir, lintResults, options) ⇒

Writes files for todo lint violations. One file is generated for each violation, using a generated hash to identify each.

Given a list of todo lint violations, this function will also delete existing files that no longer have a todo lint violation.

Kind: global function
Returns: - A promise that resolves to the counts of added and removed todos.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.
lintResults	The raw linting data.
options	An object containing write options.

readTodosSync(baseDir) ⇒

Reads all todo files in the .lint-todo directory.

Kind: global function
Returns: - A Map of FilePath/TodoData.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.

readTodos(baseDir) ⇒

Reads all todo files in the .lint-todo directory.

Kind: global function
Returns: - A Promise that resolves to a Map of FilePath/TodoData.

Param	Description
baseDir	The base directory that contains the .lint-todo storage directory.

readTodosForFilePathSync(todoStorageDir, filePath) ⇒

Reads todo files in the .lint-todo directory for a specific filePath.

Kind: global function
Returns: - A Map of FilePath/TodoData.

Param	Description
todoStorageDir	The .lint-todo storage directory.
filePath	The relative file path of the file to return todo items for.

readTodosForFilePath(todoStorageDir, filePath) ⇒

Reads todo files in the .lint-todo directory for a specific filePath.

Kind: global function
Returns: - A Promise that resolves to a Map of FilePath/TodoData.

Param	Description
todoStorageDir	The .lint-todo storage directory.
filePath	The relative file path of the file to return todo items for.

getTodoBatchesSync(lintResults, existing) ⇒

Gets 3 maps containing todo items to add, remove, or those that are stable (not to be modified).

Kind: global function
Returns: - A Map of FilePath/TodoData.

Param	Description
lintResults	The linting data for all violations.
existing	Existing todo lint data.

getTodoBatches(lintResults, existing) ⇒

Gets 3 maps containing todo items to add, remove, or those that are stable (not to be modified).

Kind: global function
Returns: - A Promise that resolves to a Map of FilePath/TodoData.

Param	Description
lintResults	The linting data for all violations.
existing	Existing todo lint data.

applyTodoChangesSync(todoStorageDir, add, remove)

Applies todo changes, either adding or removing, based on batches from getTodoBatches.

Kind: global function

Param	Description
todoStorageDir	The .lint-todo storage directory.
add	Batch of todos to add.
remove	Batch of todos to remove.

applyTodoChanges(todoStorageDir, add, remove)

Applies todo changes, either adding or removing, based on batches from getTodoBatches.

Kind: global function

Param	Description
todoStorageDir	The .lint-todo storage directory.
add	Batch of todos to add.
remove	Batch of todos to remove.

getTodoConfig(baseDir, todoConfig) ⇒

Gets the todo configuration. Config values can be present in

The package.json

Kind: global function
Returns: - The todo config object.

Param	Description
baseDir	The base directory that contains the project's package.json.
todoConfig	The optional todo configuration.

Example

{
  "lintTodo": {
    "daysToDecay": {
      "warn": 5,
      "error": 10
    }
  }
}

Environment variables (TODO_DAYS_TO_WARN or TODO_DAYS_TO_ERROR) - Env vars override package.json config

Passed in directly, such as from command line options. - Passed in options override both env vars and package.json config

ensureTodoConfig(baseDir)

Ensures that a valid todo config exists in the project by writing one to the package.json if we're invoking the todos functionality for the first time (there is no .lint-todo directory).

Kind: global function

Param	Description
baseDir	The base directory that contains the project's package.json.

writeTodoConfig(baseDir, todoConfig)

Writes a todo config to the package.json located at the provided baseDir.

Kind: global function

Param	Description
baseDir	The base directory that contains the project's package.json.
todoConfig	The todo configuration to write to the package.json.

getSeverity(todo, today) ⇒

Returns the correct severity level based on the todo data's decay dates.

Kind: global function
Returns: Severity - the lint severity based on the evaluation of the decay dates.

Param	Description
todo	The todo data.
today	A number representing a date (UNIX Epoch - milliseconds)

getDatePart(date) ⇒

Converts a date to include year, month, and day values only (time is zeroed out).

Kind: global function
Returns: Date - A date with the time zeroed out eg. '2021-01-01T08:00:00.000Z'

Param	Description
date	The date to convert