From 72217e37209078142a12faa4577687ba53c8d688 Mon Sep 17 00:00:00 2001 From: Martin Oppitz Date: Thu, 11 Mar 2021 23:38:53 +0100 Subject: [PATCH] docs: update docu --- docs/.vitepress/config.js | 4 ++ docs/assets/demo.sh | 91 +++++++++++++++++++++++++++++++++ docs/config/index.md | 9 +++- docs/guide/showcase/index.md | 99 ++++++++++++++++++++++++++++++++++++ 4 files changed, 202 insertions(+), 1 deletion(-) create mode 100644 docs/assets/demo.sh create mode 100644 docs/guide/showcase/index.md diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 71373d9dcd..4ec29cd589 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -64,6 +64,10 @@ function getGuideSidebar() { text: 'Guide', link: '/guide/', children: [ + { + text: 'Showcase', + link: '/guide/showcase/', + }, { text: 'Installation', link: '/guide/installation/', diff --git a/docs/assets/demo.sh b/docs/assets/demo.sh new file mode 100644 index 0000000000..d2ec611e1c --- /dev/null +++ b/docs/assets/demo.sh @@ -0,0 +1,91 @@ +clear +echo Cleanup demo folder ./$1-$2 +sleep 2 +rm -rf $1-$2 +mkdir $1-$2 +cd $1-$2 +sleep 3 + +clear +echo \> npx lup --help +sleep 2 +npx lup --help +sleep 3 + +clear +echo \> npm install --no-save @leanup$3/cli@$2 @leanup$3/cli-$1@$2 +sleep 2 +npm install --no-save @leanup$3/cli@$2 @leanup$3/cli-$1@$2 +sleep 3 + +clear +echo \> $1 create +sleep 2 +npx $1 create +sleep 3 + +clear +echo \> npm run format -- --write +sleep 2 +npm run format -- --write +sleep 3 + +clear +echo \> npm run lint -- --fix +sleep 2 +npm run lint -- --fix +sleep 3 + +clear +echo \> npx tsc -p tsconfig.json +sleep 2 +npx tsc -p tsconfig.json +sleep 3 + +clear +echo \> npm run test +sleep 2 +npm run test +sleep 3 + +clear +echo \> npm run coverage -- --check-coverage +sleep 2 +npm run coverage -- --check-coverage +sleep 3 + +clear +echo \> npm run build +sleep 2 +npm run build +sleep 3 + +# clear +# echo \> npm start & +# sleep 2 +# npm start & +# sleep 30 + +# clear +# echo \> npm run e2e -- --env=chrome +# sleep 2 +# npm run e2e -- --env=chrome +# sleep 3 + +# clear +# echo \> npm install -D @leanup/cli-cucumber@$2 +# sleep 2 +# npm install -D @leanup/cli-cucumber@$2 +# sleep 3 + +# clear +# echo \> $1 create +# sleep 2 +# $1 create +# sleep 3 + +# clear +# echo \> npm run cucumber -- --env=chrome +# sleep 2 +# npm run cucumber -- --env=chrome +# sleep 3 diff --git a/docs/config/index.md b/docs/config/index.md index a618f9b05c..1d0c74e032 100644 --- a/docs/config/index.md +++ b/docs/config/index.md @@ -53,7 +53,14 @@ The main legacy bundler is `webpack`. In addition to `webpack`, we have expanded ### Format -We chose `prettier` for the code formatting. +We chose `prettier` for the code formatting with the following configuration: + +```js +module.exports = { + printWidth: 120, + singleQuote: true, +}; +``` ### Lint diff --git a/docs/guide/showcase/index.md b/docs/guide/showcase/index.md new file mode 100644 index 0000000000..eef54acd51 --- /dev/null +++ b/docs/guide/showcase/index.md @@ -0,0 +1,99 @@ +# Showcase + +You can watch a full showcase on you maschine, if you download the following bash script and execute it like this: `sh demo.sh react latest-1.1` + +Download: demo.sh + +```bash +clear +echo Cleanup demo folder ./$1-$2 +sleep 2 +rm -rf $1-$2 +mkdir $1-$2 +cd $1-$2 +sleep 3 + +clear +echo \> npx lup --help +sleep 2 +npx lup --help +sleep 3 + +clear +echo \> npm install --no-save @leanup$3/cli@$2 @leanup$3/cli-$1@$2 +sleep 2 +npm install --no-save @leanup$3/cli@$2 @leanup$3/cli-$1@$2 +sleep 3 + +clear +echo \> $1 create +sleep 2 +npx $1 create +sleep 3 + +clear +echo \> npm run format -- --write +sleep 2 +npm run format -- --write +sleep 3 + +clear +echo \> npm run lint -- --fix +sleep 2 +npm run lint -- --fix +sleep 3 + +clear +echo \> npx tsc -p tsconfig.json +sleep 2 +npx tsc -p tsconfig.json +sleep 3 + +clear +echo \> npm run test +sleep 2 +npm run test +sleep 3 + +clear +echo \> npm run coverage -- --check-coverage +sleep 2 +npm run coverage -- --check-coverage +sleep 3 + +clear +echo \> npm run build +sleep 2 +npm run build +sleep 3 + +# clear +# echo \> npm start & +# sleep 2 +# npm start & +# sleep 30 + +# clear +# echo \> npm run e2e -- --env=chrome +# sleep 2 +# npm run e2e -- --env=chrome +# sleep 3 + +# clear +# echo \> npm install -D @leanup/cli-cucumber@$2 +# sleep 2 +# npm install -D @leanup/cli-cucumber@$2 +# sleep 3 + +# clear +# echo \> $1 create +# sleep 2 +# $1 create +# sleep 3 + +# clear +# echo \> npm run cucumber -- --env=chrome +# sleep 2 +# npm run cucumber -- --env=chrome +# sleep 3 +```