https://github.com/sandrodw3/liferay-dev-cli
Command line framework to work with a Liferay Portal project
https://github.com/sandrodw3/liferay-dev-cli
deno liferay typescript
Last synced: 2 months ago
JSON representation
Command line framework to work with a Liferay Portal project
- Host: GitHub
- URL: https://github.com/sandrodw3/liferay-dev-cli
- Owner: sandrodw3
- Created: 2023-10-17T20:34:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T10:40:58.000Z (11 months ago)
- Last Synced: 2024-11-05T11:42:42.749Z (11 months ago)
- Topics: deno, liferay, typescript
- Language: TypeScript
- Homepage:
- Size: 43.9 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Liferay Dev CLI
**Liferay Dev CLI** (`lfr`) is a command-line framework designed to streamline everyday tasks in a Liferay development environment, enabling developers to execute common actions from anywhere within the project without the need to switch modules or navigate to specific directories. Tasks that usually require more steps than desired, such as deploying all modified modules in a branch, formatting it, starting the portal with the latest Tomcat version, running Playwright tests, and much more, will be now easily accessible. Available for **Linux** and **MacOS**.
[![deno_badge_url]][deno_url]
[![typescript_badge_url]][typescript_url]
## 🪄 Examples
## ⚡️ Installation
`lfr` is available for **Linux** and **MacOS**.
### Install prerequisites
- [`deno`][deno_installation_url] (**v2.2.8** or higher required)
- [`fzf`][fzf_installation_url]
### Install Liferay Dev CLI
```
curl -fsSL https://raw.githubusercontent.com/sandrodw3/liferay-dev-cli/main/install.sh | sh
```
## 💡 Usage
Just run `lfr [command]` with any desired options. All commands include a `-h` option to display help. You can also run just `lfr` to see the full CLI help.
By default, `lfr` uses a minimalist and compact output for its commands. Most of them have a `-d` option available to display the traditional output of each one.
There's also available an `lfr upgrade` command to update the CLI to its latest version and an `lfr config` one to set the necessary configuration for the CLI to work.
## ⚙️ Commands
Explanation and description of how each of the commands and their available options work.
- [`ant-all`](#ant-all)
- [`build-lang`](#build-lang)
- [`config`](#config)
- [`deploy`](#deploy)
- [`find`](#find)
- [`format`](#format)
- [`node-scripts`](#node-scripts)
- [`jest`](#jest)
- [`playwright`](#playwright)
- [`poshi`](#poshi)
- [`start`](#start)
- [`stop`](#stop)
- [`upgrade`](#upgrade)
### `ant-all`
Run ant all in the current Liferay portal project. `-c` option can be passed to remove `bundles` folder (except properties files) before doing it. `bundles` folder path is taken from `app.server.parent.dir` variable of `app.server.[username].properties` file, or in the default `app.server.properties` if the first one is not present.
```
lfr ant-all
```
| Option | Description |
| ---------------------- | ------------------------------------------------------------------------------------------ |
| `-c, --clean` | Remove bundles folder (except properties files) and untracked files before running ant all |
| `-d, --default-output` | Log the default output |
| `-p, --profile` | Set the given profile (valid values are **dxp** and **portal**) |
### `build-lang`
Execute `buildLang` in `portal-language-lang` module.
```
lfr build-lang
```
### `config`
Allow setting user configuration, that is stored in `.lfr/config.json` file in user's folder. This configuration is needed for the app to work correclty. MySQL config is optional, it's only used to start the portal with a clean database.
```
lfr config [entry] [value]
```
| Entry | Description |
|---------------|----------------------------------------------------------------------------------------------------|
| `portal.path` | Liferay portal path |
| `base.branch` | Base branch to be used for example to compare and get the modified modules of a branch |
| `mysql.user` | MySQL user |
| `mysql.pw` | MySQL password |
| `mysql.db` | Name of Liferay Portal MySQL database |
| Option | Description |
| -------------- | --------------------------------------------------------- |
| `-m, --modify` | Allow modifying current config values |
| `-s, --show` | Show current configuration |
### `deploy`
Deploy a module or a bunch of them, depending on options. If no passing `-m` or `-b` options, deploy the current module.
```
lfr deploy
```
| Option | Description |
| ------------------------- | ---------------------------------------------------------------------------- |
| `-a, --skip-dependencies` | Do not rebuild project dependencies (equivalent to `gradlew deploy -a`) |
| `-b, --current-branch` | Deploy all modules modified in current branch |
| `-c, --clean` | Clean everything from previous builds (equivalent to `gradlew clean deploy`) |
| `-d, --default-output` | Log the default gradle output |
| `-m, --module` | Allow selecting a specific module to deploy |
### `find`
Allow finding a module and getting its path. Requires [fzf](https://github.com/junegunn/fzf) to be used. This command is useful to use the result for another thing. For example, you could do a bash script like `module=$(lfr find); code module`, and it would allow you to select a module and open it with VS Code.
```
lfr find
```
### `format`
Format a module or a branch, depending on options. If no passing options, format the current module with `gradlew formatSource`.
```
lfr format
```
| Option | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `-b, --current-branch` | Format the current branch (`ant format-source-current-branch`, `npx node-scripts check:tsc --current-branch` and `npx node-scripts check:ci --current-branch`) |
| `-d, --default-output` | Log the default output |
| `-m, --module` | Allow selecting a specific module to format (`gradlew formatSource`) |
### `node-scripts`
Run `node-scripts` commands globally or in current module.
```
lfr node-scripts [command]
```
| Option | Description |
| ---------------------- | ------------------------------------------------------------- |
| `-a, --all` | Execute the command for everything |
| `-b, --current-branch` | Execute the command considering changes in the current branch |
| `-g, --global` | Run the command globally |
| `-l, --local-changes` | Execute the command considering only uncommitted changes |
### `jest`
Run Jest tests in a module or multiple modules.
```
lfr jest
```
| Option | Description |
| ---------------------- | ---------------------------------------------------------------------------- |
| `-b, --current-branch` | Run tests in all modules modified in current branch |
| `-d, --default-output` | Log the default output |
| `-m, --module` | Allow selecting a specific module to run tests |
### `playwright`
Run Playwright tests in a file or module.
```
lfr playwright
```
| Option | Description |
| -------------- | ------------------------------ |
| `--ui` | Run tests in UI mode |
| `-m, --module` | Run tests in a specific module |
### `poshi`
Run the given Poshi test. The `[test]` argument should be specified as `File#TestName` (e.g., `PortalSmoke#Smoke`).
```
lfr poshi [test]
```
### `start`
Start portal with the latest Tomcat version. MySQL configuration needs to be set to be able to use `-c` option to start with a clean database. `bundles` folder path is taken from `app.server.parent.dir` variable of `app.server.[username].properties` file, or in the default `app.server.properties` if the first one is not present.
```
lfr start
```
| Option | Description |
| ------------- | ----------------------------------------------------------------------------- |
| `-c, --clean` | Clean database before starting (this option requires `mysql` to be installed) |
### `stop`
Stop the currently running portal instance.
```
lfr stop
```
### `upgrade`
Upgrade `lfr` to its latest version.
```
lfr upgrade
```
[deno_badge_url]: https://img.shields.io/badge/Deno-464647?style=for-the-badge&logo=deno&logoColor=white
[deno_installation_url]: https://github.com/denoland/deno/?tab=readme-ov-file#installation
[deno_url]: https://deno.com/
[fzf_installation_url]: https://github.com/junegunn/fzf?tab=readme-ov-file#installation
[typescript_badge_url]: https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white
[typescript_url]: https://www.typescriptlang.org/