Skip to content

Commit 9d8df3e

Browse files
committed
Add recipe to list namespace READMEs
1 parent 3f23488 commit 9d8df3e

File tree

3 files changed

+46
-4
lines changed

3 files changed

+46
-4
lines changed

tools/make/lib/ls/pkgs/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ include $(TOOLS_MAKE_LIB_DIR)/ls/pkgs/includes.mk
2626
include $(TOOLS_MAKE_LIB_DIR)/ls/pkgs/installed.mk
2727
include $(TOOLS_MAKE_LIB_DIR)/ls/pkgs/lib.mk
2828
include $(TOOLS_MAKE_LIB_DIR)/ls/pkgs/names.mk
29+
include $(TOOLS_MAKE_LIB_DIR)/ls/pkgs/namespace_readmes.mk
2930
include $(TOOLS_MAKE_LIB_DIR)/ls/pkgs/namespaces.mk
3031
include $(TOOLS_MAKE_LIB_DIR)/ls/pkgs/pkgs.mk
3132
include $(TOOLS_MAKE_LIB_DIR)/ls/pkgs/readmes.mk
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2021 The Stdlib Authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#/
18+
19+
# VARIABLES #
20+
21+
# Define the path of the executable:
22+
LIST_PACKAGE_NAMESPACE_READMES ?= $(TOOLS_PKGS_DIR)/pkgs/namespace-readmes/bin/cli
23+
24+
# Define the command flags:
25+
LIST_PACKAGE_NAMESPACE_READMES_FLAGS ?=
26+
27+
28+
# RULES #
29+
30+
#/
31+
# Prints a list of all namespace package READMEs.
32+
#
33+
# @example
34+
# make list-pkgs-namespace-readmes
35+
#/
36+
list-pkgs-namespace-readmes: $(LIST_PACKAGE_NAMESPACE_READMES) $(NODE_MODULES)
37+
$(QUIET) NODE_PATH="$(NODE_PATH)" $(NODE) $(LIST_PACKAGE_NAMESPACE_READMES) $(LIST_PACKAGE_NAMESPACE_READMES_FLAGS) $(SRC_DIR)
38+
39+
.PHONY: list-pkgs-namespace-readmes

tools/make/lib/ls/pkgs/readmes.mk

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,14 @@ LIST_PACKAGE_READMES ?= $(TOOLS_PKGS_DIR)/pkgs/readmes/bin/cli
2525
LIST_PACKAGE_READMES_FLAGS ?=
2626

2727

28-
# TARGETS #
28+
# RULES #
2929

30-
# List all package READMEs.
30+
#/
31+
# Prints a list of all package READMEs.
3132
#
32-
# This target prints a list of all package READMEs.
33-
33+
# @example
34+
# make list-pkgs-readmes
35+
#/
3436
list-pkgs-readmes: $(LIST_PACKAGE_READMES) $(NODE_MODULES)
3537
$(QUIET) NODE_PATH="$(NODE_PATH)" $(NODE) $(LIST_PACKAGE_READMES) $(LIST_PACKAGE_READMES_FLAGS) $(SRC_DIR)
3638

0 commit comments

Comments
 (0)