Added Getting Started instructions #107

arthurvi · 2016-10-06T07:14:44Z

Instructions I was missing to get started using this date picker
See #45
closes #45

Instructions I was missing to get started using this date picker See react-dates#45 closes react-dates#45

coveralls · 2016-10-06T07:25:41Z

Coverage remained the same at 88.235% when pulling 1af2423 on arthurvi:patch-1 into 8c03d77 on airbnb:master.

vladbalan · 2016-10-08T06:24:02Z

👍

majapw

LGTM after comments are addressed! Thanks for this. This has been a long time coming. :)

majapw · 2016-10-10T23:34:09Z

README.md

+```
+Make sure you have the following dependencies installed:
+```
+ npm install --save moment react react-dom react-addons-shallow-compare


While I agree this is clearer as to what is happening, the other command @ljharb added helps us specify version numbers. This command ultimately just installs the latest version of the package and not the supported version. This becomes a problem with (a) semver-major changes if we haven't audited them yet and (b) bugs in newer releases (like when moment released 1.15.0 and it broke all our tests). I would prefer to leave the slightly more confusing and more correct command here.

yes, please do not delete the command i used before.

would it be possible to abstract this into an package.json script? some of us are on windows systems so ideally the command would be compatible with windows, as well? Also, I could not get this command to play nicely with yarn: yarn info react-dates peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g; s/ *//g' | xargs yarn add react-dates

Here is the output for me from running just the following yarn info react-dates peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g; s/ *//g':

"type":"inspect""data":"moment":"2.10-2.14||^2.15.1""react":">=0.14""react-dom":">=0.14""react-addons-shallow-compare":">=0.14" "type":"finished""data":630

oops some of my message got cut off... trace is below - it looks like type: inspectdata is throwing it off (as I imagine the final type statement will also cause errors)... not sure if this is standard output or if it's because I'm a naive Cygwin user and I'm doing something wrong - if it is standard output I'm guessing npm just ignores the type stuff?

Trace: Error: type:inspectdata/:moment:2.10-2.14%7C%7C%5E2.15.1react:%3E=0.14react-dom:%3E=0.14react-addons-shallow-compare:%3E=0.14: Invalid protocol: type: at Request.init (C:\Program Files (x86)\Yarn\node_modules\request\request.js:460:31) at new Request (C:\Program Files (x86)\Yarn\node_modules\request\request.js:129:8) at request (C:\Program Files (x86)\Yarn\node_modules\request\index.js:55:10) at RequestManager.execute (C:\Program Files (x86)\Yarn\lib\util\request-manager.js:327:17) at RequestManager.shiftQueue (C:\Program Files (x86)\Yarn\lib\util\request-manager.js:353:10) at data (C:\Program Files (x86)\Yarn\lib\util\request-manager.js:251:12) at Request.params.callback [as _callback] (C:\Program Files (x86)\Yarn\lib\util\request-manager.js:305:11) at Request.self.callback (C:\Program Files (x86)\Yarn\node_modules\request\request.js:187:22) at emitTwo (events.js:106:13) at Request.emit (events.js:191:7)

looking into this further - it's possible yarn has better support for installing peer dependencies via the --peer flag, but I've also put together a Powershell script for the Windows users - should this be the expected output?

npm install --save react-dates moment@"2.10-2.14||^2.15.1" react@">=0.14" react-addons-shallow-compare@">=0.14" react-dom@">=0.14"

here is the script to produce that - it's not as clean and elegant as your unix script, but it gets the job done:

$ErrorActionPreference = "SilentlyContinue" $json = (npm info react-dates peerDependencies --json) | ConvertFrom-Json $props = $json.data | Get-Member -membertype properties $command = "npm install --save react-dates "; foreach($prop in $props) { $command += $prop.Name + "@`"" + (($json.data | Select -ExpandProperty $prop.Name) -replace '\s') + "`" " } Invoke-Expression $command

(note I'm not a frequent powershell user so there may be room for improvement here... there's also probably a more canonically correct way of doing this via npm packages that would work across operating systems)

@majapw @ljharb thoughts on the above? seems like arthurvi isn't going to update this PR so I can pick up where he left off

Let's keep the install script as it is in the readme.

If you'd like to put up a replacement PR, that'd be great!

@ljharb alright I'm good with this now that I see it runs in Git Bash... I couldn't get it to run under Cygwin or Cmder which is why I put the script together in the first place.. will put in an updated PR soon

@ljharb I'm mostly concerned with clarifying the install which seems to be accounted for here: #168 so does not like I'll need to submit a PR anymore ... the rest of this stuff should be clarified by examples and is pretty standard

majapw · 2016-10-10T23:37:25Z

README.md

+#### Make some awesome datepickers
+```
+<SingleDatePicker
+	id="date_input"


nit: the Airbnb JS style guide prefers 2-space indentation. :P

vladinator1000 · 2016-11-08T01:15:08Z

This is super helpful!

Update README.md

arthurvi · 2016-11-25T15:44:18Z

Whoops! Totally forgot about this one!
I think it is done, should be merged with a squash I guess.

coveralls · 2016-11-25T15:49:18Z

Coverage remained the same at 87.04% when pulling 30baa9e on arthurvi:patch-1 into 2d86825 on airbnb:master.

coveralls · 2016-11-25T15:55:58Z

Coverage remained the same at 87.04% when pulling 30baa9e on arthurvi:patch-1 into 2d86825 on airbnb:master.

coveralls · 2016-11-25T16:00:29Z

Coverage remained the same at 87.04% when pulling 30baa9e on arthurvi:patch-1 into 2d86825 on airbnb:master.

coveralls · 2016-11-25T16:08:52Z

Coverage remained the same at 87.04% when pulling 30baa9e on arthurvi:patch-1 into 2d86825 on airbnb:master.

majapw · 2016-11-29T20:44:19Z

Hey @arthurvi can you squash it down yourself and push it back up? I'll merge it in after that. :)

code review fix

…ker is opened

coveralls · 2016-12-01T08:47:38Z

Coverage remained the same at 86.657% when pulling 1557fa1 on arthurvi:patch-1 into 32bb58d on airbnb:master.

coveralls · 2016-12-01T08:51:28Z

Coverage remained the same at 86.657% when pulling 1557fa1 on arthurvi:patch-1 into 32bb58d on airbnb:master.

arthurvi · 2016-12-01T09:01:02Z

New PR: #202
@majapw It can be merged now I guess! I got a little over enthusiastic in squashing things in the previous branch, so here is a cleaner version... 😬

Added Getting Started instructions

1af2423

Instructions I was missing to get started using this date picker See react-dates#45 closes react-dates#45

majapw approved these changes Oct 10, 2016

View reviewed changes

ljharb mentioned this pull request Oct 27, 2016

your documentation is terrible #150

Closed

Update README.md

8af93de

jpollard-cs mentioned this pull request Nov 4, 2016

Missing dependency react-addons-shallow-compare #14

Closed

jpollard-cs mentioned this pull request Nov 8, 2016

Clarified "How to Install" in readme #168

Closed

arthurvi added 2 commits November 25, 2016 16:38

Merge branch 'master' into patch-1

9631d79

Merge pull request #1 from jpollard-cs/patch-2

eb42499

Update README.md

arthurvi and others added 4 commits December 1, 2016 09:41

Keep the old way of installing dependencies

4ca3fa2

https://github.com/airbnb/react-dates/issues/171

51a39ae

Update config.js

a9027ea

code review fix

Adjusts DayPicker height and initialize width right before the DayPic…

1557fa1

…ker is opened

arthurvi force-pushed the patch-1 branch from 7a4f12d to 1557fa1 Compare December 1, 2016 08:42

arthurvi closed this Dec 1, 2016

arthurvi deleted the patch-1 branch December 1, 2016 08:43

arthurvi restored the patch-1 branch December 1, 2016 08:44

arthurvi mentioned this pull request Dec 1, 2016

Added Getting Started instructions #202

Merged

Uh oh!

Added Getting Started instructions #107

Added Getting Started instructions #107

Uh oh!

Conversation

arthurvi commented Oct 6, 2016

Uh oh!

coveralls commented Oct 6, 2016

Uh oh!

vladbalan commented Oct 8, 2016

Uh oh!

majapw left a comment

Choose a reason for hiding this comment

Uh oh!

majapw Oct 10, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ljharb Oct 11, 2016

Choose a reason for hiding this comment

Uh oh!

jpollard-cs Oct 28, 2016

Choose a reason for hiding this comment

Uh oh!

jpollard-cs Oct 28, 2016

Choose a reason for hiding this comment

Uh oh!

jpollard-cs Oct 28, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jpollard-cs Nov 4, 2016

Choose a reason for hiding this comment

Uh oh!

ljharb Nov 4, 2016

Choose a reason for hiding this comment

Uh oh!

jpollard-cs Nov 8, 2016

Choose a reason for hiding this comment

Uh oh!

jpollard-cs Nov 11, 2016

Choose a reason for hiding this comment

Uh oh!

majapw Oct 10, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vladinator1000 commented Nov 8, 2016

Uh oh!

arthurvi commented Nov 25, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Nov 25, 2016

Uh oh!

coveralls commented Nov 25, 2016

Uh oh!

coveralls commented Nov 25, 2016

Uh oh!

coveralls commented Nov 25, 2016

Uh oh!

majapw commented Nov 29, 2016

Uh oh!

coveralls commented Dec 1, 2016

Uh oh!

coveralls commented Dec 1, 2016

Uh oh!

arthurvi commented Dec 1, 2016 • edited by ljharb Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

majapw Oct 10, 2016 •

edited

Loading

jpollard-cs Oct 28, 2016 •

edited

Loading

majapw Oct 10, 2016 •

edited

Loading

arthurvi commented Nov 25, 2016 •

edited

Loading

arthurvi commented Dec 1, 2016 •

edited by ljharb

Loading