Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
SHELL:=bash

default: all

PHONY_TARGETS:=all default
PHONY_TARGETS:=default

BUILD_TARGETS:=

Expand Down
705 changes: 705 additions & 0 deletions README.md

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions jsdoc.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"plugins": ["dmd-readme-api"],
"recurseDepth": 10,
"source": {
"includePattern": ".+\\.(c|m)?js(doc|x)?$",
"excludePattern": "((^|\\/|\\\\)_|.+\\.test\\.(c|m)?jsx?$)"
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"templates": {
"cleverLinks": true,
"monospaceLinks": true
}
}
15 changes: 15 additions & 0 deletions make/55-readme-md.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
README_MD:=README.md
README_MD_SRC:=$(shell find $(SRC)/doc -name "*.md") $(SDLC_ALL_NON_TEST_JS_FILES_SRC)
BUILD_TARGETS+=$(README_MD)

$(README_MD): $(README_MD_SRC)
cp $(SRC)/doc/README.01.md $@
npx jsdoc2md \
--files 'src/**/*' \
--plugin dmd-readme-api \
--global-index-format grouped \
--name-format \
--configure jsdoc.config.json \
--no-cache \
>> $@
cat $(SRC)/doc/README.02.md >> $@
21 changes: 11 additions & 10 deletions make/95-final-targets.mk
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,27 @@
# to https://npmjs.com/package/@liquid-labs/sdlc-projects-workflow-node-build for
# further details

.DEFAULT_GOAL:=all

.PRECIOUS: $(PRECIOUS_TARGETS)

build: $(BUILD_TARGETS)
.PHONY+= build

PHONY_TARGETS+=build
all: build doc
.PHONY+= all

all: build
doc: $(DOC_TARGETS)
.PHONY+= doc

lint: $(LINT_TARGETS)

lint-fix: $(LINT_FIX_TARGETS)

PHONY_TARGETS+=lint lint-fix
.PHONY+=lint lint-fix

test: $(TEST_TARGETS)

PHONY_TARGETS+= test
.PHONY+= test

qa: test lint
.PHONY+=qa

PHONY_TARGETS+=qa

.PHONY: $(PHONY_TARGETS)
.PHONY: $(.PHONY)
Loading