点球

dockerignore 是一个完全兼容 Docker 的文件过滤库 .dockerignore (英语) 文件,揭露 和流行的API一样 忽略 软件包 .gitignore 格式.

dockerignore 还有:

• 可与Linux,macOS和Windows相兼容.
• 与 0 外部依赖关系( 生产安装) 收缩 .
• 纯 Javascript 移植多克戈兰g 执行 .dockerignore 格式.
• 测试过几百个测试案例 包括比较实际行为 联 合 国 docker build 在 Windows 和 Linux 上.
• 在生产环境中依靠 巴莱纳克利, (中文(简体) ), 现在 - cli 以及围绕多克建造的其他重要项目.

何等为相 ignore? 吗?

这个 .dockerignore spec 与 .gitignore数字 :

• * 内 .gitignore 匹配所有东西,而 .dockerignore 它只匹配文件中的文件 当前目录( 如 glob) 。 当一个名字被删除时,这种区别很重要 * 规则.
• abc 内 .gitignore 全部匹配 abc 文档和目录,无论嵌入程度如何 内 .dockerignore 仅在 ./abc 而不是在子目录中 ./somedir/abc。 。 。 .
• 与 .gitignore,当父目录被忽略时,子目录不能被重新添加(使用 !自此以来 git 只是避免走过树下作为优化。 与 .dockerignore,即使父目录被忽略,子目录也可以被重新添加.
• 完整差异列表请查看 .吉提格诺尔 光谱 编辑 .dockerignore (英语) 光谱。 。 。 .

何等为相 ignore? 吗?

整个API. dockerignore 作为叉子开始 节点,甚至重复使用同样的 index.d.ts 文件 用于类型脚本定义。 在引擎盖下, node-ignore匹配逻辑被重写为紧密 匹配 Docker 的执行( 模式主要围绕 (原始内容存档于2018-09-21) (英语). dockerignore. go 财务报告和审定财务报表 fileutils.go 存档副本) (中文(简体) ).

兼容性

dockerignore 与Node.js版本8及以上合作,在Linux,macOS和Windows上. 代码由 宝贝。 。 。 .

安装

npm install --save @balena/dockerignore

使用量

const ignore = require('@balena/dockerignore')
const ig = ignore().add(['.abc/*', '!.abc/d/'])

还列入了打字类型定义:

import ignore from '@balena/dockerignore'
const ig = ignore().add(['.abc/*', '!.abc/d/'])

过滤给定路径

const paths = [
  '.abc/a.js',    // filtered out
  '.abc/d/e.js'   // included
]

ig.filter(paths)        // ['.abc/d/e.js']
ig.ignores('.abc/a.js') // true

作为过滤功能

paths.filter(ig.createFilter()); // ['.abc/d/e.js']

支持窗口路径

ig.filter(['.abc\\a.js', '.abc\\d\\e.js'])
// if the code above runs on windows, the result will be
// ['.abc\\d\\e.js']

后鞭打 文选. 前斜线

dockerignore 行为与 Docker CLI ("docker building") 相对反斜(\(中文(简体) ) 和前斜线/)字符:

这意味着,前向鞭可以用于 .dockerignore 跨平台文件 兼容性。 这与Windows的一般工作方式一致:前向鞭打 命令提示(cmd.exe)或 PowerShell和戈兰等图书馆功能 文件路径 。 干净 或节点.js 路径。 。 。 .

使用回击作为逃生字符(只有Linux 和 macOS )在 .dockerignore 规格。 "可容忍"的用法可能是为了躲避少数人物 具有特殊的意义 .dockerignore 文档,即 "*#!\" (不包括双引号),, 相对于在 常设经常 表达式 总的来说。 任何其他角色的"逃脱"行为(如. '\\b'未定义和主题 对具体执行的解释可能随时改变.

绝对路径

引导和后导鞭打(或Windows上的回击)从中去除 .dockerignore 模式, 这样 '/a', (中文(简体) ), 'a/' 财务报告和审定财务报表 '/a/' 均相当于 'a' 在一个 .dockerignore 文件,他们都 在匹配相对路径时锁定“ 最左” 目录 。 例如,图案 'a' 与 'x' 对于给定的路径 'x/y/z'。这是多克在戈兰实施 兼容性。 反之,一个给定的绝对路径将无法匹配一个非模糊的图案. 再来 实例:

  ignore().add('a').ignores('a')    // true
  ignore().add('/a').ignores('a')   // true
  ignore().add('/a/').ignores('a')  // true
  ignore().add('a').ignores('/a')   // false
  ignore().add('/a').ignores('/a')  // false
  ignore().add('/a/').ignores('/a') // false

考虑采用斜拉式去除方式,可将上述情况减少到:

  ignore().add('a').ignores('a')  // true
  ignore().add('a').ignores('/a') // false

这些例子的'假'结果可能似乎与"docker building"的行为不符,何时 docker 文件的源参数 异常值 或者说 警务 指令是绝对路径 (从一刀起. 解释是,插头将绝对源路径转换为相对 路径( 相对于“ 构建上下文 ” ) 在模式匹配之前 : https://github.com/moby/moby/blob/v19.03.8/pkg/archive/archive.go#L806 (英语) https://github.com/moby/moby/blob/v19.03.8/pkg/archive/archive.go#L825 (英语)

...同时 dockerignore 镜像模式匹配器本身的执行。 建议是 对于您的应用程序,其操作方式与多克CLI相同:使用相对路径进行模式匹配. 这在不同的环境中一般也更为便携:开发机、CI 管道、服务器或终端用户设备.

评论

开始的图案 '#' (hash)作为评论被忽略. 散列可以使用前缀 为匹配同样以散列开头的文件名而切换或反切:

ignore().add('#abc').ignores('#abc')   // false
ignore().add('/#abc').ignores('#abc')  // true
ignore().add('\\#abc').ignores('#abc') // true

之所以成功,是因为从图例中取消了 绝对 路径。 。 。 .

排除模式

从模式开始 '!' (感叹标记)将匹配排除(例外)定义为 记录 .dockerignore (英语) 规格用于 兼容 Docker 执行, 模式从 '/!' 或者说 '!/' (但无) '/!/')还将被视为排斥模式,此外,在《公约》中描述的切除 绝对路径。反斜线以 '\\!' 用于匹配 以感叹标记开头的文件或目录名称, 但这只能在 Linux 上使用 和macOS,不在Windows上。 再说一遍,它只是为了和多克的兼容 执行.

选项

匹配默认情况下对大小写不敏感, 跟随 ignore API 密码 (单位:千美元)忽略大小写) (中文(简体) ). 但请注意, Docker 执行对大小写敏感的匹配 . 使用 ignorecase: false 选项与 Docker 行为一致:

const ig = ignore({ ignorecase: false }) // for case-sensitive matching

方法

添加( 模式)

添加( 标签)

• 模式 String|Ignore 忽略模式字符串,或 Ignore 实例
• 模式 Array.<pattern> 忽略图案的组合 .

在当前管理器中添加一条规则或若干条规则.

回返 this

pattern 可能是一行被忽略的图案 也可能是一串被忽略的图案 也就是说我们可以 ignore().add() 忽略文件的内容 :

ignore()
.add(fs.readFileSync(filenameOfGitignore).toString())
.filter(filenames)

pattern 也可能是一个 ignore 那样我们就能轻易继承别人的规则 Ignore 举个例子.

.ignores(路径名)

回返 Boolean 是否为 pathname 应被忽略.

ig.ignores('.abc/a.js')    // true

.filter(路径)

过滤给定的路径名数组,并返回被过滤的数组.

• 路径 Array.<path> 数组 pathnames被过滤.

创建Filter ()

创建过滤功能,该功能可以使用 Array.prototype.filter。 。 。 .

回返 function(path) 过滤功能.

捐款

总是欢迎捐款!

1. 把这个寄存器分叉到您自己的 GitHub 账户, 然后复制到您的本地设备 .
2. 安装依赖性 : npm install
3. 添加测试大小写( 如果适用) 并确保当前失败
4. 添加代码以通过测试
5. 提出牵引请求(将在CI上进行额外测试,以确保测试案例符合实际) docker build(中文(简体) )

鸣谢

该项目的初步工作由普拉奈·普拉卡什完成 (单位:千美元)@ pranaygp (英语)) (中文(简体) ) 兹伊特张凯儿 (单位:千美元)@kaelzhang (中文(简体) ))和 节点 捐助者。 。 。 .

保罗·卡斯特罗(签名)@pdcastro (英语)) (中文(简体) ) 巴莱纳.io 2020年建立了储存库鼓励 泽特并放入一个 在Windows支持、跨平台相容和测试方面做出大量努力,最终发布 1.0.0 (中文(简体) ).