siteplane 0.2.0 → 0.2.1-rc.0
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 +18 -0
- package/dist/bin/siteplane.js +2334 -55
- package/dist/route.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -52,6 +52,24 @@ A website with `basePath` in `next.config` needs no extra setup. Check it with t
|
|
|
52
52
|
(`npx siteplane status --url https://www.example.com/docs`); Siteplane saves that address as the website URL and
|
|
53
53
|
reaches the website below it.
|
|
54
54
|
|
|
55
|
+
## Updates
|
|
56
|
+
|
|
57
|
+
The website overview shows the last observed package version and offers a copyable update prompt when a newer
|
|
58
|
+
version is available. `task` and `sync` also print an update notice to stderr; the task includes it below the title.
|
|
59
|
+
These notices never start an update. To update deliberately, run the prompt's exact command:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npx siteplane@<version> init --site <siteId>
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
`init` is idempotent: it skips installation for the same exact version, pins ranges, upgrades older versions and
|
|
66
|
+
refuses to downgrade a newer project before changing files. Then check, sync, deploy normally and confirm with
|
|
67
|
+
`status --url`. The overview updates after a matching status observation or a publish.
|
|
68
|
+
|
|
69
|
+
`check` warns about attrs on custom components, unread link labels and editable text inside fixed external/contact
|
|
70
|
+
links. `sync` also warns when Analytics is enabled but no root layout renders its component. Every warning includes
|
|
71
|
+
the remedy and leaves valid fields syncable.
|
|
72
|
+
|
|
55
73
|
## Analytics
|
|
56
74
|
|
|
57
75
|
With Analytics on for the site, `init` also adds `<SiteplaneAnalytics siteId="…" />` to the root layout. It counts
|