@addepar/ember-toolbox 中文文档教程

发布于 3 年前 浏览 3 项目主页 更新于 3 年前

Build Status

@addepar/ember-toolbox

Addepar Ember Toolbox 提供了许多命令来检查和确保 Ember 项目的一贯风格。

  • ember adde-lint --javascript --sass --file-names: Runs our linting checks against the specified files. If no files are specified, runs them against the entire repo. Using adde-lint to line filenames is deprecated, use adde-lint-file-names instead.
  • ember adde-format: Formats the files specified, or if none are specified formats the entire repo.
  • ember adde-pre-commit: Deprecated, use adde-pre-commit bin script instead.
  • adde-pre-commit: bin script that Runs our formatting and linting checks against staged changes

- adde-lint-file-names: bin script provided by this package that lints the passed (via command line) filepaths

安装此插件还将添加样式指南作为依赖项,设置预提交 在使用 Husky 提交之前挂钩格式/lint 更改的文件, 并自动格式化其安装的存储库。

Installation

ember install @addepar/ember-toolbox

Running

Running Tests

  • npm test (Runs ember try:each to test your addon against multiple Ember versions)
  • ember test
  • ember test --server

Building

  • ember build

有关使用 ember-cli 的更多信息,请访问 https://ember-cli.com/ .

Linting File Names

adde-lint-file-names 对命令行上传递的文件名进行 lints。 文件名必须作为绝对路径传递。

文件名 linting:

  • first strips off the process.cwd(), which is assumed to be the ember app root directory
  • excludes files that are not in typical Ember-app directory-layout spots (see below)
  • Checks each remaining filepath against a regex

Lint Filename Regex

有关完整详细信息,请参阅 lib/lint-file-names.js 文件。 有关文件名 linting 的规则是:

  • directories must start with lowercase alphanumeric (with optional starting "@"),
  • filenames must start with either lowercase alphanumeric or "_","-" or "."
  • filenames cannot include "_" except for the first character
Bad examples:
_badDir/xyz.js (dir doesn't start with alphanumeric)
BadDir/xyz.js (dir starts with capital)
okDir/Bad.js (file starts with capital)
okDir/Bad.js (file starts with capital)
okDir/bad_file.js (file includes _ after first character)
Good examples:
ok/.file.js
ok/-file.js
ok/ok-file.js
ok/\_file.js
ok/file.js
@ok/file.js

要以交互方式尝试正则表达式,请访问 https://regexr.com/5tn2c。

Build Status

@addepar/ember-toolbox

Addepar Ember Toolbox provides a number of commands for linting and ensuring consistent style of Ember projects.

  • ember adde-lint --javascript --sass --file-names: Runs our linting checks against the specified files. If no files are specified, runs them against the entire repo. Using adde-lint to line filenames is deprecated, use adde-lint-file-names instead.
  • ember adde-format: Formats the files specified, or if none are specified formats the entire repo.
  • ember adde-pre-commit: Deprecated, use adde-pre-commit bin script instead.
  • adde-pre-commit: bin script that Runs our formatting and linting checks against staged changes

- adde-lint-file-names: bin script provided by this package that lints the passed (via command line) filepaths

Installing this addon will also add styleguides as dependencies, set up a pre-commit hook to format/lint changed files before commits using Husky, and automatically format the repo its installed in.

Installation

ember install @addepar/ember-toolbox

Running

Running Tests

  • npm test (Runs ember try:each to test your addon against multiple Ember versions)
  • ember test
  • ember test --server

Building

  • ember build

For more information on using ember-cli, visit https://ember-cli.com/.

Linting File Names

adde-lint-file-names lints the file names that are passed on the command line. File names must be passed as absolute paths.

The file name linting:

  • first strips off the process.cwd(), which is assumed to be the ember app root directory
  • excludes files that are not in typical Ember-app directory-layout spots (see below)
  • Checks each remaining filepath against a regex

Lint Filename Regex

See the lib/lint-file-names.js file for full details. The rules regarding filename linting are:

  • directories must start with lowercase alphanumeric (with optional starting "@"),
  • filenames must start with either lowercase alphanumeric or "_","-" or "."
  • filenames cannot include "_" except for the first character
Bad examples:
_badDir/xyz.js (dir doesn't start with alphanumeric)
BadDir/xyz.js (dir starts with capital)
okDir/Bad.js (file starts with capital)
okDir/Bad.js (file starts with capital)
okDir/bad_file.js (file includes _ after first character)
Good examples:
ok/.file.js
ok/-file.js
ok/ok-file.js
ok/\_file.js
ok/file.js
@ok/file.js

To try the regex interactively, visit https://regexr.com/5tn2c.

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文