@spfx-fast/spfx-workbench 0.1.0 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +13 -5
  2. package/package.json +22 -1
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # SPFx Workbench
2
2
 
3
+ An SPFx developer and agent workflow toolkit for local component preview, diagnostics, SharePoint API capture/replay, authentication-state reuse, and Heft debugging. It helps build and validate SPFx projects; it is not a security or credential scanner.
4
+
3
5
  A local SharePoint Workbench-style page editor with a canvas, toolbox, and property pane. It supports SharePoint column layouts, responsive breakpoints, section emphasis, local section width presets, and a synthetic document-library web part. The consumer CLI can load a compatible React component or invoke a subset of SPFx web-part lifecycle hooks with explicit JSON properties and a narrow synthetic context. It does not create the SharePoint service scope or claim to reproduce the full SPFx host.
4
6
 
5
7
  ## Run locally
@@ -11,7 +13,11 @@ npm install
11
13
  npm run dev
12
14
  ```
13
15
 
14
- Vite serves the preview on `http://127.0.0.1:4173`. `npm run build` builds the static prototype; `npm run preview` serves that build on port 4174.
16
+ Vite serves the preview on `http://127.0.0.1:4173`. `npm run build` builds the static prototype; `npm run preview` serves that build on port 4174. This package is a developer workflow tool, not a vulnerability, malware, or credential scanner.
17
+
18
+ ## Find the agent skill
19
+
20
+ The portable `spfx-ide` skill ships in [`packages/ide/skills/spfx-ide/SKILL.md`](packages/ide/skills/spfx-ide/SKILL.md). Try discovery with `npx --yes skills add https://github.com/vystartasv/spfx-workbench --list`; package keywords, README content, GitHub description, and topics also help people find the project. npm search indexing may take up to two weeks. skills.sh uses anonymous aggregate install counts for its leaderboard; installs do not guarantee a particular rank.
15
21
 
16
22
  ## Current behavior
17
23
 
@@ -25,14 +31,16 @@ Vite serves the preview on `http://127.0.0.1:4173`. `npm run build` builds the s
25
31
 
26
32
  ## Preview a consumer component
27
33
 
28
- The npm package name is `@spfx-fast/spfx-workbench`. Its manifest is configured for public version `0.1.0`; publish that release before using the registry install command. To use this checkout in an SPFx project, install its local path and run the CLI from that project's root:
34
+ The npm package name is `@spfx-fast/spfx-workbench`. Version `0.1.1` is published; this checkout prepares public version `0.1.2`. Install the published package in an SPFx project and run the CLI from that project's root:
29
35
 
30
36
  ```sh
31
- npm install --save-dev /path/to/spfx-workbench
37
+ npm install --save-dev @spfx-fast/spfx-workbench
32
38
  npx spfx-workbench --component src/components/HelloWorld.tsx
33
39
  ```
34
40
 
35
- After an authorized release, the registry install command will be:
41
+ For contributors testing an unpublished checkout, install the repository path instead.
42
+
43
+ The registry install command is:
36
44
 
37
45
  ```sh
38
46
  npm install --save-dev @spfx-fast/spfx-workbench
@@ -66,7 +74,7 @@ This is an early consumer-loader slice. It supports explicit JSON props and the
66
74
 
67
75
  ## How this fits with the SPFx Fast tools
68
76
 
69
- Use [`@spfx-fast/ide`](packages/ide/README.md) as the thin developer and agent entry point. `spfx-ide` routes to focused tools; installing it as a project devDependency or globally automatically installs shared Agent Skills guidance for supported coding agents (unless package-manager lifecycle scripts are disabled). The guide routes to maintained SPFx knowledge and workflows. Use Workbench as the local development loop: it owns component preview, the synthetic context and API replay, diagnostics, capture, and Heft launch. The focused companion packages have separate jobs:
77
+ Use [`@spfx-fast/ide`](packages/ide/README.md) as the thin developer and agent entry point. The registry has Workbench 0.1.1 and IDE 0.1.0. IDE 0.1.1 failed publication at npm; the prepared 0.1.2 adds Workbench as a dependency and automatic skill placement. Fix the IDE npm Trusted Publisher before publishing Workbench 0.1.2 and then IDE 0.1.2. Until the IDE release succeeds, registry installs do not include Workbench routes or the skill hook. The candidate's `spfx-ide` routes to focused tools; installing it as a project devDependency or globally places Agent Skills guidance in supported skill directories unless lifecycle scripts are disabled. This confirms file placement, not discovery by every agent; check the agent's own skills list where available. Global CLI use also needs npm's global bin directory on `PATH`. Workbench owns component preview, synthetic context/API replay, diagnostics, capture, and Heft launch. The focused companion packages have separate jobs:
70
78
 
71
79
  - [`@spfx-fast/playwright`](https://www.npmjs.com/package/%40spfx-fast/playwright) runs authenticated browser tests against a real SharePoint page.
72
80
  - [`@spfx-fast/knowledge`](https://www.npmjs.com/package/%40spfx-fast/knowledge) provides the SPFx agent skill and debugging references; use it to guide the tools, not as a runtime dependency.
package/package.json CHANGED
@@ -1,9 +1,30 @@
1
1
  {
2
2
  "name": "@spfx-fast/spfx-workbench",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
+ "description": "Local SPFx component preview, diagnostics, SharePoint API capture and replay, and Heft debugging tools.",
4
5
  "publishConfig": {
5
6
  "access": "public"
6
7
  },
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/vystartasv/spfx-workbench.git"
11
+ },
12
+ "homepage": "https://github.com/vystartasv/spfx-workbench#readme",
13
+ "bugs": {
14
+ "url": "https://github.com/vystartasv/spfx-workbench/issues"
15
+ },
16
+ "keywords": [
17
+ "spfx",
18
+ "sharepoint",
19
+ "sharepoint-framework",
20
+ "workbench",
21
+ "vite",
22
+ "playwright",
23
+ "heft",
24
+ "webpart",
25
+ "developer-tools",
26
+ "agent-skills"
27
+ ],
7
28
  "type": "module",
8
29
  "bin": {
9
30
  "spfx-workbench": "bin/spfx-workbench.mjs",