@mschauer5/spfx-toolkit 1.0.1 → 1.0.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.
- package/README.md +59 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# SPFx Toolkit
|
|
2
|
+
|
|
3
|
+
A CLI toolkit to help with SharePoint Framework (SPFx) project development, supporting both classic (gulp) and modern (Heft) build systems.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Add and clear shell aliases for the toolkit
|
|
8
|
+
- Build and bundle SPFx projects (auto-detects Gulp or Heft)
|
|
9
|
+
- Serve/start the SPFx dev server
|
|
10
|
+
- Backup and restore ESLint config
|
|
11
|
+
- Version management for SPFx projects
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
npm install -g @mschauer5/spfx-toolkit
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
After installation, run:
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
spfx-toolkit --help
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Common Commands
|
|
28
|
+
|
|
29
|
+
- `spfx-toolkit build` — Build the project (auto-detects Gulp or Heft)
|
|
30
|
+
- `spfx-toolkit bundle` — Bundle the project (auto-detects Gulp or Heft)
|
|
31
|
+
- `spfx-toolkit serve` — Start the SPFx dev server
|
|
32
|
+
- `spfx-toolkit add-alias <name>` — Add a shell alias for the toolkit
|
|
33
|
+
- `spfx-toolkit clear-alias` — Remove the shell alias for the toolkit
|
|
34
|
+
- `spfx-toolkit eslint --backup|--restore` — Backup or restore ESLint config
|
|
35
|
+
- `spfx-toolkit version --list|--sync|--increment <part>` — Version management
|
|
36
|
+
|
|
37
|
+
## Example
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
spfx-toolkit build
|
|
41
|
+
spfx-toolkit bundle
|
|
42
|
+
spfx-toolkit serve
|
|
43
|
+
spfx-toolkit add-alias st
|
|
44
|
+
spfx-toolkit clear-alias
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Requirements
|
|
48
|
+
|
|
49
|
+
- Node.js 18+
|
|
50
|
+
- For SPFx 1.22+ projects, Heft must be installed in your project
|
|
51
|
+
- For older SPFx projects, Gulp must be installed
|
|
52
|
+
|
|
53
|
+
## License
|
|
54
|
+
|
|
55
|
+
MIT
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
Developed by Matt Schauer
|