REPLACE_TODO_DESCRIPTION
To use this commands first replace this all occurences of bellow strings. Use Alt + F3 to make this easier:
__MY-CLI-TOOL__
// example: get-images__GITHUB_USER__
// example: azukiapp__PROJECT_DESCRIPTION__
// example: Cli tool to download images__BIN_DEFAULT_DESCRIPTION__
// example: Download images for me__THE_AUTHOR__
// example: [email protected]
wget https://github.com/azukiapp/azk-cli-boilerplate/archive/master.zip
unzip master.zip
mv azk-cli-boilerplate-master __MY-CLI-TOOL__
rm master.zip
cd __MY-CLI-TOOL__
git init
git add . -A
git commit -m"[Project] Initial version from boilerplate"
- Execute this on your new project folder:
# replace main bin filename
find . -name 'REPLACE_PROJECT_NAME.js' -type f -exec bash -c 'mv "$1" "${1/REPLACE_PROJECT_NAME.js/__MY-CLI-TOOL__.js}"' -- {} \;
git add . -A
# replace other strings inside files
find . -type f -not -path "./node_modules/*" -not -path "./.git/*" -not -path "./lib/*" -exec sed -i 's/REPLACE_PROJECT_GITHUB_URI/https:\/\/github.com\/__GITHUB_USER__\/__MY-CLI-TOOL__/g' {} +
find . -type f -not -path "./node_modules/*" -not -path "./.git/*" -not -path "./lib/*" -exec sed -i 's/REPLACE_PROJECT_NAME/__MY-CLI-TOOL__/g' {} +
find . -type f -not -path "./node_modules/*" -not -path "./.git/*" -not -path "./lib/*" -exec sed -i 's/REPLACE_TODO_DESCRIPTION/__PROJECT_DESCRIPTION__/g' {} +
find . -type f -not -path "./node_modules/*" -not -path "./.git/*" -not -path "./lib/*" -exec sed -i 's/REPLACE_TODO_BIN_DESCRIPTION/__BIN_DEFAULT_DESCRIPTION__/g' {} +
find . -type f -not -path "./node_modules/*" -not -path "./.git/*" -not -path "./lib/*" -exec sed -i 's/REPLACE_TODO_AUTHOR/__THE_AUTHOR__/g' {} +
- Search all other
TODO
in code and replace with correct values - Update
CHANGELOG
.md - Update
LICENSE
file
npm install
npm test
node ./bin/__MY-CLI-TOOL__.js -h
Create __MY-CLI-TOOL__
on Github and include remote
git remote add origin [email protected]:__GITHUB_USER__/__MY-CLI-TOOL__.git
git push origin master -u
- Now you can delete this section from README ;)
npm install REPLACE_PROJECT_NAME -g
REPLACE_PROJECT_NAME # REPLACE_TODO_DESCRIPTION
npm install
npm test
node ./bin/REPLACE_PROJECT_NAME.js -h