Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

chore: Initial setup of lerna #16

Merged
merged 2 commits into from
Nov 20, 2018
Merged

chore: Initial setup of lerna #16

merged 2 commits into from
Nov 20, 2018

Conversation

pksunkara
Copy link
Contributor

@pksunkara pksunkara commented Nov 15, 2018

Haven't tested publishing yet, will add it to readme after that is done and finalized.

@pksunkara
Copy link
Contributor Author

Addressed.

@honzajavorek
Copy link
Contributor

You are using yarn?

@kylef
Copy link
Member

kylef commented Nov 20, 2018

@pksunkara Can you please elaborate on why Yarn was required? You mentioned that Lerna needed Yarn but it doesn't seem to mention that anywhere in the docs. The only mention I see of yarn is in https://github.com/lerna/lerna/blob/8c2843f00e4a95359e3badf5a88927947a45cf2d/FAQ.md#the-bootstrap-process-is-really-slow-what-can-i-do which seems to indicate both NPM and Yarn are supported.

If so, to use lerna and api-elements.js locally, I personally can use NPM instead of Yarn? It seems to be user preference, is that right or am I missing something.

If it is completely user preference, then perhaps the docs in README.md should just use NPM for simplicity, those users who want to use Yarn can figure that out themselves?

@pksunkara
Copy link
Contributor Author

I meant lerna has the option to use yarn workspaces feature which is way faster than npm. The difference was night and day since I had the same thought as you and was using npm initially when I was experimenting with lerna.

Copy link
Contributor

@honzajavorek honzajavorek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a few comments, but I didn't find anything to prevent me to approve this PR and to allow remediations in follow-up PRs if we agree I have good points 🙂


console.log(parseResult);
The documentation is built using Sphinx, a Python tool. Assuming you have
Python 3 installed, the following steps can be used to build the site.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be used to build the site

The sentence isn't entirely true. The following steps get you as far as having the docs stack installed, but doesn't give you any clues on the further workflow.

},
"engines": {
"node": ">=4"
"lerna": "^3.4.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to use ^?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

"license": "MIT",
"dependencies": {
"minim": "^0.20.5",
"minim-parse-result": "^0.10.1"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to use ^-s? (comment applies to all deps in this file)

@honzajavorek
Copy link
Contributor

Also, if Yarn isn't required by users of API Elements and it brings benefit (not overhead) to the maintainers to this package, then I approve. OTOH I'd prefer to have this decision (the why) explicitly documented in the README (or any kind of contributing / maintainers' docs).

Co-Authored-By: pksunkara <[email protected]>
@pksunkara
Copy link
Contributor Author

@kylef Some of HJ's comments are about api-elements.js npm package

@pksunkara pksunkara merged commit 23750af into master Nov 20, 2018
@pksunkara pksunkara deleted the pksunkara/lerna branch November 20, 2018 16:15
@kylef
Copy link
Member

kylef commented Nov 20, 2018

@honzajavorek Regarding the documentation, I've created #17 with the changes you mentioned and some more.

pksunkara pushed a commit that referenced this pull request Dec 12, 2018
…-0.17.0

Update fury-adapter-swagger to the latest version 🚀
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants