@spyglassmc/mcdoc-cli 0.1.2 → 0.1.4

package/lib/index.d.mts

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S tsx
+export {};
+//# sourceMappingURL=index.d.mts.map

package/lib/{index.js → index.mjs}

@@ -1,4 +1,4 @@
-#!/usr/bin/env -S ts-node --esm
+#!/usr/bin/env -S tsx
 import { dirname, join, parse, resolve } from 'path';
 import { fileURLToPath, pathToFileURL } from 'url';
 import fs from 'fs-extra';
@@ -13,25 +13,30 @@ import * as mcdoc from '@spyglassmc/mcdoc';
 const parentPath = dirname(fileURLToPath(import.meta.url));
 const cacheRoot = join(parentPath, 'cache');
 const CLI = yargs(hideBin(process.argv));
+function removeWindowsCruft(str) {
+    if (str.includes('\r'))
+        return str.replaceAll('\r', '');
+    return str;
+}
 await CLI.scriptName('mcdoc')
     .command('generate [source]', 'Generate JSON files', () => CLI.positional('source', {
-    describe: 'path to directory containing mcdoc source',
+    describe: 'path to directory containing mcdoc source.',
     type: 'string',
     default: '.',
 }).options({
     'locale': {
         alias: 'l',
-        description: 'en-us language key-value store of all doc comments',
+        description: 'en-us language key-value store of all doc comments.',
         default: false,
     },
     'module': {
         alias: 'm',
-        description: 'file tree mirroring definitions; to optimize for web',
+        description: 'file tree mirroring definitions; to optimize for web.',
         default: false,
     },
     'pretty': {
         alias: 'p',
-        description: 'pretty printed variants',
+        description: 'pretty printed variants.',
         default: false,
     },
     'verbose': {
@@ -40,7 +45,7 @@ await CLI.scriptName('mcdoc')
     },
     'dry': {
         alias: 'd',
-        description: 'will not write to disk',
+        description: 'will not write to disk.',
         default: false,
     },
 }).boolean('locale').boolean('module').boolean('pretty').boolean('verbose').boolean('dry'), async (args) => {
@@ -75,11 +80,14 @@ await CLI.scriptName('mcdoc')
     });
     await service.project.ready();
     await service.project.cacheService.save();
-    const out = 'out';
+    const generated = join('out', 'generated');
     if (args.dry !== true) {
-        await fs.ensureDir(out);
+        await fs.ensureDir(generated);
         if (args.module) {
-            await fs.ensureDir(join(out, 'module'));
+            await fs.ensureDir(join(generated, 'module'));
+        }
+        if (args.locale) {
+            await fs.ensureDir(join('out', 'locale'));
         }
     }
     const symbols = [];
@@ -101,7 +109,7 @@ await CLI.scriptName('mcdoc')
                     const children = node.children;
                     function flattenChild(parent, self, _parent, _child) {
                         const child = {};
-                        let known_error = false;
+                        const known_error = false;
                         /* @ts-ignore */
                         child.self = self;
                         /* @ts-ignore */
@@ -118,6 +126,12 @@ await CLI.scriptName('mcdoc')
                             }
                         }
                         child.type = _child.type;
+                        if (child.type === 'resource_location') {
+                            /* @ts-ignore */
+                            child.namespace = _child.namespace;
+                            /* @ts-ignore */
+                            child.path = _child.path;
+                        }
                         if (Object.hasOwn(_child, 'isOptional')) {
                             /* @ts-ignore */
                             child.isOptional = _child.isOptional;
@@ -131,31 +145,26 @@ await CLI.scriptName('mcdoc')
                             /* @ts-ignore */
                             child.value = _child.value;
                             if (internal_locales[parent]) {
-                                locales[`mcdoc.${resource.replace(/\//g, '.')}.${child.value}`] = internal_locales[parent].join('\n');
+                                locales[`mcdoc.${resource.replace(/[\/\\]/g, '.')}.${child.value}`] = removeWindowsCruft(internal_locales[parent].join('').trimEnd());
                                 delete internal_locales[parent];
                             }
                         }
                         if (child.type === 'mcdoc:struct/map_key' &&
                             internal_locales[parent]) {
-                            locales[`mcdoc.${resource.replace(/\//g, '.')}.map_key`] = internal_locales[parent].join('\n');
+                            locales[`mcdoc.${resource.replace(/[\/\\]/g, '.')}.map_key`] = removeWindowsCruft(internal_locales[parent].join('').trimEnd());
                             delete internal_locales[parent];
                         }
                         if (Object.hasOwn(_child, 'comment')) {
                             /* @ts-ignore */
-                            const comment = _child.comment.trim();
+                            const comment = _child.comment;
                             child.comment = comment;
                             if (!args.dry && args.locale &&
                                 _parent?.type === 'mcdoc:doc_comments') {
                                 const key = parent.replace(/\[\d+\]$/, '');
-                                if (!internal_locales.key) {
+                                if (!internal_locales[key]) {
                                     internal_locales[key] = [];
                                 }
-                                internal_locales[key].push(comment);
-                            }
-                            else if (comment.startsWith('/ ')) {
-                                child.type = 'error';
-                                console.warn(`known error: orphaned dispatch comment`);
-                                known_error = true;
+                                internal_locales[key].push(comment.slice(1));
                             }
                         }
                         if (_child.hover)
@@ -205,12 +214,12 @@ await CLI.scriptName('mcdoc')
                     };
                     symbols.push(symbol);
                     if (!args.dry && args.module) {
-                        const dir = parse(join(out, 'module', resource)).dir;
+                        const dir = parse(join(generated, 'module', resource)).dir;
                         if (dir !== '')
                             await fs.ensureDir(dir);
-                        await fs.writeFile(join(out, 'module', `${resource}.mcdoc.json`), JSON.stringify(symbol));
+                        await fs.writeFile(join(generated, 'module', `${resource}.mcdoc.json`), JSON.stringify(symbol));
                         if (args.pretty) {
-                            await fs.writeFile(join(out, 'module', `${resource}.pretty.mcdoc.json`), JSON.stringify(symbol, undefined, 3));
+                            await fs.writeFile(join(generated, 'module', `${resource}.pretty.mcdoc.json`), JSON.stringify(symbol, undefined, 3));
                         }
                     }
                 }
@@ -218,12 +227,12 @@ await CLI.scriptName('mcdoc')
         }
     }
     if (!args.dry) {
-        await fs.writeFile(join(out, 'generated.mcdoc.json'), JSON.stringify(symbols));
+        await fs.writeFile(join(generated, 'generated.mcdoc.json'), JSON.stringify(symbols));
         if (args.pretty) {
-            await fs.writeFile(join(out, 'generated.pretty.mcdoc.json'), JSON.stringify(symbols, undefined, 3));
+            await fs.writeFile(join(generated, 'generated.pretty.mcdoc.json'), JSON.stringify(symbols, undefined, 3));
         }
         if (args.module) {
-            await fs.writeFile(join(out, 'module', 'index.json'), JSON.stringify(symbols.map(symbol => symbol.resource)));
+            await fs.writeFile(join(generated, 'module', 'index.json'), JSON.stringify(symbols.map(symbol => symbol.resource)));
         }
         if (args.locale) {
             const orphaned_doc = Object.keys(internal_locales);
@@ -231,7 +240,7 @@ await CLI.scriptName('mcdoc')
                 console.warn(`parsing error, ${orphaned_doc.length} orphaned doc comments or incorrectly parsed markup comments`);
                 console.warn(internal_locales);
             }
-            await fs.writeFile(join(out, 'locale.en-us.json'), JSON.stringify(locales, undefined, 3));
+            await fs.writeFile(join('out', 'locale', 'locale.en-us.json'), JSON.stringify(locales, undefined, 3));
         }
     }
     console.log(`Generated JSON files with ${errors} errors.`);
@@ -240,4 +249,4 @@ await CLI.scriptName('mcdoc')
     .strict()
     .demandCommand(1)
     .parse();
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.mjs.map

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@spyglassmc/mcdoc-cli",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "type": "module",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "lib/index.mjs",
+  "types": "lib/index.d.mts",
   "contributors": [
     {
-      "name": "Misode"
+      "name": "Misode",
+      "url": "https://github.com/misode"
     },
     {
       "name": "MulverineX",
-      "url": "http://mulverine.dev"
+      "url": "https://mulverine.dev"
     }
   ],
   "license": "MIT",
@@ -18,34 +19,35 @@
     "test": "test/"
   },
   "bin": {
-    "mcdoc": "./lib/index.js"
+    "mcdoc": "lib/index.mjs"
   },
   "scripts": {
     "release": "npm publish",
     "release:dry": "npm publish --dry-run",
-    "test": "rm -rf vanilla-mcdoc && rm -rf src/out && git clone https://github.com/SpyglassMC/vanilla-mcdoc && cd src && ./index.ts generate ../vanilla-mcdoc/ -p -m -l"
+    "test": "rm -rf vanilla-mcdoc && rm -rf src/out && git clone https://github.com/SpyglassMC/vanilla-mcdoc && cd src && npx tsx src/index.mts generate ../vanilla-mcdoc/ -p -m -l"
   },
   "dependencies": {
     "fs-extra": "^11.1.1",
     "klaw": "^4.1.0",
     "line-column": "^1.0.2",
     "yargs": "17.6.2",
-    "@spyglassmc/core": "0.4.2",
-    "@spyglassmc/mcdoc": "0.3.3"
+    "@spyglassmc/core": "0.4.4",
+    "@spyglassmc/mcdoc": "0.3.5"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.2",
     "@types/klaw": "^3.0.4",
     "@types/line-column": "^1.0.0",
     "@types/node": "18.11.17",
-    "@types/yargs": "17.0.17"
+    "@types/yargs": "17.0.17",
+    "typescript": "^5.4.5"
   },
   "publishConfig": {
     "access": "public"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/SpyglassMC/Spyglass.git"
+    "url": "git+https://github.com/SpyglassMC/Spyglass.git"
   },
   "homepage": "https://spyglassmc.com",
   "bugs": {

package/lib/index.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env -S ts-node --esm
-export {};
-//# sourceMappingURL=index.d.ts.map