commentme 1.0.0 → 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 +19 -17
- package/package.json +21 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# commentme
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
An Open Source CLI tool connected with its own website to manage and store your cluttered-code comments and give the codebase a clean look. Extract comments from your code files, store them in a database, visit commentme platform for UI-friendly seek and restore your comments line-wise later.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -8,33 +8,34 @@ npm install -g commentme
|
|
|
8
8
|
|
|
9
9
|
## Usage
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
### Show help
|
|
12
12
|
commentme --help
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
commentme --login
|
|
14
|
+
### Signup
|
|
16
15
|
commentme --signup
|
|
17
16
|
|
|
18
|
-
|
|
19
|
-
commentme --
|
|
17
|
+
### Login
|
|
18
|
+
commentme --login
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
commentme --get
|
|
20
|
+
### Get all comments
|
|
21
|
+
commentme --get lines "file-name"
|
|
23
22
|
|
|
23
|
+
### Get a specific comment
|
|
24
|
+
commentme --get line-7-7 "file-name"
|
|
24
25
|
|
|
25
|
-
|
|
26
|
-
commentme --edit line-7-7
|
|
26
|
+
### Edit a comment
|
|
27
|
+
commentme --edit line-7-7 "file-name"
|
|
27
28
|
|
|
28
|
-
|
|
29
|
-
commentme --delete line-7-7
|
|
29
|
+
### Delete a comment
|
|
30
|
+
commentme --delete line-7-7 "file-name"
|
|
30
31
|
|
|
31
|
-
|
|
32
|
-
commentme --skim
|
|
32
|
+
### Redact comments from a file
|
|
33
|
+
commentme --skim "file-name"
|
|
33
34
|
|
|
34
|
-
|
|
35
|
-
commentme --unskim
|
|
35
|
+
### Restore comments to a file
|
|
36
|
+
commentme --unskim "file-name"
|
|
36
37
|
|
|
37
|
-
|
|
38
|
+
### Logout
|
|
38
39
|
commentme --logout
|
|
39
40
|
|
|
40
41
|
## Features
|
|
@@ -53,3 +54,4 @@ commentme --logout
|
|
|
53
54
|
## License
|
|
54
55
|
|
|
55
56
|
MIT
|
|
57
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "commentme",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "A CLI tool to manage, redact and unredact your comments keeping the codebase clutterfree.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -19,6 +19,26 @@
|
|
|
19
19
|
},
|
|
20
20
|
"author": "dotlasher",
|
|
21
21
|
"license": "MIT",
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "git+https://github.com/Vidhanvyrs/commentme.git"
|
|
25
|
+
},
|
|
26
|
+
"bugs": {
|
|
27
|
+
"url": "https://github.com/Vidhanvyrs/commentme/issues"
|
|
28
|
+
},
|
|
29
|
+
"homepage": "https://github.com/Vidhanvyrs/commentme#readme",
|
|
30
|
+
"keywords": [
|
|
31
|
+
"cli",
|
|
32
|
+
"comments",
|
|
33
|
+
"refactor",
|
|
34
|
+
"cleanup",
|
|
35
|
+
"productivity",
|
|
36
|
+
"developer-tools",
|
|
37
|
+
"redaction",
|
|
38
|
+
"code-quality",
|
|
39
|
+
"linting",
|
|
40
|
+
"code-management"
|
|
41
|
+
],
|
|
22
42
|
"dependencies": {
|
|
23
43
|
"acorn": "^8.15.0",
|
|
24
44
|
"bcryptjs": "^3.0.3",
|