lua-doc-extractor - npm Package Compare versions

Comparing version 3.3.1 to 3.3.2

dist/package.json

 {
     "name": "lua-doc-extractor",
-    "version": "3.3.1",
+    "version": "3.3.2",
     "description": "Extracts lua documentation from C-style comments",
@@ -5,0 +5,0 @@ "main": "dist/src/index.js",

dist/src/cli.js

@@ -32,4 +32,4 @@ #!/usr/bin/env node
 
-      lua-doc-extractor "**/*.cpp"
-      lua-doc-extractor --src "lib/**/*.\\{c,h\\}"
+      {yellow lua-doc-extractor "**/*.cpp"}
+      {yellow lua-doc-extractor --src "lib/**/*.\\{c,h\\}"}
 
@@ -57,3 +57,3 @@ `,
         description: (0, dedent_js_1.default) `
-      {white (Optional)} The root URL of a repository.
+      The root URL of a repository.
 
@@ -64,3 +64,3 @@ If provided, links will be added to each generated doc comment with a link to the original source.
 
-      {white "https://github.com/<user>/<repository>/blob/<commit>/"}
+      {yellow "https://github.com/<user>/<repository>/blob/<commit>/"}
 
@@ -80,2 +80,8 @@ `,
     },
+    {
+        name: "version",
+        alias: "v",
+        type: Boolean,
+        description: "Print the version number.\n",
+    },
 ];
@@ -86,7 +92,8 @@ const options = (0, command_line_args_1.default)(optionList);
     {bold.white Note:} Always run this command from the root of your project ensure correct paths in output headers and repo links.
+
   `;
     const examples = [
-        "$ lua-doc-extractor file_a.cpp file_b.cpp",
-        '$ lua-doc-extractor ---src "src/**/*.\\{cpp,h\\}" --dest output/lib.lua',
-        "$ lua-doc-extractor *.cpp --repo https://github.com/user/proj/blob/12345c/",
+        "lua-doc-extractor file_a.cpp file_b.cpp",
+        'lua-doc-extractor ---src "src/**/*.\\{cpp,h\\}" --dest output/lib.lua',
+        "lua-doc-extractor *.cpp --repo https://github.com/user/proj/blob/12345c/",
     ];
@@ -100,3 +107,3 @@ console.log((0, command_line_usage_1.default)([
             header: "{white Usage}",
-            content: [usageNote, ...examples].join("\n\n"),
+            content: [usageNote, ...examples.map((e) => chalk_1.default.yellow(e))].join("\n"),
         },
@@ -112,3 +119,7 @@ { header: "{white Options}", optionList },
 async function runAsync() {
-    const { src, dest, help, repo, file, error: enableErrorCode } = options;
+    const { src, dest, help, version, repo, file, error: enableErrorCode, } = options;
+    if (version) {
+        console.log(package_json_1.default.version);
+        process.exit(0);
+    }
     if (help) {
@@ -115,0 +126,0 @@ printUsage();

package.json

 {
   "name": "lua-doc-extractor",
-  "version": "3.3.1",
+  "version": "3.3.2",
   "description": "Extracts lua documentation from C-style comments",
@@ -5,0 +5,0 @@ "main": "dist/src/index.js",

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

70594

0.39%

Lines of code

1598

0.63%

No dependency changes