x3d-tidy 2.0.9 → 2.0.10

package/README.md

@@ -10,23 +10,23 @@ X3D converter, beautifier and minimizer
 
 You can run *x3d-tidy* without installing it using **npx**:
 
-**npx x3d-tidy** \[options\] input-file output-file [input-file output-file ...]
+**npx x3d-tidy** \[options\] -i input-file -o output-file [-i input-file -o output-file ...]
 
 ## Options
 
 **x3d-tidy** interprets the following options when it is invoked:
 
-### -i *file* ...
+### -i *file(s)* ...
 
 Set input file(s). This can be either a local file path or a URL. If there are less input files than output files, the last input file is used for the remaining output files.
 
-### -o *file* ...
+### -o *file(s)* ...
 
-Set output file(s).
+Set output file(s). To output it to stdout use only the extension, e.g. ".x3dv".
 
 ### -s *[**TIDY**, COMPACT, SMALL, CLEAN]*
 
-Set output style, default is "TIDY".
+Set output style, default is "TIDY". "TIDY" results in a good readable file, but with larger size, whereas "CLEAN" result in the smallest size possible. The other values are somewhere in between.
 
 ### -d *integer*
 
@@ -80,7 +80,7 @@ Show help.
 Convert an XML encoded file into a VRML encoded file.
 
 ```sh
-$ npx x3d-tidy file.x3d file.x3dv
+$ npx x3d-tidy -i file.x3d -o file.x3dv
 ```
 
 Convert an XML encoded file into a VRML encoded file and a JSON encoded file.

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "x3d-tidy",
-   "version": "2.0.9",
+   "version": "2.0.10",
    "description": "X3D Converter, Beautifier and Minimizer",
    "main": "src/main.js",
    "bin": {
@@ -53,10 +53,9 @@
       }
    ],
    "dependencies": {
-      "colors": "^1.4.0",
-      "x_ite": "^11.0.0",
-      "x_ite-node": "^1.0.18",
-      "x3d-traverse": "^1.0.6",
+      "x_ite": "^11.0.1",
+      "x_ite-node": "^1.0.20",
+      "x3d-traverse": "^1.0.7",
       "yargs": "^17.7.2"
    },
    "devDependencies": {

package/src/infer.js

@@ -19,15 +19,14 @@ function getUsedComponents (scene)
 {
    const components = new Set ();
 
-   for (const node of scene .traverse (Traverse .PROTO_DECLARATIONS | Traverse .PROTO_DECLARATION_BODY | Traverse .ROOT_NODES | Traverse .PROTOTYPE_INSTANCES))
+   for (const object of scene .traverse (Traverse .PROTO_DECLARATIONS | Traverse .PROTO_DECLARATION_BODY | Traverse .ROOT_NODES | Traverse .PROTOTYPE_INSTANCES))
    {
-      if (!(node instanceof X3D .SFNode))
+      if (!(object instanceof X3D .SFNode))
          continue;
 
-      if (node .getValue () .getScene () !== scene)
-         continue;
+      const node = object .getValue ();
 
-      components .add (node .getValue () .getComponentInfo () .name);
+      components .add (node .getComponentInfo () .name);
    }
 
    return components;

package/src/main.js

@@ -35,6 +35,7 @@ async function convert ()
    const args = yargs (hideBin (process .argv))
    .scriptName ("x3d-tidy")
    .usage ("$0 [options] input-file output-file [input-file output-file ...]")
+   .wrap (yargs .terminalWidth ())
    .command ("X3D converter, beautifier and minimizer")
    .version (pkg .version)
    .alias ("v", "version")
@@ -49,84 +50,91 @@ async function convert ()
       alias: "i",
       description: "Set input file(s). If there are less input files than output files, the last input file is used for the remaining output files.",
       array: true,
+      default: [ ],
       implies: "output",
    })
    .option ("output",
    {
       type: "string",
       alias: "o",
-      description: "Set output file(s). To output it to stdout use only the extension, e.g. '.x3dv'.",
+      description: `Set output file(s). To output it to stdout use only the extension, e.g. ".x3dv".`,
       array: true,
+      default: [ ],
       implies: "input",
    })
    .option ("style",
    {
       type: "string",
       alias: "s",
-      description: "Set output style, default is 'TIDY'.",
-      choices: ["CLEAN", "SMALL", "COMPACT", "TIDY"],
+      description: `Set output style, default is "TIDY". "TIDY" results in a good readable file, but with larger size, whereas "CLEAN" result in the smallest size possible. The other values are somewhere in between.`,
+      choices: ["TIDY", "COMPACT", "SMALL", "CLEAN"],
+      array: true,
+      default: ["TIDY"],
    })
    .option ("double",
    {
       type: "number",
       alias: "d",
       description: "Set double precision, default is 15.",
+      array: true,
+      default: [15],
    })
    .option ("float",
    {
       type: "number",
       alias: "f",
       description: "Set float precision, default is 7.",
+      array: true,
+      default: [7],
    })
    .option ("infer",
    {
       type: "boolean",
       alias: "r",
       description: "If set, infer profile and components from used nodes.",
+      array: true,
+      default: [false],
    })
    .option ("metadata",
    {
       type: "boolean",
       alias: "m",
       description: "If set, remove metadata nodes.",
+      array: true,
+      default: [false],
    })
+   .example ([
+      [
+         "npx x3d-tidy -i file.x3d -o file.x3dv",
+         "Convert an XML encoded file into a VRML encoded file."
+      ],
+      [
+         "npx x3d-tidy -i file.x3d -o file.x3dv file.x3dj",
+         "Convert an XML encoded file into a VRML encoded file and a JSON encoded file."
+      ],
+   ])
    .help ()
    .alias ("help", "h") .argv;
 
-   args .input  ??= [ ];
-   args .output ??= [ ];
-
-   if (args .input .length === 0 && args .output .length === 0)
-   {
-      if (args ._ .length % 2 === 0)
-      {
-         for (let i = 0; i < args ._ .length; i += 2)
-         {
-            args .input  .push (args ._ [i + 0]);
-            args .output .push (args ._ [i + 1]);
-         }
-      }
-   }
-
    // Fixes an issue with URL, if it matches a drive letter.
    args .input = args .input .map (input => input .replace (/^([A-Za-z]:)/, "file://$1"));
 
    const
-      Browser = X3D .createBrowser () .browser,
+      browser = X3D .createBrowser () .browser,
       scenes  = new Map ();
 
-   Browser .endUpdate ();
-   Browser .setBrowserOption ("LoadUrlObjects",   false);
-   Browser .setBrowserOption ("PrimitiveQuality", "HIGH");
-   Browser .setBrowserOption ("TextureQuality",   "HIGH");
+   browser .endUpdate ();
+   browser .setBrowserOption ("LoadUrlObjects",   false);
+   browser .setBrowserOption ("PrimitiveQuality", "HIGH");
+   browser .setBrowserOption ("TextureQuality",   "HIGH");
 
-   await Browser .loadComponents (Browser .getProfile ("Full"));
+   await browser .loadComponents (browser .getProfile ("Full"));
 
    for (const i of args .output .keys ())
    {
       const
-         input     = new URL (args .input [i] ?? args .input .at (-1), url .pathToFileURL (path .join (process .cwd (), "/"))),
-         scene     = scenes .get (input .href) ?? await Browser .createX3DFromURL (new X3D .MFString (input)),
+         input     = new URL (arg (args .input, i), url .pathToFileURL (path .join (process .cwd (), "/"))),
+         scene     = scenes .get (input .href) ?? await browser .createX3DFromURL (new X3D .MFString (input)),
          generator = scene .getMetaData ("generator") ?.filter (value => !value .startsWith (pkg .name)) ?? [ ];
 
       scenes .set (input .href, scene);
@@ -135,37 +143,35 @@ async function convert ()
       scene .setMetaData ("generator", generator);
       scene .setMetaData ("modified", new Date () .toUTCString ());
 
-      if (args .infer)
+      if (arg (args .infer, i))
          infer (scene);
 
-      if (args .metadata)
+      if (arg (args .metadata, i))
          metadata (scene);
 
       const options =
       {
          scene: scene,
-         style: args .style,
-         precision: args .float,
-         doublePrecision: args .double,
+         style: arg (args .style, i),
+         precision: arg (args .float, i),
+         doublePrecision: arg (args .double, i),
       };
 
-      if (args .output [i])
-      {
-         const output = path .resolve (process .cwd (), args .output [i]);
+      const output = path .resolve (process .cwd (), args .output [i]);
 
-         if (path .extname (output))
-            fs .writeFileSync (output, getContents ({ ... options, type: path .extname (output) }));
-         else
-            console .log (getContents ({ ... options, type: path .basename (output) }));
-      }
+      if (path .extname (output))
+         fs .writeFileSync (output, getContents ({ ... options, type: path .extname (output) }));
       else
-      {
-         console .log (getContents ({ ... options, type: path .extname (input) }));
-      }
+         console .log (getContents ({ ... options, type: path .basename (output) }));
    }
 
    scenes .forEach (scene => scene .dispose ());
-   Browser .dispose ();
+   browser .dispose ();
+}
+
+function arg (arg, i)
+{
+   return arg [i] ?? arg .at (-1);
 }
 
 function getContents ({ scene, type, style, precision, doublePrecision })