mojito-cli-doc - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

config.json

@@ -21,7 +21,4 @@ {
             "assets",
-            "index.js",
             "lang",
             "lib",
-            "server.js",
-            "start.js",
             "tests"
@@ -28,0 +25,0 @@ ],

docs.js

@@ -68,3 +68,3 @@ /*
         name = env.app.name || 'app';
-        log.info('No name specified, using "%s"', name);
+        log.info('No name specified, using:', name);
     }
@@ -147,3 +147,3 @@
 module.exports.usage = usage = [
-    'Usage: mojito doc <type> [name] [--directory] [--server] [--port]',
+    'Usage: mojito doc [options] <type> [name]',
     '  <type>  "mojito", "app" or "mojit", required',
@@ -163,5 +163,6 @@ '  [name]  name for docs, required for type "mojit"',
     'Options:',
-    '  --directory <path> Destination directory to save documentation in.',
-    '  --server           Launch YUIDoc server instead of writing to disk.',
-    '  --port <number>    Port number to start YUIDoc server on. Default is 3000.'
+    '  --directory <path>  Destination directory to save documentation in.',
+    '  --exclude <pattern> Exclude files or directories. Repeatable.',
+    '  --server            Launch YUIDoc server instead of writing to disk.',
+    '  --port <number>     Port number to start YUIDoc server on. Default is 3000.'
 ].join(EOL);
@@ -168,0 +169,0 @@

package.json

 {
   "name": "mojito-cli-doc",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Provide the `doc` command, to generate API docs, for `mojito-cli`",
@@ -20,6 +20,6 @@ "main": "docs.js",
   "scripts": {
-    "lint": "jshint {.,lib}/*.js",
+    "lint": "jshint {.,lib}/*.js*",
     "test": "tap tests/index.js",
     "cover": "istanbul cover --dir artifacts/coverage tests",
-    "clean": "git clean -dfx {.,tests}/artifacts"
+    "clean": "git clean -dfX **/artifacts"
   },
@@ -26,0 +26,0 @@ "repository": {

README.md

@@ -34,4 +34,2 @@ mojito-cli-doc
 
-By default, the generated files are saved in `./artifacts/docs/`, or if a `name` argument is provided, `./artifacts/docs/<name>`.
-
 Specify output directory (if `--port` or `--server` are not used):
@@ -42,2 +40,11 @@
 
+By default, the generated files are saved in `./artifacts/docs/`, or if a `name` argument is provided, `./artifacts/docs/<name>`.
+
+Exclude some files or directories from being processed:
+
+    --exclude <pattern>
+    -e <pattern>
+
+This option can be repeated, for example `mojito doc --exclude middleware --exclude build` will exclude files or directories with "middleware" or "build" in their names.
+
 Serve the API docs over HTTP, without rendering them to the file system (assumes `--port 3000`):
@@ -44,0 +51,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

125700

increased by0.19%

Number of lines in readme file

73

increased by10.61%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Lines of code

2765

decreased by-0.07%

No dependency changes