@antelopejs/dms-frontend 0.1.8 → 0.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -7
- package/dist/commands/build.js +1 -1
- package/dist/commands/start.js +1 -1
- package/dist/index.js +1 -1
- package/dist/layers.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,9 @@ Frontend-agnostic loader for AntelopeJS DMS. The backend serves a frontend
|
|
|
10
10
|
manifest and the matching frontend-module archives; the `ajs dms` CLI
|
|
11
11
|
materializes them into a generated workspace for one renderer, builds it, and
|
|
12
12
|
runs its Node frontend server. The `vue` renderer — Vue 3, Vite, Inertia, and
|
|
13
|
-
SSR — is the one shipped today.
|
|
13
|
+
SSR — is the one shipped today. The package itself installs a single executable,
|
|
14
|
+
`ajs-dms`; `ajs dms` is the core CLI delegating to it, and is the name every
|
|
15
|
+
project, script and document uses.
|
|
14
16
|
|
|
15
17
|
## Renderers
|
|
16
18
|
|
|
@@ -55,15 +57,23 @@ not infer application ownership from other framework configuration.
|
|
|
55
57
|
|
|
56
58
|
## Install
|
|
57
59
|
|
|
58
|
-
The loader is an AntelopeJS CLI plugin: install it next to
|
|
59
|
-
and
|
|
60
|
+
The loader is an official AntelopeJS CLI plugin: install it next to
|
|
61
|
+
`@antelopejs/core` and run it as `ajs dms <command>`. That is the only supported
|
|
62
|
+
way to invoke it — in a shell, in a package script, in CI and in a container
|
|
63
|
+
alike.
|
|
60
64
|
|
|
61
65
|
```bash
|
|
66
|
+
# in a project (the usual case: both are already project dependencies)
|
|
67
|
+
pnpm add @antelopejs/core @antelopejs/dms-frontend
|
|
68
|
+
|
|
69
|
+
# or globally
|
|
62
70
|
pnpm add -g @antelopejs/core @antelopejs/dms-frontend
|
|
63
71
|
```
|
|
64
72
|
|
|
65
73
|
`npm install -g` works too; this repository and every generated workspace use
|
|
66
|
-
pnpm.
|
|
74
|
+
pnpm. Inside a package script, `ajs` resolves from `node_modules/.bin`, and the
|
|
75
|
+
`dms` command it delegates to resolves the project-local plugin, so a script
|
|
76
|
+
never depends on a global install.
|
|
67
77
|
|
|
68
78
|
## Commands
|
|
69
79
|
|
|
@@ -76,9 +86,6 @@ ajs dms clean -b https://dms.example.com
|
|
|
76
86
|
ajs dms clean --all
|
|
77
87
|
```
|
|
78
88
|
|
|
79
|
-
`ajs dms <command>` and `ajs-dms <command>` are the same program; the delegation
|
|
80
|
-
only saves you from remembering a second executable name. Package scripts should
|
|
81
|
-
call `ajs-dms` directly so they do not depend on the CLI being installed.
|
|
82
89
|
`--help`, `--version` and `clean` run from any directory. `prepare` also runs
|
|
83
90
|
anywhere: with no backend in reach it warns and exits 0, so a frontend module's
|
|
84
91
|
`postinstall` hook never fails an install, and the generated types are refreshed
|
package/dist/commands/build.js
CHANGED
|
@@ -51,7 +51,7 @@ function cmdBuild() {
|
|
|
51
51
|
if (code === 0) {
|
|
52
52
|
console.log("");
|
|
53
53
|
(0, cli_ui_1.success)("Build completed successfully!");
|
|
54
|
-
console.log(chalk_1.default.dim(" Run 'ajs
|
|
54
|
+
console.log(chalk_1.default.dim(" Run 'ajs dms start' to start the production server"));
|
|
55
55
|
}
|
|
56
56
|
else {
|
|
57
57
|
(0, cli_ui_1.error)("Build failed");
|
package/dist/commands/start.js
CHANGED
|
@@ -26,7 +26,7 @@ function cmdStart() {
|
|
|
26
26
|
if (!(0, node_fs_1.existsSync)(serverPath) || !(0, node_fs_1.existsSync)(clientPath)) {
|
|
27
27
|
console.log("");
|
|
28
28
|
(0, cli_ui_1.error)("Production build not found!");
|
|
29
|
-
console.log(chalk_1.default.dim(" Run 'ajs
|
|
29
|
+
console.log(chalk_1.default.dim(" Run 'ajs dms build -b " +
|
|
30
30
|
options.backendUrl +
|
|
31
31
|
"' first to create a production build"));
|
|
32
32
|
process.exit(1);
|
package/dist/index.js
CHANGED
|
@@ -25,7 +25,7 @@ const runCLI = async () => {
|
|
|
25
25
|
console.log(chalk_1.default.dim(` Frontend Loader for AntelopeJS DMS - v${version}\n`));
|
|
26
26
|
}
|
|
27
27
|
const program = new commander_1.Command()
|
|
28
|
-
.name("ajs
|
|
28
|
+
.name("ajs dms")
|
|
29
29
|
.description(`Antelope DMS - Frontend Loader v${version}\n\n` +
|
|
30
30
|
`Materializes frontend modules from an AntelopeJS backend and starts a Vue or React Vite and Inertia application.`)
|
|
31
31
|
.version(version, "-v, --version", "Display version number")
|
package/dist/layers.js
CHANGED
|
@@ -23,8 +23,8 @@ function assertLayerPathsServed(modules) {
|
|
|
23
23
|
return;
|
|
24
24
|
throw new Error("The backend served a manifest without layer source paths:\n" +
|
|
25
25
|
pathless.map((mod) => ` - ${mod.name}`).join("\n") +
|
|
26
|
-
"\n`ajs
|
|
27
|
-
"`ajs project dev`); use `ajs
|
|
26
|
+
"\n`ajs dms dev` needs a development backend running on this machine (started with " +
|
|
27
|
+
"`ajs project dev`); use `ajs dms build` against a remote or production one.\n" +
|
|
28
28
|
"If the backend is local and in development mode, it did not recognize the bootstrap " +
|
|
29
29
|
"credential — see DMS_BOOTSTRAP_SECRET.");
|
|
30
30
|
}
|