Skip to content

Commit 3600a18

Browse files
kgrytekgryte
committed
Add quotes
1 parent e0807cd commit 3600a18

File tree

1 file changed

+37
-17
lines changed

1 file changed

+37
-17
lines changed

‎tools/make/README.md‎

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2020 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
121
# Makefile
222

323
> Development utility.
@@ -78,7 +98,7 @@ To filter based on a file path,
7898

7999
```bash
80100
# List all files in the is-nan utils directory...
81-
$ make FILES_FILTER=.*/assert/is-nan/.* list-files
101+
$ make FILES_FILTER=".*/assert/is-nan/.*" list-files
82102
```
83103

84104
**Notes**:
@@ -116,7 +136,7 @@ To filter based on a file path,
116136

117137
```bash
118138
# List only source files found in a math directory...
119-
$ make SOURCES_FILTER=.*/math/.* list-sources
139+
$ make SOURCES_FILTER=".*/math/.*" list-sources
120140
```
121141

122142
##### Tests
@@ -138,7 +158,7 @@ To filter based on a file path,
138158

139159
```bash
140160
# List only test files in the fs directory...
141-
$ make TESTS_FILTER=.*/fs/.* list-tests
161+
$ make TESTS_FILTER=".*/fs/.*" list-tests
142162
```
143163

144164
##### Test Fixtures
@@ -160,7 +180,7 @@ To filter based on a file path,
160180

161181
```bash
162182
# List only test fixture files in the base math directory for special functions...
163-
$ make TESTS_FIXTURES_FILTER=.*/math/special/.* list-tests-fixtures
183+
$ make TESTS_FIXTURES_FILTER=".*/math/special/.*" list-tests-fixtures
164184
```
165185

166186
##### Benchmarks
@@ -182,7 +202,7 @@ To filter based on a file path,
182202

183203
```bash
184204
# List only benchmark files for base special math functions...
185-
$ make BENCHMARKS_FILTER=.*/math/base/special/.* list-benchmarks
205+
$ make BENCHMARKS_FILTER=".*/math/base/special/.*" list-benchmarks
186206
```
187207

188208
##### Examples
@@ -204,7 +224,7 @@ To filter based on a file path,
204224

205225
```bash
206226
# List only the example files for special functions in the base math directory...
207-
$ make EXAMPLES_FILTER=.*/math/base/special/.* list-examples
227+
$ make EXAMPLES_FILTER=".*/math/base/special/.*" list-examples
208228
```
209229

210230
##### Packages
@@ -219,7 +239,7 @@ To filter based on a file path,
219239

220240
```bash
221241
# List only the special function packages in the base math directory...
222-
$ make PACKAGES_FILTER=.*/math/base/special/.* list-pkgs
242+
$ make PACKAGES_FILTER=".*/math/base/special/.*" list-pkgs
223243
```
224244

225245
To list all package names under the `@stdlib` scope,
@@ -248,7 +268,7 @@ To limit which examples are run, use the same environment variables recognized b
248268

249269
```bash
250270
# Only run the examples for special functions in the base math directory...
251-
$ make EXAMPLES_FILTER=.*/math/base/special/.* EXAMPLES_PATTERN=index.js examples
271+
$ make EXAMPLES_FILTER=".*/math/base/special/.*" EXAMPLES_PATTERN=index.js examples
252272
```
253273

254274
* * *
@@ -271,10 +291,10 @@ To limit which tests are run, use the same environment variables recognized by `
271291

272292
```bash
273293
# Run only the main test file for base math utils...
274-
$ make TESTS_FILTER=.*/math/base/utils/.* TESTS_PATTERN=test.js test
294+
$ make TESTS_FILTER=".*/math/base/utils/.*" TESTS_PATTERN=test.js test
275295
276296
# Run all blas tests...
277-
$ make TESTS_FILTER=.*/math/base/blas/.* test-summary
297+
$ make TESTS_FILTER=".*/math/base/blas/.*" test-summary
278298
```
279299

280300
To run unit tests against specific Node.js versions (assuming [`nvm`][nvm] is installed),
@@ -286,7 +306,7 @@ $ make test-node-versions
286306
By default, tests are run against supported Node.js versions. To run against alternative versions, set the `NODE_VERSIONS` environment variable.
287307

288308
```bash
289-
$ make NODE_VERSIONS='0.10 4 6' TESTS_FILTER=.*/fs/exists/.* test-node-versions
309+
$ make NODE_VERSIONS='0.10 4 6' TESTS_FILTER=".*/fs/exists/.*" test-node-versions
290310
```
291311

292312
To run units tests for project tools,
@@ -298,7 +318,7 @@ $ make tools-test
298318
To limit which tests are run, use the same environment variables recognized by `list-tests`.
299319

300320
```bash
301-
$ make tools-test TESTS_FILTER=.*/search/.* TESTS_PATTERN=test.js
321+
$ make tools-test TESTS_FILTER=".*/search/.*" TESTS_PATTERN=test.js
302322
```
303323

304324
#### Test Coverage
@@ -313,7 +333,7 @@ To limit which tests are run, use the same environment variables recognized by `
313333

314334
```bash
315335
# Generate a coverage report for base math utils...
316-
$ make TESTS_FILTER=.*/math/base/utils/.* test-cov
336+
$ make TESTS_FILTER=".*/math/base/utils/.*" test-cov
317337
```
318338

319339
To generate a coverage report for project tools,
@@ -325,7 +345,7 @@ $ make tools-test-cov
325345
To limit which tests are run, use the same environment variables recognized by `list-tests`.
326346

327347
```bash
328-
$ make tools-test-cov TESTS_FILTER=.*/search/.* TESTS_PATTERN=test.js
348+
$ make tools-test-cov TESTS_FILTER=".*/search/.*" TESTS_PATTERN=test.js
329349
```
330350

331351
To view a generated report in a local web browser,
@@ -352,10 +372,10 @@ To limit which tests are run, use the same environment variables recognized by `
352372

353373
```bash
354374
# Run base math utils tests in a headless local web browser...
355-
$ make TESTS_FILTER=.*/math/base/utils/.* test-browsers
375+
$ make TESTS_FILTER=".*/math/base/utils/.*" test-browsers
356376
357377
# Run @stdlib utils tests in a local web browser...
358-
$ make TESTS_FILTER=.*/\@stdlib/utils/.* test-view-browsers
378+
$ make TESTS_FILTER=".*/\@stdlib/utils/.*" test-view-browsers
359379
```
360380

361381
* * *
@@ -372,7 +392,7 @@ To limit which benchmarks are run, use the same environment variables recognized
372392

373393
```bash
374394
# Run only the benchmarks for base special math functions...
375-
$ make BENCHMARKS_FILTER=.*/math/base/special/.* BENCHMARKS_PATTERN=benchmark.js benchmark
395+
$ make BENCHMARKS_FILTER=".*/math/base/special/.*" BENCHMARKS_PATTERN=benchmark.js benchmark
376396
```
377397

378398
* * *

0 commit comments

Comments
 (0)