Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(scripts): add top-level sinopsis #100

Merged
merged 2 commits into from
Oct 1, 2020
Merged

docs(scripts): add top-level sinopsis #100

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fd23c3
docs(scripts): add top-level sinopsis
wincent Oct 1, 2020
35595e7
docs(scripts): over-promise and almost-deliver
wincent Oct 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion projects/npm-tools/packages/npm-scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# @liferay/npm-scripts

`@liferay/npm-scripts` is our principal abstraction for building, formatting, linting, and testing frontend code in [liferay-portal](https://github.com/liferay/liferay-portal). It provides:

- **A simplified interface:** The `liferay-npm-scripts` command-line implements a small number of subcommands such as `build`, `checkFormat` and `test`, most of which don't require any arguments and do the right thing "out-of-the-box", automatically.
- **Industry-standard dependencies:** `@liferay/npm-scripts` brings a set of well-tested and robust dependencies including Babel, ESLint, Jest, Prettier, and others, ensuring that people working anywhere in liferay-portal have access to a single, consistent set of tools.
Copy link
Contributor

Choose a reason for hiding this comment

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

We say here working [...] in liferay-portal but below we state to work in a Liferay environment.

I know it's not ready for prime time yet, but maybe the second is better suited as this should grow beyond the liferay-portal repo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You got me there. It's still a wee bit aspirational, but changing it wouldn't be egregiously misleading.

- **Reasonable default configuration:** All of the bundled tools come with configurations that have been tuned to work in a Liferay environment, and can be overridden via standard configuration files (eg. `.eslintrc.js` etc) on the rare occasions that it is necessary to do so.

While `@liferay/npm-scripts` was designed with liferay-portal in mind, it is also used in other projects such as [liferay-learn](https://github.com/liferay/liferay-learn); see [this issue](https://github.com/liferay/liferay-frontend-projects/issues/91) for context.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is our client!!


## Usage

```sh
Expand All @@ -20,7 +28,7 @@ npm install --save-dev @liferay/npm-scripts

### build

Build script that compiles all necessary javascript, soy, and bundles it together using `liferay-npm-bundler`.
Build script that compiles all necessary JavaScript, soy, and bundles it together using `liferay-npm-bundler`.

```sh
liferay-npm-scripts build
Expand Down