1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
#/
# @license Apache-2.0
#
# Copyright (c) 2017 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/
# VARIABLES #
# Define the path to the remark configuration file:
REMARK_PKG_URLS_CONF ?= $(CONFIG_DIR)/remark/.remarkrc.js
# Define the path to the remark ignore file:
# REMARK_PKG_URLS_IGNORE ?= $(CONFIG_DIR)/remark/.remarkignore FIXME
REMARK_PKG_URLS_IGNORE ?= $(ROOT_DIR)/.remarkignore
# Define the path to a plugin which processes Markdown table of contents comments:
REMARK_PKG_URLS_PLUGIN ?= $(TOOLS_PKGS_DIR)/remark/plugins/remark-stdlib-urls-github
REMARK_PKG_URLS_PLUGIN_SETTINGS ?=
REMARK_PKG_URLS_PLUGIN_FLAGS ?= --use $(REMARK_PKG_URLS_PLUGIN)=$(REMARK_PKG_URLS_PLUGIN_SETTINGS)
# Define command-line options when invoking the remark executable:
REMARK_PKG_URLS_FLAGS ?= \
--ext $(MARKDOWN_FILENAME_EXT) \
--rc-path $(REMARK_PKG_URLS_CONF) \
--ignore-path $(REMARK_PKG_URLS_IGNORE)
# Define the remark output option:
REMARK_PKG_URLS_OUTPUT_FLAG ?= --output
# RULES #
#/
# Updates Markdown files by resolving package identifiers to GitHub repository URLs.
#
# ## Notes
#
# - This rule is useful when wanting to glob for Markdown files (e.g., process all Markdown files for a particular package).
#
# @param {string} [MARKDOWN_FILTER] - file path pattern (e.g., `.*/math/base/special/.*`)
# @param {string} [MARKDOWN_PATTERN] - filename pattern (e.g., `*.md`)
#
# @example
# make markdown-pkg-urls
#
# @example
# make markdown-pkg-urls MARKDOWN_PATTERN='README.md' MARKDOWN_FILTER='.*/math/base/special/.*'
#/
markdown-pkg-urls:
$(QUIET) $(FIND_MARKDOWN_CMD) | grep '^[\/]\|^[a-zA-Z]:[/\]' | xargs sed -i '' 's/^\[@\(stdlib\/[^:]\{1,\}\)\]:.\{1,\}$$/[@\1]: https:\/\/github.com\/stdlib-js\/stdlib\/tree\/develop\/lib\/node_modules\/%40\1/g'
.PHONY: markdown-pkg-urls
#/
# Updates a specified list of Markdown files by resolving package identifiers to GitHub repository URLs.
#
# ## Notes
#
# - This rule is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
#
# @param {string} FILES - list of files
#
# @example
# make markdown-pkg-urls-files FILES='/foo/foo.md /foo/bar.md'
#/
markdown-pkg-urls-files:
$(QUIET) echo $(FILES) | xargs sed -i '' 's/^\[@\(stdlib\/[^:]\{1,\}\)\]:.\{1,\}$$/[@\1]: https:\/\/github.com\/stdlib-js\/stdlib\/tree\/develop\/lib\/node_modules\/%40\1/g'
.PHONY: markdown-pkg-urls-files
|
