Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #4

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 30 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,38 +7,37 @@ Apply the aurelia template lint loader as pre/postLoader in your webpack configu
``` javascript
module.exports = {
module: {
preLoaders: [
{
test: /\.html$/,
loader: "aurelia-template-lint-loader"
}
]
rules: [ { test: /\.html$/, enforce: 'pre', use: "aurelia-template-lint-loader" } ]
},
// more options in the optional aureliaTemplateLinter object
aureliaTemplateLinter: {
// you can pass an configuration class
// config reference https://github.com/MeirionHughes/aurelia-template-lint#config
configuration: options && options.config,

// aurelia errors are displayed by default as warnings
// set emitErrors to true to display them as errors
emitErrors: false,

// aurelia does not interrupt the compilation by default
// if you want any file with aurelia errors to fail
// set failOnHint to true
failOnHint: true,

// aurelia does not type check by default
// if you want to do type checking set
// typeChecking to true and provide
// the right fileGlob
// reference https://github.com/MeirionHughes/aurelia-template-lint#static-type-checking
// these settings can also be passed with configuration above
typeChecking: true,
fileGlob: 'path/to/app-source'

}
plugins: [
new webpack.LoaderOptionsPlugin({
options: {
aureliaTemplateLinter: {
// you can pass an configuration class
// config reference https://github.com/MeirionHughes/aurelia-template-lint#config
configuration: options && options.config,

// aurelia errors are displayed by default as warnings
// set emitErrors to true to display them as errors
emitErrors: true,

// aurelia does not interrupt the compilation by default
// if you want any file with aurelia errors to fail
// set failOnHint to true
failOnHint: true,

// aurelia does not type check by default
// if you want to do type checking set
// typeChecking to true and provide
// the right fileGlob
// reference https://github.com/MeirionHughes/aurelia-template-lint#static-type-checking
// these settings can also be passed with configuration above
typeChecking: true,
fileGlob: 'ClientApp'
}
}
})
]
}
```
## More options and confuguration
Expand All @@ -54,4 +53,3 @@ npm install aurelia-template-lint-loader --save-dev

MIT (http://www.opensource.org/licenses/mit-license.php)