feat(mc-scripts): add new CLI options #2191

emmenko · 2021-05-05T08:05:40Z

No description provided.

vercel · 2021-05-05T08:05:42Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/commercetools/merchant-center-application-kit/Ay4thkSH9YTd6fWGH8Xt4heaiLbj
✅ Preview: https://merchant-cente-git-nm-mc-scripts-global-options-commer-fb468c.vercel.app

changeset-bot · 2021-05-05T08:05:43Z

🦋 Changeset detected

Latest commit: 0cb04e7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
merchant-center-application-template-starter	Minor
@commercetools-frontend/mc-scripts	Minor
playground	Minor
@commercetools-website/custom-applications	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

adnasa · 2021-05-05T08:55:54Z

.changeset/cyan-ears-wonder.md

+The options are as following:
+
+- `--env <path>`: Parses the file path as a dotenv file and adds the variables to the environment. Multiple flags are allowed.
+- `--env-type <environment>`: Supports cascading env variables from `.env`, `.env.local`, `.env.<environment>`, `.env.<environment>.local` files.


cascading env variables can seem tricky at first sight.
if we can point to a crash course article, let's do it ;)

adnasa · 2021-05-05T09:00:56Z

packages/mc-scripts/src/bin/mc-scripts.js

+      case 'start': {
+        // Special case to handle the `--match` option, where the user is prompted
+        // to select an application. We then use that as the `cwd` value when executing the command.
+        const applicationPath = await getApplicationPath(flags);
+        proxyCommand({ applicationPath });
+        break;
+      }


adnasa · 2021-05-05T09:02:09Z

packages/mc-scripts/src/bin/mc-scripts.js

+    if (result.signal === 'SIGKILL') {
+      console.log(
+        `The command ${command} failed because the process exited too early. This probably means the system ran out of memory or someone called "kill -9" on the process.`
+      );
+    } else if (result.signal === 'SIGTERM') {
+      console.log(
+        `The command ${command} failed because the process exited too early. Someone might have called "kill" or "killall", or the system could be shutting down.`
+      );


would be easiser flow to follow if we switch this up

tdeekens

Nice!

tdeekens · 2021-05-05T09:30:00Z

packages/mc-scripts/src/bin/mc-scripts.js

+  --env <path>              (optional) Parses the file path as a dotenv file and adds the variables to the environment. Multiple flags are allowed.
+  --env-type <environment>  (optional) Supports cascading env variables from ".env", ".env.local", ".env.<environment>", ".env.<environment>.local" files.


The below is more of a short hand of the before right. I could achieve --env-type with --env more inconvienetly?

This is the equivalent option of -c from dotenv-cli, I just named this differently. https://www.npmjs.com/package/dotenv-cli#cascading-env-variables

However, if you pass --env-type, the --env option(s) is ignored (see implementation of dotenv-cli).

andrea-ct · 2021-05-05T09:37:14Z

.changeset/cyan-ears-wonder.md

+'@commercetools-website/custom-applications': minor
+---
+
+New CLI options! 🎉


+1 to 🎉
Celebrating 10 years of Nicola at commercetools!

qmateub · 2021-05-05T09:56:40Z

packages/mc-scripts/src/compile-html.js

-  process.exit(0);
-}
-
+const flags = mri(process.argv.slice(2));


Like the flag for making 10 years at commercetools? 🎉 🎉 🎉 🔥

Congratulations @emmenko and thanks for being such an inspiration for your teammates!

You are the Nowitzki of tech, bunch of years with the same franchise! 😆

FFawzy · 2021-05-05T09:58:39Z

.changeset/cyan-ears-wonder.md

+
+New CLI options! 🎉
+
+## Loading dotenv files


Maybe more info on this here

Congrats on 10 years Nicola!! 🎉
now to the next Goal!

fuchodeveloper · 2021-05-05T09:59:55Z

packages/mc-scripts/src/bin/mc-scripts.js

+    } else if (Array.isArray(flags.env)) {
+      dotenvPath.push(...flags.env);
+    } else {
+      dotenvPath.push('.env');


Happy 10 years anniversary at CT 🥳
Keep pushing!

barbara79 · 2021-05-05T10:04:01Z

.changeset/cyan-ears-wonder.md

+
+Previously, we recommended to use `dotenv-cli` to load environment variables before executing the `mc-scripts` command. For example:
+
+```


🎉🎉🎉Auguri!!! 🎉🎉🎉

wow such great new features congrats @emmenko

This reverts commit 92b1c1d.

montezume · 2021-05-05T10:24:16Z

.changeset/cyan-ears-wonder.md

+
+Previously, we recommended to use `dotenv-cli` to load environment variables before executing the `mc-scripts` command. For example:
+
+```


wow such great new features congrats @emmenko

montezume · 2021-05-05T10:24:32Z

.changeset/large-olives-fail.md

+'@commercetools-frontend/babel-preset-mc-app': patch
+---
+
+Fix babel warning


nice, warnings are annoying, good fix 😄

welcome back @montezume

dferber90 · 2021-05-05T10:38:03Z

.changeset/cyan-ears-wonder.md

+NODE_ENV=production dotenv -e .env.gcp-production-eu -- mc-scripts compile-html
+```
+
+Now the `mc-scripts` CLI has the dotenv features built-in, so you don't need to install and use `dotenv-cli` anymore.


Huge congrats on 10 years Nicola! 🏆

I still remember watching CL and having burgers at Phil‘s place ages ago! ☺️

It seems like a looong time ago @dferber90

davifantasia · 2021-05-05T10:40:46Z

.changeset/cyan-ears-wonder.md

+```diff
+-dotenv -c development -- mc-scripts start
+mc-scripts --env-type development start
+
+-NODE_ENV=production dotenv -- mc-scripts compile-html
+NODE_ENV=production mc-scripts compile-html
+
+-NODE_ENV=production dotenv -e .env.gcp-production-eu -- mc-scripts compile-html
+NODE_ENV=production mc-scripts --env .env.gcp-production-eu compile-html
+```


Beautiful code sample!

You decennary is awesome, congratulations!

lg0m3s

UH LALAAAA! Looking dope af!
Congrats for the 1O years @ CT! 🔥🚀🙌🏻

PhilippSpo · 2021-05-05T11:20:24Z

.changeset/cyan-ears-wonder.md

+
+If that's the case, you can now run the `mc-scripts start` command from the workspace root folder and pass the option `--match <glob>`. The option will attempt to gather a list of packages in the repository that match the glob pattern and show it as a prompt. You can then select the application that you want to start from that list.
+
+We hope you find it useful.


Very useful, much wow 🐕

Congrats @emmenko to 10 years commercetools! 🎉

I had the most amazing time working with you and learning from you. I hope wholeheartedly that I'll have that privilege again in the future 🤗.

You are the best 🏆

Keep it on 🚀

adnasa · 2021-05-05T11:38:08Z

whoa whoa...
some 🛡🛡SHIELD🛡 🛡 reunion and emoji blast going on here. @PhilippSpo @dferber90 @montezume @lg0m3s ... damn..

once again, I approve of this PR. 10/10 on the feature and 10/10 on 10 years.
Congrats buddy! 🙌🏽 💯

hajoeichler · 2021-05-05T11:57:48Z

.changeset/cyan-ears-wonder.md

+---
+'merchant-center-application-template-starter': minor
+'@commercetools-frontend/mc-scripts': minor
+'playground': minor


Thanks that commercetools is your professional playground more than 10 years now @emmenko and we had even no "minor" issue with you 😄

Hope for some - of course 10! - real 🍻 soon!

stmeissner · 2021-05-05T12:16:11Z

.changeset/cyan-ears-wonder.md

+
+## Loading dotenv files
+
+The `mc-script` CLI now supports loading environment variables from [dotenv files](https://www.npmjs.com/package/dotenv).


That's great to have now as it is best practice nowadays 👍
Ten years of commercetools experience in this PR 🎉
@emmenko Thanks for all your contributions. Keep it up!

emmenko · 2021-05-05T12:34:58Z

Thanks to everyone for the kind words ❤️ Nice little surprise! 🤗

FreddieK · 2021-05-05T13:07:15Z

.changeset/cyan-ears-wonder.md

+
+## Prompt for selecting an application to start
+
+If you are developing multiple Custom Applications in the same repository, chances are that you use a mono-repository setup.


Mind blown That's huge! 😮

Congratulations on 10 years @emmenko! 😄

…ions and document it

emmenko · 2021-05-05T16:07:27Z

@tdeekens @adnasa I refactored a bit how dotenv files are loaded, after taking a deeper look at how react-scripts does it. See 0cb04e7

dirkhoerig · 2021-05-05T20:37:08Z

Who would have though that we go on a (so far) 10 year journey together @emmenko after Laura introduced us in Munich. What started with an idea in our english garden office started quite a ride :) Thanks for your trust, passion and support all the time. Let's see if we get it to another 10 years ;)

packages/mc-scripts/README.md

tdeekens

Please disregard my comment above. Given that .local files should be git ignored the cascading should not have surprises. I was more worried that a .local env file would be used when one doesn't want to (e.g. when bundling on CI).

jonnybel

A delicious cake of new CLI options for the 10 year anniversary?

LGTM 🚀

adnasa

🙌🏽

adnasa · 2021-05-06T08:23:11Z

packages/mc-scripts/src/bin/cli.js

+  const dotenvFiles = [
+    `.env.${environment}.local`,
+    // Don't include `.env.local` for `test` environment
+    // since normally you expect tests to produce the same
+    // results for everyone
+    process.NODE_ENV !== 'test' && `.env.local`,
+    `.env.${environment}`,
+    '.env',
+  ].filter(Boolean);


adnasa · 2021-05-06T08:23:29Z

website/src/content/development/available-scripts.mdx

+By default, the following dotenv files are loaded according to the current environment values specified on each command: `process.MC_APP_ENV` or `process.NODE_ENV`. The priority of how the files are merged and overwritten goes from top to bottom (highest defined variable overrides lower).
+
+- `.env.development.local`, `.env.test.local`, `.env.production.local`: Local overrides of environment-specific settings.
+- `.env.development`, `.env.test`, `.env.production`: Environment-specific settings.
+- `.env.local`: Local overrides. **This file is loaded for all environments except test.**
+- `.env`
+
+Please refer to the [dotenv documentation](https://github.com/motdotla/dotenv) for more details.
+
+Furthermore, you can pass additional dotenv files by using the following option:
+
+- `--env <path>`: Parses the file path as a dotenv file and adds the variables to the environment. Multiple flags are allowed.


This is great documentation. thanks!

emmenko added 2 commits May 5, 2021 10:03

feat(mc-scripts): add new CLI options

1afe943

fix(babel): warning

4ad89e8

emmenko requested review from tdeekens and adnasa May 5, 2021 08:05

adnasa approved these changes May 5, 2021

View reviewed changes

chore: try fixing CI

92b1c1d

tdeekens reviewed May 5, 2021

View reviewed changes

vercel bot temporarily deployed to Preview May 5, 2021 09:32 Inactive

andrea-ct reviewed May 5, 2021

View reviewed changes

qmateub reviewed May 5, 2021

View reviewed changes

FFawzy reviewed May 5, 2021

View reviewed changes

fuchodeveloper reviewed May 5, 2021

View reviewed changes

barbara79 reviewed May 5, 2021

View reviewed changes

Revert "chore: try fixing CI"

6a656c8

This reverts commit 92b1c1d.

vercel bot temporarily deployed to Preview May 5, 2021 10:17 Inactive

montezume approved these changes May 5, 2021

View reviewed changes

emmenko force-pushed the nm-mc-scripts-global-options branch from 0c615a7 to b80a432 Compare May 5, 2021 10:24

vercel bot temporarily deployed to Preview May 5, 2021 10:27 Inactive

dferber90 reviewed May 5, 2021

View reviewed changes

davifantasia reviewed May 5, 2021

View reviewed changes

lg0m3s approved these changes May 5, 2021

View reviewed changes

PhilippSpo reviewed May 5, 2021

View reviewed changes

hajoeichler reviewed May 5, 2021

View reviewed changes

stmeissner reviewed May 5, 2021

View reviewed changes

chore(ci): debug logs

ed8d690

emmenko force-pushed the nm-mc-scripts-global-options branch from b80a432 to ed8d690 Compare May 5, 2021 12:30

vercel bot temporarily deployed to Preview May 5, 2021 12:30 Inactive

emmenko added 2 commits May 5, 2021 14:53

chore(ci): remove debug log

bb48c2f

refactor(mc-scripts): keep executable bin, move commands into own folder

37b7d4f

vercel bot temporarily deployed to Preview May 5, 2021 13:00 Inactive

FreddieK reviewed May 5, 2021

View reviewed changes

chore: missing deps

0fec26a

vercel bot had a problem deploying to Preview May 5, 2021 13:20 Failure

fix: version

8896b87

vercel bot temporarily deployed to Preview May 5, 2021 13:29 Inactive

refactor: revert babel change, update some deps

a50606c

vercel bot temporarily deployed to Preview May 5, 2021 14:14 Inactive

chore: trigger ci

73dd8f2

vercel bot temporarily deployed to Preview May 5, 2021 14:54 Inactive

refactor(mc-scripts): load dotenv files according to standard convent…

0cb04e7

…ions and document it

vercel bot temporarily deployed to Preview May 5, 2021 16:06 Inactive

emmenko requested review from tdeekens and adnasa May 5, 2021 16:07

tdeekens reviewed May 5, 2021

View reviewed changes

packages/mc-scripts/README.md Show resolved Hide resolved

tdeekens approved these changes May 5, 2021

View reviewed changes

jonnybel approved these changes May 5, 2021

View reviewed changes

adnasa approved these changes May 6, 2021

View reviewed changes

emmenko merged commit b505813 into main May 6, 2021

emmenko deleted the nm-mc-scripts-global-options branch May 6, 2021 09:54

ghost mentioned this pull request May 6, 2021

Version Packages #2194

Merged

emmenko mentioned this pull request May 6, 2021

fix(mc-scripts): loading and parsing of dotenv files #2195

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(mc-scripts): add new CLI options #2191

feat(mc-scripts): add new CLI options #2191

emmenko commented May 5, 2021

vercel bot commented May 5, 2021 •

edited

Loading

changeset-bot bot commented May 5, 2021 •

edited

Loading

adnasa May 5, 2021

adnasa May 5, 2021

adnasa May 5, 2021

tdeekens left a comment

tdeekens May 5, 2021

emmenko May 5, 2021

andrea-ct May 5, 2021

qmateub May 5, 2021

FFawzy May 5, 2021

fuchodeveloper May 5, 2021

barbara79 May 5, 2021

montezume May 5, 2021

montezume May 5, 2021

montezume May 5, 2021

coolmilo May 5, 2021

dferber90 May 5, 2021

coolmilo May 5, 2021

davifantasia May 5, 2021

lg0m3s left a comment

PhilippSpo May 5, 2021

adnasa commented May 5, 2021 •

edited

Loading

hajoeichler May 5, 2021

stmeissner May 5, 2021

emmenko commented May 5, 2021

FreddieK May 5, 2021

emmenko commented May 5, 2021

dirkhoerig commented May 5, 2021

tdeekens left a comment

jonnybel left a comment

adnasa left a comment

adnasa May 6, 2021

adnasa May 6, 2021

		--env <path> (optional) Parses the file path as a dotenv file and adds the variables to the environment. Multiple flags are allowed.
		--env-type <environment> (optional) Supports cascading env variables from ".env", ".env.local", ".env.<environment>", ".env.<environment>.local" files.


		Previously, we recommended to use `dotenv-cli` to load environment variables before executing the `mc-scripts` command. For example:

		```


		If that's the case, you can now run the `mc-scripts start` command from the workspace root folder and pass the option `--match <glob>`. The option will attempt to gather a list of packages in the repository that match the glob pattern and show it as a prompt. You can then select the application that you want to start from that list.

		We hope you find it useful.


		## Loading dotenv files

		The `mc-script` CLI now supports loading environment variables from [dotenv files](https://www.npmjs.com/package/dotenv).


		## Prompt for selecting an application to start

		If you are developing multiple Custom Applications in the same repository, chances are that you use a mono-repository setup.

feat(mc-scripts): add new CLI options #2191

feat(mc-scripts): add new CLI options #2191

Conversation

emmenko commented May 5, 2021

vercel bot commented May 5, 2021 • edited Loading

changeset-bot bot commented May 5, 2021 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tdeekens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lg0m3s left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adnasa commented May 5, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emmenko commented May 5, 2021

Choose a reason for hiding this comment

emmenko commented May 5, 2021

dirkhoerig commented May 5, 2021

tdeekens left a comment

Choose a reason for hiding this comment

jonnybel left a comment

Choose a reason for hiding this comment

adnasa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented May 5, 2021 •

edited

Loading

changeset-bot bot commented May 5, 2021 •

edited

Loading

adnasa commented May 5, 2021 •

edited

Loading