rmshii 1.0.0 → 1.0.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 (3) hide show
  1. package/LICENSE +13 -0
  2. package/README.md +67 -0
  3. package/package.json +10 -2
package/LICENSE ADDED
@@ -0,0 +1,13 @@
1
+ Copyright (c) 2026, GATLING
2
+
3
+ Permission to use, copy, modify, and/or distribute this software for any
4
+ purpose with or without fee is hereby granted, provided that the above
5
+ copyright notice and this permission notice appear in all copies.
6
+
7
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,67 @@
1
+ # rmshii
2
+
3
+ A lightning-fast CLI tool to strip out unwanted comments and emojis from AI-generated code.
4
+
5
+ Because nobody has the time to manually delete `// Here is your updated function! 🚀✨` 50 times a day.
6
+
7
+ ## Installation
8
+
9
+ You don't even need to install it to use it! The easiest way is to run it on-the-fly using `npx`:
10
+
11
+ ```bash
12
+ npx rmshii [options] [target]
13
+ ```
14
+
15
+ Or, if you find yourself using it constantly, install it globally:
16
+
17
+ ```bash
18
+ npm install -g rmshii
19
+ ```
20
+
21
+ (If installed globally, you can just type `rmshii` instead of `npx rmshii`)
22
+
23
+ ## Usage
24
+
25
+ By default, rmshii targets the current directory if no path is provided. It recursively scans folders and safely ignores node_modules and hidden directories (like .git).
26
+
27
+ ### Options
28
+
29
+ - `-c, --comments` : Remove code comments (single and multi-line)
30
+ - `-e, --emoji` : Remove all emojis
31
+ - `-a, --all` : Remove both comments and emojis
32
+ - `-V, --version` : Output the current version
33
+ - `-h, --help` : Display help for command
34
+
35
+ ### Examples
36
+
37
+ Clean all comments in the current directory:
38
+
39
+ ```bash
40
+ npx rmshii -c
41
+ ```
42
+
43
+ Clean only emojis in a specific folder (src/):
44
+
45
+ ```bash
46
+ npx rmshii -e src/
47
+ ```
48
+
49
+ Nuke both comments and emojis in a single file:
50
+
51
+ ```bash
52
+ npx rmshii -a app.js
53
+ ```
54
+
55
+ ## Supported File Types
56
+
57
+ rmshii currently supports cleaning the following file extensions:
58
+
59
+ - .js, .jsx
60
+ - .ts, .tsx
61
+ - .py
62
+ - .html
63
+ - .css
64
+
65
+ ## License
66
+
67
+ ISC
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "rmshii",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Remove comments and emojis from your code.",
5
5
  "main": "index.js",
6
6
  "bin": {
7
- "rmshii": "index.js"
7
+ "rmshii": "./index.js"
8
8
  },
9
9
  "scripts": {
10
10
  "test": "echo \"Error: no test specified\" && exit 1"
@@ -17,6 +17,14 @@
17
17
  ],
18
18
  "author": "Gatling",
19
19
  "license": "ISC",
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/iamgatling/rmshii.git"
23
+ },
24
+ "bugs": {
25
+ "url": "https://github.com/iamgatling/rmshii/issues"
26
+ },
27
+ "homepage": "https://github.com/iamgatling/rmshii#readme",
20
28
  "dependencies": {
21
29
  "commander": "^14.0.3",
22
30
  "emoji-regex": "^10.6.0",