@robert.tools/setup 1.1.0 → 1.1.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 CHANGED
@@ -1,17 +1,42 @@
1
1
  # @robert.tools/setup
2
2
 
3
- A setup package for robert.tools.
3
+ A setup package for robert.tools providing several commands to ease package management and release.
4
4
 
5
5
  ## Installation
6
6
 
7
7
  ```bash
8
- npm install @robert.tools/setup
8
+ npm install --save-dev @robert.tools/setup
9
9
  ```
10
10
 
11
11
  ## Usage
12
+ To use the setup script you either can run on demand:
13
+ ```node
14
+ npx robi <command> <param>
15
+ ```
16
+
17
+ or put it to your npm tasks:
18
+ ```
19
+ "release": "robi release",
20
+ ```
12
21
 
13
- ```typescript
14
- import { setup } from '@robert.tools/setup';
22
+ ## commands
15
23
 
16
- setup('hello'); // 'setup: hello'
24
+ ### release
25
+ bumps the version in all files.
26
+
27
+ * without parameter `robi release` it will ask you for the type of version bump
28
+ * with parameter `robi release <semantic>` it will bump the version accordingly, e.g. for major:
29
+
30
+ ```
31
+ robi release major
32
+ ```
33
+
34
+ * semantic: `major` | `minor` | `patch`
35
+
36
+ ### init
37
+ This works same as release but also replaces several placeholders.
38
+
39
+
40
+ ```
41
+ robi init <semantic>
17
42
  ```
@@ -3,7 +3,7 @@
3
3
  * 🎯 A module to run setup tasks like release, init.
4
4
  * @module release
5
5
  * @example run();
6
- * @version 1.1.0
6
+ * @version 1.1.1
7
7
  * @date 2026-08-07
8
8
  * @license MIT
9
9
  * @author Robert Willemelis <github.com/willi84>
@@ -4,7 +4,7 @@
4
4
  * 🎯 A module to run setup tasks like release, init.
5
5
  * @module release
6
6
  * @example run();
7
- * @version 1.1.0
7
+ * @version 1.1.1
8
8
  * @date 2026-08-07
9
9
  * @license MIT
10
10
  * @author Robert Willemelis <github.com/willi84>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robert.tools/setup",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "A couple of tools to initialize and update a repo.",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",