@ember-template-lint/todo-utils

收集各种公用事业,以生成和储存物品元数据.

这些公用事业是:

职能

构建 TodoDatum(lintResult, lintMessage, todoConfig) 选项 ⇒

适应 a 林特结果 改为 待办文件文件页是绝对的 所以它们被转换成相对的路径 以获得稳定 将内容序列化为磁盘 .

待办的StorageFileExists( baseDir) 函数 ⇒

确定.lint-todo存储文件是否存在.

保证 TodoStorageFile( 碱基) ⇒

创建或确保创建.lint-todo文件.

获取 TodoStorageFilePath( baseDir) ⇒

有冲突( 待办事宜) ⇒

确定.lint-todo存储文件是否有冲突 .

解决冲突(行动) ⇒

通过去掉任何匹配冲突标记的行来解决待办事宜中的 git 冲突.

已读取 TodoStorageFile( 已读取 StorageFilePath ) ⇒

读取.lint-todo存储文件.

写入 TodoStorageFile( 用于 doStorageFilePath, 操作)

将操作写入.lint-todo存储文件到todoStorageFilePath提供的路径.

写入 Todos( baseDir, 也许 Todos, 选项) ⇒

为待办事宜写入文件 。 使用生成的文件生成一个文件 散列以识别每个.

鉴于一个待办事项列表, 此功能也将删除已不存在的文件 还要做点什么.

已读取 Todos( baseDir, shouldLock) ⇒

在.lint-todo目录中读取所有待办文件.

已读取 TodosForFilePath (todoStorageDir, filePath, shouldLock) ⇒

在.lint-todo目录中读取特定文件Path的待办文件.

已读取 TodoData( baseDir) ⇒

读取.lint-todo目录中的待办文件并返回数组中的待办文件.

获取todo Batches( 可能是todos, 已有, 选项) ⇒

获得包含待办事宜项目的4个地图来添加,去除,过期的,或稳定(不修改)的.

应用 Todo Changes( baseDir, 添加、 删除、 shouldLock)

应用基于批次的添加或去除的待办事宜更改 getTodoBatches。 。 。 .

ADD 操作 ONLY(操作) ⇒

压缩策略只可在待办事宜存储文件中添加操作 .

EXCLUDE EXPERED( 操作) ⇒

从待办事宜存储文件中删除所有已过期操作的压缩策略 .

contract TodoStorageFile( BaseDir, ContractStrategy) (压缩战略) ⇒

根据紧凑策略压缩.lint-todo存储文件.

获取 TodoConfig( baseDir, 引擎, 自定义 Days ToDecay) ⇒

获得待办事宜配置. 配置值可以在

包裹。 。

验证 Config( baseDir) ⇒

验证我们是否在一个地点有一个独特的配置 .

获取Severity( 今天要做) ⇒

根据待办事宜数据的衰减日期返回正确的重度级别.

已过期( 日期, 今天) ⇒

评估日期是否过期( 比今天提前)

获取数据部分( 日期) ⇒

将日期转换为仅包含年份、月份和天数值(时间为零).

inDays( 开始日期, 结束日期) ⇒

返回两个日期之间的天数相差.

格式(日期) ⇒

以短格式格式格式格式化日期, 例如 2021-01-01

构建 TodoDatum(lintResult, lintMessage, todoConfig) QQ

适应 a 林特结果 改为 待办文件文件页是绝对的 所以它们被转换成相对的路径 以获得稳定 将内容序列化为磁盘 .

仁爱:全球职能
回返- A级 待办文件 对象.

要完成的StorageFileExists( baseDir) QQ

确定.lint-todo存储文件是否存在.

仁爱:全球职能
回返: - 如果待办事宜存储文件存在, 则为真, 否则为假 .

保证 TodoStorageFile( baseDir) QQ

创建或确保创建.lint-todo文件.

仁爱:全球职能
回返: - 待办事宜存储文件路径.

获取 TodoStorageFilePath( baseDir) QQ

仁爱:全球职能
回返: - 待办事宜存储文件路径.

有冲突(待处理事项)

确定.lint-todo存储文件是否有冲突 .

仁爱:全球职能
回返: 如果文件有冲突, 则为真, 否则为假 .

解决冲突(行动)

通过去掉任何匹配冲突标记的行来解决待办事宜中的 git 冲突.

仁爱:全球职能
回返:一系列字符串操作,不包括任何被确定为git冲突线的操作.

已读取 TodoStorageFile( 已读取 StorageFilePath) @%

读取.lint-todo存储文件.

仁爱:全球职能
回返: 一系列待办事宜操作.

写入 TodoStorageFile( 用于 doStorageFilePath, 操作)

将操作写入.lint-todo存储文件到todoStorageFilePath提供的路径.

仁爱:全球职能

写入 Todos( baseDir, 也许 Todos, 选项) QQ

为待办事宜写入文件 。 使用生成的文件生成一个文件 散列以识别每个.

鉴于一个待办事项列表, 此功能也将删除已不存在的文件 还要做点什么.

仁爱:全球职能
回返: - 添加和去除的待办事宜的计数.

已读取 Todos( baseDir, shouldLock) QQ

在.lint-todo目录中读取所有待办文件.

仁爱:全球职能
回返- A级 地图 联 合 国 文件路径编号 :托多马彻。 。 。 .

已读取 TodosForFilePath (todoStorageDir, filePath, shouldLock) QQ

在.lint-todo目录中读取特定文件Path的待办文件.

仁爱:全球职能
回返- A级 地图 联 合 国 文件路径编号 :托多马彻。 。 。 .

已读取 TodoData (baseDir) QQ

读取.lint-todo目录中的待办文件并返回数组中的待办文件.

仁爱:全球职能
回返: 数组 待办文件

获取 Todo Batches( 可能是todos, 已有, 选项) QQ

获得包含待办事宜项目的4个地图来添加,去除,过期的,或稳定(不修改)的.

仁爱:全球职能
回返- 对象: 托多贝奇。 。 。 .

应用 Todo Changes( baseDir, 添加、 删除、 shouldLock)

应用基于批次的添加或去除的待办事宜更改 getTodoBatches。 。 。 .

仁爱:全球职能

ADD Operations ONLY(操作)

压缩策略只可在待办事宜存储文件中添加操作 .

仁爱:全球职能
回返: 如果行与添加操作相匹配, 否则是虚假的 .

EXCLUDE EXPERED( 操作) QX

从待办事宜存储文件中删除所有已过期操作的压缩策略 .

仁爱:全球职能
回返: 如果操作没有过期, 否则是虚假的 .

压缩 TodoStorageFile( BaseDir, 压缩战略) QQ

根据紧凑策略压缩.lint-todo存储文件.

仁爱:全球职能
回返:收缩的托多斯数.

获取 TodoConfig( baseDir, 引擎, 自定义 DaysToDecay) QQ

获得待办事宜配置. 配置值可以在

包裹。 。

仁爱:全球职能
回返: - 待办配置对象.

示例

{
  "lintTodo": {
    "some-engine": {
      "daysToDecay": {
        "warn": 5,
        "error": 10
      },
      "daysToDecayByRule": {
        "no-bare-strings": { "warn": 10, "error": 20 }
      }
    }
  }
}

一个.lint-todorc.js文件 示例

module.exports = {
  "some-engine": {
    "daysToDecay": {
      "warn": 5,
      "error": 10
    },
    "daysToDecayByRule": {
      "no-bare-strings": { "warn": 10, "error": 20 }
    }
  }
}

环境变量TODO_DAYS_TO_WARN 或者说 TODO_DAYS_TO_ERROR(中文(简体) ) - Env vars 覆盖软件包. json 配置

直接通过,例如从命令行选项. - 在选项中超过 env vars 和 package.json 配置

校验 Config( baseDir) {}

验证我们是否在一个地点有一个独特的配置 .

仁爱:全球职能
回返: 表示配置是否独一无二的配置结果

获得Severity( 今天要完成) QQ

根据待办事宜数据的衰减日期返回正确的重度级别.

仁爱:全球职能
回返: Severity - 根据衰变日期的评价得出的Lint严重性.

已过期( 日期, 今天) @% 1

评估日期是否过期( 比今天提前)

仁爱:全球职能
回返: 如果日期早于今天, 否则是虚假的

获得DatePart( 日期) QQ

将日期转换为仅包含年份、月份和天数值(时间为零).

仁爱:全球职能
回返: 日期 - 时间为零的日期 eg. '2021-01-01T08:00:00.000Z' (中文(简体) )

inDays( 开始日期, 结束日期) QQ

返回两个日期之间的天数相差.

仁爱:全球职能
回返: 代表日期之间天数的数字

页:1

以短格式格式格式格式化日期, 例如 2021-01-01

仁爱:全球职能
回返: 代表格式化日期的字符串