Skip to content

Commit da76dc5

Browse files
ChALkeRChALkeR
committed
build: introduce 'make doclint' command and tooling
This adds remark-lint tooling and introduces a 'make doclint' command, which is also executed on 'make test' runs. tools/remark-cli dir was created by installing `remark-cli` and `remark-lint`, the following files and directories are being excluded: * `./node_modules/concat-stream/node_modules/readable-stream/` a duplicate copy of `readable-stream` of 2.0, there already is 2.1. * `./**/doc/`, `./**/test/` -- docs and tests for deps are not needed. * `./**/history.md` and `./**/changelog.md` (case-insensitive). * `./**/.travis.yml`, `./**/.istanbul.yml`, `./**/.zuul.yml`. * `./**/.eslintrc`, `./**/.jscs.json`, `./**/.jshintrc`. * `./**/.npmignore`, `./**/component.json`, `./**/.gitattributes`. * `./**/dist/` (affects `sprintf-js` and `js-yaml`), not `require()`-d. PR-URL: #8551
1 parent 50be885 commit da76dc5

972 files changed

Lines changed: 98550 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

β€Ž.eslintignoreβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ test/fixtures
55
test/disabled
66
test/tmp*/
77
tools/eslint
8+
tools/remark-cli
89
node_modules

β€ŽMakefileβ€Ž

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ test: all
123123
$(MAKE) cctest
124124
$(PYTHON) tools/test.py --mode=release -J \
125125
addons doctool inspector known_issues message pseudo-tty parallel sequential
126+
$(MAKE) doclint
126127
$(MAKE) lint
127128

128129
test-parallel: all
@@ -699,6 +700,9 @@ jslint-ci:
699700
$(NODE) tools/jslint.js $(PARALLEL_ARGS) -f tap -o test-eslint.tap \
700701
benchmark lib test tools
701702

703+
doclint:
704+
$(NODE) tools/remark-cli/cli.js -qf *.md doc src lib benchmark tools/doc/*.md tools/icu/*.md
705+
702706
CPPLINT_EXCLUDE ?=
703707
CPPLINT_EXCLUDE += src/node_root_certs.h
704708
CPPLINT_EXCLUDE += src/queue.h

β€Žtools/remark-cli/cli.jsβ€Ž

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#!/usr/bin/env node
2+
/**
3+
* @author Titus Wormer
4+
* @copyright 2015 Titus Wormer
5+
* @license MIT
6+
* @module remark:cli
7+
* @fileoverview CLI to process markdown.
8+
*/
9+
10+
'use strict';
11+
12+
/* Dependencies. */
13+
var start = require('unified-args');
14+
var extensions = require('markdown-extensions');
15+
var processor = require('remark');
16+
var proc = require('remark/package.json');
17+
var cli = require('./package.json');
18+
19+
/* Start. */
20+
start({
21+
processor: processor,
22+
name: proc.name,
23+
description: cli.description,
24+
version: [
25+
proc.name + ': ' + proc.version,
26+
cli.name + ': ' + cli.version
27+
].join(', '),
28+
pluginPrefix: proc.name,
29+
presetPrefix: proc.name + '-preset',
30+
packageField: proc.name + 'Config',
31+
rcName: '.' + proc.name + 'rc',
32+
ignoreName: '.' + proc.name + 'ignore',
33+
extensions: extensions
34+
});

β€Žtools/remark-cli/node_modules/ansi-regex/index.jsβ€Ž

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žtools/remark-cli/node_modules/ansi-regex/licenseβ€Ž

Lines changed: 21 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žtools/remark-cli/node_modules/ansi-regex/package.jsonβ€Ž

Lines changed: 122 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žtools/remark-cli/node_modules/ansi-regex/readme.mdβ€Ž

Lines changed: 31 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žtools/remark-cli/node_modules/ansi-styles/index.jsβ€Ž

Lines changed: 65 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žtools/remark-cli/node_modules/ansi-styles/licenseβ€Ž

Lines changed: 21 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
Β (0)