From 1521d55d16e09686e0f4a3d71143beaef6e4f6e6 Mon Sep 17 00:00:00 2001 From: Enoch Riese Date: Fri, 28 Jul 2023 12:56:14 -0500 Subject: [PATCH] update kickstart and tips --- package.json | 8 ++++---- scripts/help.mjs | 27 +++++++++++++++++++++++---- 2 files changed, 27 insertions(+), 8 deletions(-) diff --git a/package.json b/package.json index dd6c1c8d0d6..09b9b793967 100644 --- a/package.json +++ b/package.json @@ -16,8 +16,8 @@ "tips": "node scripts/help.mjs", "lab": "cd sites/lab && yarn start", "lab-debug": "cd sites/lab && yarn start-debug", - "kickstart": "npx yarn install && yarn reconfigure && yarn buildall && yarn prepare && yarn tips", - "kickstart:windows": "npx yarn install && yarn wbuildall && yarn prepare && yarn tips", + "kickstart": "npx yarn install && yarn prepare && yarn tips", + "kickstart:windows": "npx yarn install && yarn prepare && yarn tips", "cleanall": "lerna run clean", "test": "lerna run test", "e2e": "lerna run e2e", @@ -26,8 +26,8 @@ "sitebuildconfigure": "SITEBUILD=1 node --experimental-json-modules --no-warnings scripts/reconfigure.mjs", "prerelease": "lerna version --no-git-tag-version --no-push && yarn reconfigure && yarn buildall", "buildall": "lerna run build:all", - "build": "yarn build:all", - "wbuild": "yarn wbuild:all", + "build": "yarn buildall", + "wbuild": "lerna run wbuild:all", "testall": "node scripts/testall.js", "lint": "LINTER=1 lerna run --no-bail lint -- ", "qa": "yarn qa:prettier && yarn qa:lint", diff --git a/scripts/help.mjs b/scripts/help.mjs index 01b60824177..dd92ded68f0 100644 --- a/scripts/help.mjs +++ b/scripts/help.mjs @@ -31,14 +31,22 @@ console.log(` ${chalk.blue('yarn kickstart')} - It will install and link all dependencies, and link them together. - It will also run ${chalk.blue('yarn reconfigure')} which you can run yourself at any time to (re)configure all packages and dependencies. + It will install and link all dependencies. + + + If something goes wrong in the configuration, you can run + + ${chalk.blue('yarn reconfigure')} + + It will (re)configure all packages and dependencies. ${chalk.bold.yellow('๐Ÿ› ๏ธ Starting the development environment')} ${chalk.gray('โ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰ก')} - Our development environment for ${chalk.bold('designs')} and ${chalk.bold('plugins')} lives in ${chalk.green('sites/lab')} + Our development environment for ${chalk.bold('designs')} and ${chalk.bold( + 'plugins' + )} lives in ${chalk.green('sites/lab')} We refer to it as ${chalk.bold('the FreeSewing lab')}. It can display any design in this repository and will hot-reload any changes you make to a design. @@ -59,6 +67,15 @@ console.log(` It will ask you some questions, and set everything up for you, and add your design to the lab. + If you later need to add more dependencies to your design, add them in ${chalk.green( + 'config/dependencies.yaml' + )}, then run + + ${chalk.blue('yarn reconfigure')} + + They will be added to your design's ${chalk.green('package.json')} + + ${chalk.bold.yellow('๐Ÿค” More info & help')} ${chalk.gray('โ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰กโ‰ก')} @@ -66,7 +83,9 @@ console.log(` ${chalk.green('https://freesewing.dev/')} - Our community is on Discord. The ${chalk.bold('development-help')} channel is a good place to start: + Our community is on Discord. The ${chalk.bold( + 'development-help' + )} channel is a good place to start: ${chalk.green('https://discord.freesewing.dev/')}