Skip to content

Commit

Permalink
chore: add markdownlint
Browse files Browse the repository at this point in the history
Also fixes a single markdown linter error.
  • Loading branch information
pbredenberg committed May 22, 2020
1 parent ece1638 commit 82885e4
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "./node_modules/@silvermine/standardization/.markdownlint.json"
}
15 changes: 14 additions & 1 deletion Gruntfile.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
'use strict';

var markdownlint = require('markdownlint');

module.exports = function(grunt) {

var config;
Expand All @@ -18,11 +20,22 @@ module.exports = function(grunt) {
target: config.js.all,
},

markdownlint: {
all: {
src: [ 'README.md' ],
options: {
// eslint-disable-next-line no-sync
config: markdownlint.readConfigSync('.markdownlint.json'),
},
},
},

});

grunt.loadNpmTasks('grunt-eslint');
grunt.loadNpmTasks('grunt-markdownlint');

grunt.registerTask('standards', [ 'eslint' ]);
grunt.registerTask('standards', [ 'eslint', 'markdownlint' ]);
grunt.registerTask('default', [ 'standards' ]);

};
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ NOTE: at this time, it is assumed that the topic is in the same account and
region as the Lambda function itself. That can be changed in the future if
needed - feel free to open an issue, and preferably submit a pull request.

```
```yaml
functions:
doSomething:
name: ${self:service}-${self:provider.stage}-doSomething
Expand Down

0 comments on commit 82885e4

Please sign in to comment.