-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
Introduce 'make doclint' command and tooling #8551
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,4 +5,5 @@ test/fixtures | |
test/disabled | ||
test/tmp*/ | ||
tools/eslint | ||
tools/remark-cli | ||
node_modules |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
#!/usr/bin/env node | ||
/** | ||
* @author Titus Wormer | ||
* @copyright 2015 Titus Wormer | ||
* @license MIT | ||
* @module remark:cli | ||
* @fileoverview CLI to process markdown. | ||
*/ | ||
|
||
'use strict'; | ||
|
||
/* Dependencies. */ | ||
var start = require('unified-args'); | ||
var extensions = require('markdown-extensions'); | ||
var processor = require('remark'); | ||
var proc = require('remark/package.json'); | ||
var cli = require('./package.json'); | ||
|
||
/* Start. */ | ||
start({ | ||
processor: processor, | ||
name: proc.name, | ||
description: cli.description, | ||
version: [ | ||
proc.name + ': ' + proc.version, | ||
cli.name + ': ' + cli.version | ||
].join(', '), | ||
pluginPrefix: proc.name, | ||
presetPrefix: proc.name + '-preset', | ||
packageField: proc.name + 'Config', | ||
rcName: '.' + proc.name + 'rc', | ||
ignoreName: '.' + proc.name + 'ignore', | ||
extensions: extensions | ||
}); |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe rename to
mdlint
? I assume we want to lint every md, including non-doc files.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The thing is, there is a project named
mdlint
, and that's not the one we are using.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see that as an issue. There is a project called
jslint
and we happily use that name for js lint task 😉.