@m0x373/pimpt 0.1.0 → 0.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.
Files changed (2) hide show
  1. package/README.md +92 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,92 @@
1
+ # pimpt
2
+
3
+ An interactive setup assistant for Windows Terminal. Choose settings and PowerShell features from a guided menu, review the summary, and confirm before changes are applied.
4
+
5
+ ## Requirements
6
+
7
+ - Windows 10 or later
8
+ - Windows Terminal
9
+ - Node.js 22 or later
10
+ - PowerShell for PowerShell profile features
11
+
12
+ Some optional features install modules from the PowerShell Gallery or download a font, so an internet connection may be required.
13
+
14
+ ## Install
15
+
16
+ ```powershell
17
+ npm install --global @m0x373/pimpt
18
+ ```
19
+
20
+ Then start the installer:
21
+
22
+ ```powershell
23
+ pimpt
24
+ ```
25
+
26
+ The npm package is scoped because npm does not allow this project to publish under the unscoped name `pimpt`.
27
+
28
+ ## Usage
29
+
30
+ ```text
31
+ pimpt
32
+ pimpt --help
33
+ pimpt --version
34
+ ```
35
+
36
+ The installer detects the Windows Terminal settings file for the Stable, Preview, or Canary release. Select an area, choose settings, review the summary, and confirm to apply the changes.
37
+
38
+ ## Available options
39
+
40
+ ### Appearance and terminal settings
41
+
42
+ - Set window opacity and acrylic effects.
43
+ - Set a background color.
44
+ - Choose a terminal font.
45
+ - Hide the Windows PowerShell startup banner.
46
+ - Enable PowerShell file icons with the Terminal-Icons module and Hack Nerd Font Mono.
47
+
48
+ ### PowerShell features
49
+
50
+ - Set a default starting directory. Relative paths such as `Downloads` resolve from your user folder.
51
+ - Enable a scrollable command history preview with PSReadLine.
52
+ - Enable a colored tree view for `ls`.
53
+
54
+ When tree-style `ls` is enabled, the original `Get-ChildItem` command remains available as `gci`.
55
+
56
+ The tree view defaults to a maximum depth of 4 and 50 displayed entries:
57
+
58
+ ```powershell
59
+ ls
60
+ ls .\src -Depth 2
61
+ ls .\src -Limit 200
62
+ ls .\src -All
63
+ ls .\src -Force
64
+ ```
65
+
66
+ `-All` disables the entry limit and may produce a large amount of output.
67
+
68
+ ## Settings safety
69
+
70
+ - Windows Terminal settings are edited as JSONC, preserving comments and formatting where possible.
71
+ - A backup is created before `settings.json` is changed.
72
+ - The installer asks for confirmation before applying the selected configuration.
73
+ - Existing backups can be restored from the `Other` area.
74
+ - PowerShell features are added to the current user's PowerShell profile in marked blocks.
75
+
76
+ ## Development
77
+
78
+ ```powershell
79
+ npm install
80
+ npm test
81
+ npm run typecheck
82
+ npm run build
83
+ ```
84
+
85
+ ## License
86
+
87
+ ISC, as declared in the package metadata.
88
+
89
+ ## Links
90
+
91
+ - [Source repository](https://github.com/M0x37/pimpt)
92
+ - [npm package](https://www.npmjs.com/package/@m0x373/pimpt)
package/package.json CHANGED
@@ -1,13 +1,14 @@
1
1
  {
2
2
  "name": "@m0x373/pimpt",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Interactive setup assistant for Windows Terminal",
5
5
  "type": "module",
6
6
  "bin": {
7
7
  "pimpt": "dist/index.js"
8
8
  },
9
9
  "files": [
10
- "dist"
10
+ "dist",
11
+ "README.md"
11
12
  ],
12
13
  "scripts": {
13
14
  "build": "tsup src/index.ts --format esm --clean --sourcemap",