-
Notifications
You must be signed in to change notification settings - Fork 237
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into ensuring-new-rule-setup-is-correct
- Loading branch information
Showing
77 changed files
with
5,151 additions
and
869 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Release | ||
|
|
||
| Releases are mostly automated using | ||
| [release-it](https://github.com/release-it/release-it/) and | ||
| [lerna-changelog](https://github.com/lerna/lerna-changelog/). | ||
|
|
||
|
|
||
| ## Preparation | ||
|
|
||
| Since the majority of the actual release process is automated, the primary | ||
| remaining task prior to releasing is confirming that all pull requests that | ||
| have been merged since the last release have been labeled with the appropriate | ||
| `lerna-changelog` labels and the titles have been updated to ensure they | ||
| represent something that would make sense to our users. Some great information | ||
| on why this is important can be found at | ||
| [keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall | ||
| guiding principles here is that changelogs are for humans, not machines. | ||
|
|
||
| When reviewing merged PR's the labels to be used are: | ||
|
|
||
| * breaking - Used when the PR is considered a breaking change. | ||
| * enhancement - Used when the PR adds a new feature or enhancement. | ||
| * bug - Used when the PR fixes a bug included in a previous release. | ||
| * documentation - Used when the PR adds or updates documentation. | ||
| * internal - Used for internal changes that still require a mention in the | ||
| changelog/release notes. | ||
|
|
||
|
|
||
| ## Release | ||
|
|
||
| Once the prep work is completed, the actual release is straight forward: | ||
|
|
||
| ``` | ||
| yarn install | ||
| yarn release | ||
| ``` | ||
|
|
||
| The `release` script leverages | ||
| [release-it](https://github.com/release-it/release-it/) to do the mechanical | ||
| release process. It will prompt you through the process of choosing the version | ||
| number, tagging, pushing the tag and commits, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| ## Ignore support | ||
|
|
||
| You can tell the linter to ignore individual files or entire directories with the `ignore` option. | ||
|
|
||
| The ignore option takes an array of strings that either match exact modules or glob-match multiple modules. | ||
|
|
||
| * **module** -- `'app/templates/exceptional-page'` | ||
| * **glob** -- `'app/templates/components/odd-ones/**'` | ||
|
|
||
| ### Sample configuration | ||
|
|
||
| ```javascript | ||
| module.exports = { | ||
| extends: 'recommended', | ||
|
|
||
| ignore: [ | ||
| 'project-name/templates/login', | ||
| 'project-name/templates/components/odd-ones/**', | ||
| 'app/templates/login', | ||
| 'app/templates/components/odd-ones/**', | ||
| ] | ||
| }; | ||
| ``` | ||
|
|
||
| ### Why are patterns duplicated? | ||
|
|
||
| You may have noticed in the sample configuration that the four patterns are actually two patterns repeated with different prefixes. | ||
|
|
||
| This is because `ember-template-lint` works directly with the filesystem and is not aware | ||
| of the applications module prefix, however `ember-cli-template-lint` works within the build | ||
| pipeline of your application which is not aware of the original file paths since all modules | ||
| are within your applications module prefix by the time it is ran. | ||
| **_tldr;_** The `app/...` patterns match the filesystem (app directory). The `project-name/...` patterns match Ember's resolver (`ENV.modulePrefix` in `config/environment.js`). | ||
|
|
||
| After [Module Unification](https://github.com/emberjs/ember.js/issues/16373), Ember's internal resolver will match the filesystem, so ignore patterns will no longer need to be repeated. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| ## (rule name goes here) | ||
|
|
||
| (context about the problem goes here) | ||
|
|
||
| (what the rule does goes here) | ||
|
|
||
| ### Examples | ||
|
|
||
| This rule **forbids** the following: | ||
|
|
||
| ```hbs | ||
| {{! Example 1 }} | ||
| ``` | ||
|
|
||
| ```hbs | ||
| {{! Example 2 }} | ||
| ``` | ||
|
|
||
| This rule **allows** the following: | ||
|
|
||
| ```hbs | ||
| {{! Example 1 }} | ||
| ``` | ||
|
|
||
| ```hbs | ||
| {{! Example 2 }} | ||
| ``` | ||
|
|
||
| ### Migration | ||
|
|
||
| (suggest any fast/automated techniques for fixing violations in a large codebase) | ||
|
|
||
| * suggestion on how to fix violations using find-and-replace / regexp | ||
| * suggestion on how to fix violations using a codemod | ||
|
|
||
| ### Configuration | ||
|
|
||
| (exclude this section if the rule has no extra configuration) | ||
|
|
||
| * object -- containing the following properties: | ||
| * string -- `parameterName1` -- description of parameter including the possible values and default value | ||
| * boolean -- `parameterName2` -- description of parameter including the possible values and default value | ||
|
|
||
| ### Related Rules | ||
|
|
||
| * [related-rule-name1](related-rule-name1.md) | ||
| * [related-rule-name2](related-rule-name2.md) | ||
|
|
||
| ### References | ||
|
|
||
| * (link to relevant documentation goes here) | ||
| * (link to relevant function spec goes here) | ||
| * (link to relevant guide goes here) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| ## no-abstract-roles | ||
|
|
||
| The HTML attribute `role` must never have the following values: | ||
|
|
||
| * `command` | ||
| * `composite` | ||
| * `input` | ||
| * `landmark` | ||
| * `range` | ||
| * `roletype` | ||
| * `section` | ||
| * `sectionhead` | ||
| * `select` | ||
| * `structure` | ||
| * `widget` | ||
| * `window` | ||
|
|
||
| ### `<* role>` | ||
|
|
||
| This rule **forbids** the following: | ||
|
|
||
| ```hbs | ||
| <div role="window"> Hello, world! </div> | ||
| ``` | ||
|
|
||
| This rule **allows** the following: | ||
|
|
||
| ```hbs | ||
| <div role="button"> Push it </div> | ||
| ``` | ||
|
|
||
| ### References | ||
| * See [https://www.w3.org/TR/wai-aria-1.0/roles#abstract_roles](https://www.w3.org/TR/wai-aria-1.0/roles#abstract_roles) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.