This repository has been archived by the owner on Sep 30, 2020. It is now read-only.
docs: simplify instructions in README #53
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
While preparing this: brianchandotcom/liferay-portal#75811 I realized that the instructions in the README here were wrong: you don't need to extend "liferay/portal" explicitly ever; instead you get it by default thanks to liferay-npm-scripts. This is true even when you extend "liferay/react" or "liferay/metal" in liferay-portal -- you wind up with a merged list of "liferay/portal" plus "liferay/react" (or "liferay/metal"). So, I de-emphasized the "liferay/portal" section by moving it down, and I noted that it is used automatically. I also simplified the ".eslintrc.js" examples by removing the empty "rules" sections, because we don't want to actively encourage overriding in any case.
liferay-continuous-integration-hu
pushed a commit
to jcampoy/liferay-portal
that referenced
this pull request
Oct 21, 2019
As described here: liferay/eslint-config-liferay#53 I realized that we don't need to include "liferay/portal" explicitly because it already has effect everywhere, automatically, thanks to liferay-npm-scripts. I'll make the next version of liferay-npm-scripts detect and report this kind of redundancy to stop these sneaking in again.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While preparing this:
brianchandotcom/liferay-portal#75811
I realized that the instructions in the README here were wrong: you don't need to extend "liferay/portal" explicitly ever; instead you get it by default thanks to liferay-npm-scripts. This is true even when you extend "liferay/react" or "liferay/metal" in liferay-portal -- you wind up with a merged list of "liferay/portal" plus "liferay/react" (or "liferay/metal").
So, I de-emphasized the "liferay/portal" section by moving it down, and I noted that it is used automatically.
I also simplified the ".eslintrc.js" examples by removing the empty "rules" sections, because we don't want to actively encourage overriding in any case.