Skip to content

Commit e99c50b

Browse files
kgrytekgryte
committed
Update Makefile documentation
1 parent 847d874 commit e99c50b

File tree

11 files changed

+35
-16
lines changed

11 files changed

+35
-16
lines changed

‎tools/make/README.md‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,10 +251,28 @@ $ make view-src-docs
251251
===
252252
#### Lint
253253

254-
To lint all source code,
254+
To lint all source code, including tests and examples,
255255

256256
``` bash
257-
$ make lint
257+
$ make SOURCES_FILTER=... TESTS_FILTER=... EXAMPLES_FILTER=... lint
258+
```
259+
260+
To lint only source files,
261+
262+
``` bash
263+
$ make SOURCES_FILTER=... lint-src
264+
```
265+
266+
To lint only test files,
267+
268+
``` bash
269+
$ make TESTS_FILTER=... lint-tests
270+
```
271+
272+
To lint only example files,
273+
274+
``` bash
275+
$ make EXAMPLES_FILTER=... lint-examples
258276
```
259277

260278

‎tools/make/lib/coverage-service/codecov.mk‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ CODECOV ?= $(BIN)/codecov
1616
# To install Codecov:
1717
# $ npm install codecov
1818
#
19-
# [1] https://codecov.io/
19+
# [1]: https://codecov.io/
2020

2121
coverage-codecov:
2222
$(NPM) install codecov

‎tools/make/lib/docs/jsdoc.mk‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ JSDOC_JSON_FLAGS ?= --template $(JSDOC_JSON_TEMPLATE) \
5151
# To install JSDoc:
5252
# $ npm install jsdoc
5353
#
54-
# [1] http://usejsdoc.org/
54+
# [1]: http://usejsdoc.org/
5555

5656
docs-src: docs-jsdoc
5757

@@ -68,7 +68,7 @@ docs-jsdoc: node_modules
6868
# To install JSDoc:
6969
# $ npm install jsdoc
7070
#
71-
# [1] http://usejsdoc.org/
71+
# [1]: http://usejsdoc.org/
7272

7373
jsdoc-json: node_modules
7474
-rm -f $(JSDOC_JSON_PATH)

‎tools/make/lib/help/Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ MAKE_USAGE_PATH ?= $(TOOLS_MAKE_DIR)/usage.txt
1616
help:
1717
$(CAT) $(MAKE_USAGE_PATH)
1818

19+
1920
.PHONY: help
2021

‎tools/make/lib/install/node.mk‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ NPM ?= npm
99

1010
# Install node module dependencies.
1111
#
12-
# This target installs package dependencies by
13-
# executing [`npm install`][1]. Packages will be installed in a local `node_modules` directory relative to the project's `package.json` file.
12+
# This target installs package dependencies by executing [`npm install`][1]. Packages will be installed in a local `node_modules` directory relative to the project's `package.json` file.
1413
#
1514
# [1]: https://docs.npmjs.com/cli/install
1615

‎tools/make/lib/notes/Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,5 @@ notes:
2525
--exclude "$(REPORTS_DIR)/*" \
2626
--exclude TODO.md
2727

28+
2829
.PHONY: notes

‎tools/make/lib/test-browsers/Makefile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ endif
3535
# To install browserify, proxyquire-universal, and tap-spec:
3636
# $ npm install browserify proxyquire-universal tap-spec
3737
#
38-
# [1] https://github.com/substack/node-browserify
39-
# [2] https://github.com/bendrucker/proxyquire-universal
40-
# [3] https://github.com/scottcorgan/tap-spec
38+
# [1]: https://github.com/substack/node-browserify
39+
# [2]: https://github.com/bendrucker/proxyquire-universal
40+
# [3]: https://github.com/scottcorgan/tap-spec
4141

4242
test-browsers: node_modules
4343
NODE_ENV=$(NODE_ENV) \

‎tools/make/lib/test-browsers/testling.mk‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# To install testling:
77
# $ npm install testling
88
#
9-
# [1] https://github.com/substack/testling
9+
# [1]: https://github.com/substack/testling
1010

1111
BROWSER_TEST_RUNNER_BIN ?= $(BIN)/testling
1212

@@ -20,7 +20,7 @@ BROWSER_TEST_RUNNER_FLAGS ?= ''
2020
#
2121
# This target runs unit tests in a local web browser using [testling][1].
2222
#
23-
# [1] https://github.com/substack/testling
23+
# [1]: https://github.com/substack/testling
2424

2525
view-testling: node_modules
2626
NODE_ENV=$(NODE_ENV) \

‎tools/make/lib/test-cov/istanbul.mk‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ ISTANBUL_CMD ?= $(ISTANBUL) cover $(ISTANBUL_FLAGS)
3333
# To install Istanbul:
3434
# $ npm install istanbul
3535
#
36-
# [1] https://github.com/gotwarlost/istanbul
36+
# [1]: https://github.com/gotwarlost/istanbul
3737

3838
test-istanbul: node_modules
3939
NODE_ENV=$(NODE_ENV) \

‎tools/make/lib/test/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ endif
2929
# To install tap-spec:
3030
# $ npm install tap-spec
3131
#
32-
# [1] https://github.com/scottcorgan/tap-spec
32+
# [1]: https://github.com/scottcorgan/tap-spec
3333

3434
test: test-local
3535

@@ -49,7 +49,7 @@ test-local: node_modules
4949
# To install tap-summary:
5050
# $ npm install tap-summary
5151
#
52-
# [1] https://github.com/zoubin/tap-summary
52+
# [1]: https://github.com/zoubin/tap-summary
5353

5454
test-summary: node_modules
5555
NODE_ENV=$(NODE_ENV) \

0 commit comments

Comments
 (0)