mirror of
https://github.com/0x5eal/rbxts-pako.git
synced 2025-04-09 13:20:59 +01:00
Added Makefile + doc/test skeletons
This commit is contained in:
parent
ac35ad00b2
commit
fa5b9ffac9
4 changed files with 104 additions and 0 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1 +1,2 @@
|
|||
/doc
|
||||
/node_modules/
|
||||
|
|
17
.ndocrc
Normal file
17
.ndocrc
Normal file
|
@ -0,0 +1,17 @@
|
|||
#
|
||||
# Common nodeca config
|
||||
################################################################################
|
||||
|
||||
--index "./README.md"
|
||||
--package "./package.json"
|
||||
--gh-ribbon "{package.homepage}"
|
||||
--output "doc"
|
||||
--render "html"
|
||||
--broken-links "throw"
|
||||
|
||||
|
||||
#
|
||||
# Paths with sources
|
||||
################################################################################
|
||||
|
||||
lib
|
85
Makefile
Normal file
85
Makefile
Normal file
|
@ -0,0 +1,85 @@
|
|||
PATH := ./node_modules/.bin:${PATH}
|
||||
|
||||
NPM_PACKAGE := $(shell node -e 'process.stdout.write(require("./package.json").name)')
|
||||
NPM_VERSION := $(shell node -e 'process.stdout.write(require("./package.json").version)')
|
||||
|
||||
TMP_PATH := /tmp/${NPM_PACKAGE}-$(shell date +%s)
|
||||
|
||||
REMOTE_NAME ?= origin
|
||||
REMOTE_REPO ?= $(shell git config --get remote.${REMOTE_NAME}.url)
|
||||
|
||||
CURR_HEAD := $(firstword $(shell git show-ref --hash HEAD | cut --bytes=-6) master)
|
||||
GITHUB_PROJ := fontello/${NPM_PACKAGE}
|
||||
|
||||
|
||||
help:
|
||||
echo "make help - Print this help"
|
||||
echo "make lint - Lint sources with JSHint"
|
||||
echo "make publish - Set new version tag and publish npm package"
|
||||
|
||||
|
||||
lint:
|
||||
if test ! `which jshint` ; then \
|
||||
echo "You need 'jshint' installed in order to run lint." >&2 ; \
|
||||
echo " $ make dev-deps" >&2 ; \
|
||||
exit 128 ; \
|
||||
fi
|
||||
jshint . --show-non-errors
|
||||
|
||||
|
||||
test: lint
|
||||
@if test ! `which mocha` ; then \
|
||||
echo "You need 'mocha' installed in order to run tests." >&2 ; \
|
||||
echo " $ make dev-deps" >&2 ; \
|
||||
exit 128 ; \
|
||||
fi
|
||||
mocha
|
||||
|
||||
|
||||
doc:
|
||||
@if test ! `which ndoc` ; then \
|
||||
echo "You need 'ndoc' installed in order to generate docs." >&2 ; \
|
||||
echo " $ npm install -g ndoc" >&2 ; \
|
||||
exit 128 ; \
|
||||
fi
|
||||
rm -rf ./doc
|
||||
ndoc --link-format "{package.homepage}/blob/${CURR_HEAD}/{file}#L{line}"
|
||||
|
||||
|
||||
gh-pages:
|
||||
@if test -z ${REMOTE_REPO} ; then \
|
||||
echo 'Remote repo URL not found' >&2 ; \
|
||||
exit 128 ; \
|
||||
fi
|
||||
$(MAKE) doc && \
|
||||
cp -r ./doc ${TMP_PATH} && \
|
||||
touch ${TMP_PATH}/.nojekyll
|
||||
cd ${TMP_PATH} && \
|
||||
git init && \
|
||||
git add . && \
|
||||
git commit -q -m 'Recreated docs'
|
||||
cd ${TMP_PATH} && \
|
||||
git remote add remote ${REMOTE_REPO} && \
|
||||
git push --force remote +master:gh-pages
|
||||
rm -rf ${TMP_PATH}
|
||||
|
||||
|
||||
publish:
|
||||
@if test 0 -ne `git status --porcelain | wc -l` ; then \
|
||||
echo "Unclean working tree. Commit or stash changes first." >&2 ; \
|
||||
exit 128 ; \
|
||||
fi
|
||||
@if test 0 -ne `git fetch ; git status | grep '^# Your branch' | wc -l` ; then \
|
||||
echo "Local/Remote history differs. Please push/pull changes." >&2 ; \
|
||||
exit 128 ; \
|
||||
fi
|
||||
@if test 0 -ne `git tag -l ${NPM_VERSION} | wc -l` ; then \
|
||||
echo "Tag ${NPM_VERSION} exists. Update package.json" >&2 ; \
|
||||
exit 128 ; \
|
||||
fi
|
||||
git tag ${NPM_VERSION} && git push origin ${NPM_VERSION}
|
||||
npm publish https://github.com/${GITHUB_PROJ}/tarball/${NPM_VERSION}
|
||||
|
||||
|
||||
.PHONY: publish lint
|
||||
.SILENT: help lint
|
1
test/mocha.opts
Normal file
1
test/mocha.opts
Normal file
|
@ -0,0 +1 @@
|
|||
-R spec
|
Loading…
Add table
Reference in a new issue