@p8ec/shared 2.5.0 → 2.5.1
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 +12 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,6 +7,7 @@ Shared TypeScript/JavaScript libraries for P(8) products.
|
|
|
7
7
|
Shared (**and very opinionated**) configuration for P(8) projects.
|
|
8
8
|
|
|
9
9
|
**Contents:**
|
|
10
|
+
|
|
10
11
|
- ESLint configuration
|
|
11
12
|
- Prettier configuration
|
|
12
13
|
- Commitlint configuration
|
|
@@ -62,9 +63,16 @@ p8-cli [command] [options]
|
|
|
62
63
|
|
|
63
64
|
### Commands
|
|
64
65
|
|
|
65
|
-
- `init` - Initialize P(8) shared configuration in your project. Options: `cleanup` - remove configuration entries from
|
|
66
|
-
|
|
66
|
+
- `init` - Initialize P(8) shared configuration in your project. Options: `cleanup` - remove configuration entries from
|
|
67
|
+
`package.json`
|
|
68
|
+
- Example: `p8-cli init --cleanup` - initializes the shared configuration and removes corresponding entries from
|
|
69
|
+
`package.json`.
|
|
67
70
|
- `dirn` - Get the directory name. Options: `0` - current directory (default), `1` - parent directory, `2` - 2 levels up
|
|
68
71
|
directory, etc.
|
|
69
|
-
|
|
70
|
-
|
|
72
|
+
- Example: `p8-cli dirn 1` - shows the parent directory name.
|
|
73
|
+
- `run` - Returns a script string using the detected or specified package manager. Options: `script` - script name,
|
|
74
|
+
`packageManager` - npm, yarn, or pnpm (auto-detected by default), `workspaceMode` - mode of concurrency for workspaces
|
|
75
|
+
(if applicable): `seq` (default) or `par`.
|
|
76
|
+
- Example: `p8-cli run build` - runs the `build` script using the detected package manager.
|
|
77
|
+
- Example: `p8-cli run test pnpm par` - runs the `test` script using
|
|
78
|
+
`pnpm` in parallel mode for workspaces.
|