ADD a CLI for bootstrapping #1216

ndelangen · 2017-06-08T07:30:35Z

Issue: -bootstrapping process is becoming too much manual work-

What I did

I wrote a CLI for bootstrapping

How to test

run the following commands:

npm run bootstrap # will give a prompt
npm run bootstrap -- --all # will skip the prompt and bootstrap everything

TODO

Use npm run bootstrap -- --all on CI

shilman

See my suggestion above

shilman · 2017-06-08T10:36:39Z

scripts/bootstrap.js

+  });
+}
+
+if (program.docs) {


What about something like this to replace all of these if statements:

Object.keys(todo).forEach(key => { todo[key] = program[key] || program.all })

Will do this, thanks!

theinterned

Looks good!

As per my comment, I wonder if the default behaviour should be to bootstrap all, with a flag to --pick or --interactive or --prompt which options to bootstrap.

But I am not very strong on that suggestion. It just seems like it may be more familiar to users.

theinterned · 2017-06-08T18:26:59Z

scripts/bootstrap.js

+
+program
+  .version('1.0.0')
+  .option('--all', 'Run all without asking')


Should --all be the default and instead a --interactive or --pick flag would launch the interactive picker?

I'm assuming developers want to type LESS ?

I think interactive mode is a sane default for a developer tool ?

I think I agree ... just raised the consideration of keeping the normal bootstrap behaviour default with the interactive bootstrapping be a power mode. But this is more discoverable!

ndelangen · 2017-07-04T13:16:17Z

I need to rebase this, good opportunity to review npm install correctness /cc @tmeasday

tmeasday · 2017-07-05T02:09:31Z

"npm install correctness" -> Not quite sure what you mean by this @ndelangen? Do you mean in general or something that this PR is doing? (it doesn't seem to be touching our npm setup too much, AFAICT).

ndelangen · 2017-07-05T08:12:47Z

npm 5.0.4 was released, so maybe we can get rid of npmc, is what I meant. See merge conflicts.

tmeasday · 2017-07-05T09:29:48Z

Makes sense to me, although I am not entirely clear on why we needed npmc to begin with.

shilman · 2017-07-22T06:39:38Z

@ndelangen can we close this now?

ndelangen · 2017-07-23T10:28:53Z

No I will actually finish and add this soonish.

ndelangen · 2017-08-21T06:01:13Z

Script is now also capable of reset task. It will do a git clean and reinstall root dependencies.

ndelangen · 2017-08-21T06:09:41Z

package.json

-      "npm run lint:md -- -o",
-      "git add"
-    ]
+    "linters": {


I had trouble with lint-staged trying to git add multiple things in parallel, which fails because git's lockfile would exist.

I disabled concurrency for this reason. Depending on the amount of files in your stage, this will make the process a second or 2 slower, but git add is reliable.

@ndelangen seems like this is a separate PR?

# Conflicts: # .circleci/config.yml

ndelangen · 2017-08-23T15:54:28Z

@shilman @storybooks/team can you approve ?

shilman · 2017-08-23T07:11:50Z

package.json

-      "npm run lint:md -- -o",
-      "git add"
-    ]
+    "linters": {


@ndelangen seems like this is a separate PR?

shilman · 2017-08-23T15:58:23Z

scripts/bootstrap.js

+    option: '--reset',
+    command: () => {
+      log.info(prefix, 'git clean');
+      spawn('git clean -fdx');


What do you think about just running lerna clean instead of git clean -fdx which is much more destructive?

It should be completely destructive to anything not managed by git. Anything added not known by or ignored by git should be removed. The desired end-result is as if you just cloned the repo.

In fact, git clean -fdx breaks my IDE setup each time

@Hypnosphi Can you give me a list / regexp that you IDE adds that should NOT be cleaned away?
https://git-scm.com/docs/git-clean#git-clean--eltpatterngt

shilman · 2017-08-23T15:59:04Z

scripts/bootstrap.js

+    });
+    process.stdout.write('\x07');
+    try {
+      spawn('say "Bootstrapping sequence complete"');


AWESOME 💯

Lol, I'm actually concerned this will be annoying to linux and windows users, will have to ask @usulpro maybe?

won't it just fail silently on those platforms?

shilman · 2017-08-23T16:02:24Z

scripts/bootstrap.js

+      log.info(prefix, 'git clean');
+      spawn('git clean -fdx');
+      log.info(prefix, 'yarn install');
+      spawn('yarn install --no-lockfile');


why no lockfile? i think yarn's lockfiles work pretty well cc @Hypnosphi

We're currently ignoring them, so not generating them in the first place is better.

Let's discuss enabling yarn lockfiles outside this PR?

Let's do it: #1703

…oved with git clean

…rybook into improve-bootstrap-command

shilman · 2017-08-23T18:41:10Z

scripts/bootstrap.js

+    option: '--reset',
+    command: () => {
+      log.info(prefix, 'git clean');
+      spawn('git clean -fdx --exclude=".vscode" --exclude=".idea"');


Really have to object here. This is a destructive operation and there is no warning to the user.

Propose one or more of:

warning in name e.g. "CAUTION removes all files not associated with git!"

confirmation step: "This removes all files not associated with git. Are you sure?"

another bootstrap command (clean = lerna clean, reset = git clean -fdx with warnings)

I'll take a look at adding a "Are you sure you want to do what you told me to do" confirmation screen.

It's not really clear, what are the files that will get deleted. Can those be my kitten gifs from personal directory?

Yes, those will get deleted 🐈 🚫 /jk

Got a suggestion?

State exactly what will be removed: all the files not present in git, except for .idea and .vscode. This is more verbose, but also more fair

…en `--reset` is set

shilman · 2017-08-23T22:41:23Z

@ndelangen great job on this! 🎯 💯 🎖

ADD a CLI for bootstrapping

369ac55

ndelangen added the maintenance User-facing maintenance tasks label Jun 8, 2017

ndelangen added this to the v3.0.2 milestone Jun 8, 2017

ndelangen self-assigned this Jun 8, 2017

ndelangen requested review from theinterned, aaronmcadam, tmeasday, shilman and benediktvaldez June 8, 2017 07:30

ndelangen added in progress ci: do not merge labels Jun 8, 2017

shilman requested changes Jun 8, 2017

View reviewed changes

theinterned approved these changes Jun 8, 2017

View reviewed changes

Merge branch 'master' into improve-bootstrap-command

5726f13

shilman modified the milestones: v3.1.2, v3.1.3, v3.1.4 Jun 9, 2017

ndelangen added 2 commits July 23, 2017 12:30

Merge branch 'master' into improve-bootstrap-command

27edf5e

set as default bootstrap command && add core as default

4f4b9e4

FIX circleCI.yml

b215110

REVERT incorrect changes on docs/pages

7940e62

ndelangen commented Aug 21, 2017

View reviewed changes

Merge branch 'master' into improve-bootstrap-command

879928d

# Conflicts: # .circleci/config.yml

ndelangen removed ci: do not merge in progress labels Aug 23, 2017

ndelangen removed this from the v3.3.0 milestone Aug 23, 2017

ADD crna-kitchen-sink bootstrap command

1843196

Hypnosphi self-requested a review August 23, 2017 11:01

Merge branch 'master' into improve-bootstrap-command

43b8753

ndelangen closed this Aug 23, 2017

ndelangen reopened this Aug 23, 2017

shilman reviewed Aug 23, 2017

View reviewed changes

ndelangen added 3 commits August 23, 2017 18:43

Merge branch 'master' into improve-bootstrap-command

9f30bbf

ADD .vscode and .idea to gitignore, but whitelist them from being rem…

f84623d

…oved with git clean

Merge branch 'improve-bootstrap-command' of github.com:storybooks/sto…

6dd4ae7

…rybook into improve-bootstrap-command

shilman approved these changes Aug 23, 2017

View reviewed changes

ndelangen added 2 commits August 23, 2017 20:35

ADD -- --core to CONTRIBUTING.md

0723401

Merge branch 'master' into improve-bootstrap-command

7fd661c

shilman requested changes Aug 23, 2017

View reviewed changes

ndelangen added 3 commits August 23, 2017 21:16

ADD a confirmation step when doing the reset task, it will NOT ask wh…

30e7c37

…en `--reset` is set

Merge branch 'master' into improve-bootstrap-command

faec65e

IMPROVE confirm message

55a2b9a

shilman approved these changes Aug 23, 2017

View reviewed changes

shilman merged commit 599db93 into master Aug 23, 2017

shilman deleted the improve-bootstrap-command branch August 23, 2017 22:41

dependencies bot mentioned this pull request Nov 11, 2017

Update 2 dependencies from npm #2290

Merged

ADD a CLI for bootstrapping #1216

ADD a CLI for bootstrapping #1216

Conversation

ndelangen commented Jun 8, 2017 • edited Loading

What I did

How to test

TODO

shilman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

theinterned 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

ndelangen commented Jul 4, 2017

tmeasday commented Jul 5, 2017 • edited Loading

ndelangen commented Jul 5, 2017

tmeasday commented Jul 5, 2017

shilman commented Jul 22, 2017

ndelangen commented Jul 23, 2017

ndelangen commented Aug 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ndelangen commented Aug 23, 2017

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

ndelangen Aug 23, 2017 • edited Loading

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

ndelangen Aug 23, 2017 • edited Loading

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

shilman commented Aug 23, 2017

ndelangen commented Jun 8, 2017 •

edited

Loading

tmeasday commented Jul 5, 2017 •

edited

Loading

ndelangen Aug 23, 2017 •

edited

Loading

ndelangen Aug 23, 2017 •

edited

Loading