|
1 | | -# acumate README |
| 1 | +# AcuMate |
2 | 2 |
|
3 | | -This is the README for your extension "acumate". After writing up a brief description, we recommend including the following sections. |
| 3 | +AcuMate is Acumatica's open-source Visual Studio Code plugin for building Modern UI screens. |
4 | 4 |
|
5 | | -## Features |
| 5 | +## VS Code extension |
| 6 | +- Surfaces backend metadata directly in TypeScript hovers and IntelliSense, validating `@graphInfo`, `@featureInstalled`, and `@linkCommand` decorators against the connected site. |
| 7 | +- Adds Acumatica-aware HTML tooling (validation, go-to-definition, completions) for `view.bind`, `qp-*` controls, templates, and action bindings. |
| 8 | +- Provides project scaffolding: Create Screen / Screen Extension wizards, build menus, validation runners, and quick fixes for suppressing diagnostics when needed. |
| 9 | +- Streams logs and validation output through dedicated VS Code channels so long-running metadata requests and builds stay traceable. |
6 | 10 |
|
7 | | -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 11 | +## Getting Started |
8 | 12 |
|
9 | | -For example if there is an image subfolder under your extension project workspace: |
| 13 | +### Prerequisites |
| 14 | +- Node.js 18 LTS or newer (the extension CI runs on Node 18/20). |
| 15 | +- VS Code 1.54+ for local extension development. |
10 | 16 |
|
11 | | -\!\[feature X\]\(images/feature-x.png\) |
| 17 | +### Install / develop the VS Code extension |
| 18 | +1. `cd acumate-plugin` |
| 19 | +2. `npm install` |
| 20 | +3. `npm run compile` (or `npm run watch` while iterating) |
| 21 | +4. Launch VS Code with the `Run Extension` target or package the extension via `npm run vscode:prepublish` and install the generated `.vsix`. |
| 22 | +5. Run `npm test` to execute the integration suite, or `npm run validate:screens` / `npm run validate:screens:ts` to trigger the HTML and TypeScript validators headlessly. |
12 | 23 |
|
13 | | -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. |
| 24 | +## Repository Structure |
14 | 25 |
|
15 | | -## Requirements |
| 26 | +``` |
| 27 | +acumate-plugin/ # VS Code extension source, scripts, and tests |
| 28 | +acumate-linter/ # Standalone ESLint plugin shared by CI + editors |
| 29 | +VSCode/ # VS Code workspace settings used for local development |
| 30 | +CHANGELOG.md # Release notes for both packages |
| 31 | +vsc-extension-quickstart.md # Legacy notes for extension authors |
| 32 | +``` |
16 | 33 |
|
17 | | -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
| 34 | +Refer to [acumate-plugin/readme.md](acumate-plugin/readme.md) for the full extension features list, settings reference, and command catalog. |
18 | 35 |
|
19 | | -## Extension Settings |
| 36 | +## Development Workflow |
| 37 | +- Run `npm run lint` inside `acumate-plugin` before opening a PR; the CI workflow mirrors `npm ci && npm test`. |
| 38 | +- When editing shared logic (e.g., metadata helpers), update both documentation and tests—diagnostics surface in VS Code and via CLI. |
20 | 39 |
|
21 | | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
22 | | - |
23 | | -For example: |
24 | | - |
25 | | -This extension contributes the following settings: |
26 | | - |
27 | | -* `myExtension.enable`: Enable/disable this extension. |
28 | | -* `myExtension.thing`: Set to `blah` to do something. |
29 | | - |
30 | | -## Known Issues |
31 | | - |
32 | | -Calling out known issues can help limit users opening duplicate issues against your extension. |
33 | | - |
34 | | -## Release Notes |
35 | | - |
36 | | -Users appreciate release notes as you update your extension. |
37 | | - |
38 | | -### 1.0.0 |
39 | | - |
40 | | -Initial release of ... |
41 | | - |
42 | | -### 1.0.1 |
43 | | - |
44 | | -Fixed issue #. |
45 | | - |
46 | | -### 1.1.0 |
47 | | - |
48 | | -Added features X, Y, and Z. |
49 | | - |
50 | | ---- |
51 | | - |
52 | | -## Following extension guidelines |
53 | | - |
54 | | -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. |
55 | | - |
56 | | -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) |
57 | | - |
58 | | -## Working with Markdown |
59 | | - |
60 | | -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
61 | | - |
62 | | -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). |
63 | | -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). |
64 | | -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. |
65 | | - |
66 | | -## For more information |
67 | | - |
68 | | -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
69 | | -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
70 | | - |
71 | | -**Enjoy!** |
| 40 | +## Contributing |
| 41 | +- File bugs and feature requests through GitHub issues. |
| 42 | +- Add entries to [CHANGELOG.md](CHANGELOG.md) under **Unreleased** for every PR. |
0 commit comments