Have ideas to improve npm?Join in the discussion! »

ember-template-lint

2.16.0 • Public • Published

ember-template-lint

npm version Build Status

ember-template-lint will lint your handlebars template and return error results.

For example, given the rule no-bare-strings is enabled, this template would be in violation:

{{!-- app/components/my-thing/template.hbs  --}}
<div>A bare string</div>

When the ember-template-lint executable is run, we would have a single result indicating that the no-bare-strings rule found an error.

Installation

This addon is installed by default with new Ember apps, so check your package.json before installing to see if you need to install it.

To install ember-template-lint

With npm:

npm install --save-dev ember-template-lint

With yarn:

yarn add ember-template-lint --dev

Node.js 10 || >=12 is required.

Usage

While ember-template-lint does have a Node API, the main way to use it is through its executable, which is intended to be installed locally within a project.

Basic usage is as straightforward as

ember-template-lint .

Workflow Examples

Basic usage with a single file

ember-template-lint "app/templates/application.hbs"

Output errors with source description

ember-template-lint "app/templates/application.hbs" --verbose

Multiple file/directory/wildcard paths are accepted

ember-template-lint "app/templates/components/**/*" "app/templates/application.hbs"

Output errors as pretty-printed JSON string

ember-template-lint "app/templates/application.hbs" --json

Ignore warnings / only report errors

ember-template-lint "app/templates/application.hbs" --quiet

Define custom config path

ember-template-lint "app/templates/application.hbs" --config-path .my-template-lintrc.js

Read from stdin

ember-template-lint --filename app/templates/application.hbs < app/templates/application.hbs

Print list of formatted rules for use with pending in config file

ember-template-lint "app/templates/application.hbs" --print-pending

Specify custom ignore pattern ['**/dist/**', '**/tmp/**', '**/node_modules/**'] by default

ember-template-lint "/tmp/template.hbs" --ignore-pattern "**/foo/**" --ignore-pattern "**/bar/**"

Disable ignore pattern entirely

ember-template-lint "/tmp/template.hbs" --no-ignore-pattern

Running a single rule without options

ember-template-lint --no-config-path app/templates --rule 'no-implicit-this:error'

Running a single rule with options

ember-template-lint --no-config-path app/templates --rule 'no-implicit-this:["error", { "allow": ["some-helper"] }]'

Running a single rule, disabling inline configuration

ember-template-lint --no-config-path app/templates --rule 'no-implicit-this:error' --no-inline-config

Specify a config object to use instead of what exists locally

ember-template-lint --config '{ "rules": { "no-implicit-this": { "severity": 2, "config": true } } }' test/fixtures/no-implicit-this-allow-with-regexp/app/templates

💡 Ensure you wrap all glob patterns in quotes so that it won't be interpreted by the CLI. ember-template-lint app/templates/** (this will expand all paths in app/templates) and ember-template-lint "app/templates/**" (this will pass the glob to ember-template-lint and not interpret the glob).

Configuration

Project Wide

You can turn on specific rules by toggling them in a .template-lintrc.js file at the base of your project, or at a custom relative path which may be identified using the CLI:

module.exports = {
  extends: 'recommended',

  rules: {
    'no-bare-strings': true,
  },
};

For more detailed information see configuration.

Presets

Name Description
recommended enables the recommended rules
🚗 octane extends the recommended preset by enabling Ember Octane rules
👗 stylistic enables stylistic rules for those who aren't ready to adopt ember-template-lint-plugin-prettier (including stylistic rules that were previously in the recommended preset in ember-template-lint v1)

Rules

Each rule has emojis denoting:

  • what configuration it belongs to
  • 🔧 if some problems reported by the rule are automatically fixable by the --fix command line option
Rule ID
attribute-indentation
👗 block-indentation
builtin-component-arguments
deprecated-each-syntax
deprecated-inline-view-helper
deprecated-render-helper
👗 eol-last
🔧 inline-link-to
👗 linebreak-style
link-href-attributes
🔧 link-rel-noopener
modifier-name-case
no-abstract-roles
🔧 no-accesskey-attribute
🚗 no-action
no-action-modifiers
no-args-paths
no-arguments-for-html-elements
🔧 no-aria-hidden-body
no-attrs-in-components
no-bare-strings
no-block-params-for-html-elements
🚗 no-curly-component-invocation
no-debugger
no-down-event-binding
no-duplicate-attributes
no-duplicate-id
no-duplicate-landmark-elements
no-element-event-actions
no-extra-mut-helper-argument
no-forbidden-elements
no-heading-inside-button
no-html-comments
🚗 no-implicit-this
no-index-component-invocation
no-inline-styles
no-input-block
no-input-tagname
no-invalid-block-param-definition
no-invalid-interactive
no-invalid-link-text
no-invalid-link-title
no-invalid-meta
no-invalid-role
no-link-to-tagname
no-log
🔧 no-model-argument-in-route-templates
👗 no-multiple-empty-lines
no-mut-helper
no-negated-condition
no-nested-interactive
no-nested-landmark
no-nested-splattributes
no-obsolete-elements
no-outlet-outside-routes
no-partial
no-passed-in-event-handlers
🔧 no-positional-data-test-selectors
no-positive-tabindex
no-potential-path-strings
no-quoteless-attributes
🔧 no-redundant-fn
🔧 no-redundant-landmark-role
no-restricted-invocations
no-shadowed-elements
👗 no-trailing-spaces
no-triple-curlies
no-unbalanced-curlies
no-unbound
no-unnecessary-component-helper
👗 no-unnecessary-concat
no-unused-block-params
no-whitespace-for-layout
no-whitespace-within-word
no-yield-only
👗 quotes
🔧 require-button-type
require-each-key
require-form-method
require-iframe-title
require-input-label
require-lang-attribute
require-valid-alt-text
👗 self-closing-void-elements
simple-unless
splat-attributes-only
style-concatenation
table-groups
template-length

Supporting the --fix option

You can add a fixer to a rule. See fixer documentation for more details.

Sharing configs

It is possible to share a config (extends) or plugin (custom rules) across projects. See ember-template-lint-plugin-peopleconnect for an example.

Defining your own rules

You can define and use your own custom rules using the plugin system. See plugin documentation for more details.

Semantic Versioning Policy

The semver policy for this addon can be read here: semver policy.

Contributing

See the Contributing Guidelines for information on how to help out.

License

This project is licensed under the MIT License.

Keywords

none

Install

npm i ember-template-lint

DownloadsWeekly Downloads

76,539

Version

2.16.0

License

MIT

Unpacked Size

495 kB

Total Files

135

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar