Skip to content

Commit

Permalink
Move docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xiwenc committed Sep 16, 2024
1 parent 8a01db7 commit 5d5cfc9
Showing 1 changed file with 3 additions and 77 deletions.
80 changes: 3 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,7 @@
# Mendix CLI Extension for Mendix Studio Pro
# MxLint Extension for Mendix Studio Pro

While [mendix-cli](https://github.com/mxlint/mxlint-cli) is designed for pipeline automation, this extension is designed to be used in Mendix Studio Pro. This extension gives you quicker feedback to avoid surprises when you are ready to deploy your app.
While [mxlint-cli](https://github.com/mxlint/mxlint-cli) is designed for pipeline automation, this extension is designed to be used in Mendix Studio Pro. It gives you quicker feedback to avoid surprises when you are ready to deploy your app.

> This is still early stage of development. Follow this project for future updates.

https://github.com/user-attachments/assets/e23aab95-2b03-4e88-bb87-902fd99cf774


## Try out

- Download this repo as a zipfile
- Unpack the archive
- Open Mendix Studio pro with extension development flag, see Test section below
- Open the test app locally which can be found inside of the project at `resources/App`

> If you want to try this on your own project, just copy the `extensions` directory from the test app here into your app.
## Good to know

- This extension uses mendix-cli tool behind the scenes
- Policies are cached inside of `.mendix-cache/policies` folder of your project
- You can add or modify policies inside of the cache folder
- mendix-cli is cached inside of `.mendix-cache` as well. You can sideload your version if desired
- Current UX is not fantastic yet. Mostly due to spawning heavy process to export and check the model.


## Development Environment

- [Pico CSS](https://picocss.com/docs)


### OSX (MacOS)

- [Visual Studio Code](https://code.visualstudio.com/)
- [Mendix Studio Pro 10.12.2](https://marketplace.mendix.com/link/studiopro)
- [dotNet core SDK vscode](https://dot.net/core-sdk-vscode)
- C# dev kit VSCode extension (inside of VSCode)

#### Build

```bash
make

```

#### Test

- Open Mendix Studio Pro with `--enable-extension-development` flag: `/Applications/Studio\ Pro\ 10.12.2.41995-Beta.app/Contents/MacOS/studiopro --enable-extension-development`

- Open local project located in `resources/App`

### Windows

- [Visual Studio 2022](https://visualstudio.microsoft.com/)
- [Mendix Studio Pro 10.12.2](https://marketplace.mendix.com/link/studiopro)

### Dev

Open Powershell as Administrator and run the following commands:

```powershell
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
```

Then run the script to build and test the extension:

```powershell
.\dev\build-windows.ps1
```

#### Build

- Open `MendixCliExtension.sln` in Visual Studio and hit `F6` to build the project.
- Copy the output of `bin/Debug/net5.0` to `resources/App/extenions/MendixCLIExtension`: `copy-item -force -recurse .\bin\Debug\net8.0\* .\resources\App\extensions\MendixCLIExtension\`

#### Test

- Open studiopro.exe with `--enable-extension-development` flag.
- Open local project located in `resources/App`
See the [official docs](https://mxlint.cinaq.com)

0 comments on commit 5d5cfc9

Please sign in to comment.