circuitscript 0.3.1 → 0.3.2

package/dist/cjs/RefdesAnnotationVisitor.js

@@ -117,12 +117,12 @@ class RefdesAnnotationVisitor extends BaseVisitor_js_1.BaseVisitor {
         return this.resultText;
     }
     getOutputForExternalRefdesFile() {
-        const result = [];
+        const result = {};
         this.modifications.forEach((modification, ctx) => {
             const { line: startLine, column: startColumn } = ctx.start;
             const { line: stopLine, column: stopColumn } = ctx.stop;
             const joinedRefdes = modification.refdes.join(',');
-            result.push(`${startLine}:${startColumn}:${stopLine}:${stopColumn}:${joinedRefdes}`);
+            result[joinedRefdes] = `${startLine}:${startColumn}:${stopLine}:${stopColumn}`;
         });
         return result;
     }

package/dist/cjs/helpers.js

@@ -162,7 +162,7 @@ exports.validateScript = validateScript;
 async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens, componentLinks, importedLibraries, environment) {
     const { inputPath = null, updateSource = false, saveAnnotatedCopy = undefined, } = options;
     if (inputPath && (updateSource || saveAnnotatedCopy !== undefined)) {
-        const annotatedFiles = [{
+        const sourceAnnotatedFiles = [{
                 isMainFile: true,
                 scriptData,
                 tokens,
@@ -170,6 +170,7 @@ async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens,
                 filePath: inputPath,
                 outputType: RefdesOutputType.WithSource
             }];
+        const externalRefdesLibraries = [];
         for (const library of importedLibraries) {
             let outputType = RefdesOutputType.None;
             if (library.enableRefdesAnnotation) {
@@ -181,17 +182,23 @@ async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens,
             if (outputType !== RefdesOutputType.None) {
                 const { libraryFilePath, libraryName, tokens: libTokens, tree: libTree } = library;
                 const libraryScriptData = await environment.readFile(libraryFilePath, { encoding: 'utf8' });
-                annotatedFiles.push({
+                const annotatedFile = {
                     tokens: libTokens,
                     tree: libTree,
                     filePath: libraryFilePath,
                     scriptData: libraryScriptData,
                     libraryName,
                     outputType
-                });
+                };
+                if (outputType === RefdesOutputType.CreateExternalFile) {
+                    externalRefdesLibraries.push(annotatedFile);
+                }
+                else {
+                    sourceAnnotatedFiles.push(annotatedFile);
+                }
             }
         }
-        for (const item of annotatedFiles) {
+        for (const item of sourceAnnotatedFiles) {
             const { scriptData, tokens, tree, filePath, libraryName, isMainFile = false } = item;
             const tmpVisitor = new RefdesAnnotationVisitor_js_1.RefdesAnnotationVisitor(true, scriptData, tokens, componentLinks);
             await tmpVisitor.visit(tree);
@@ -205,31 +212,42 @@ async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens,
             else if (isMainFile && typeof saveAnnotatedCopy === 'string') {
                 usePath = saveAnnotatedCopy;
             }
-            if (item.outputType === RefdesOutputType.WithSource) {
-                environment.writeFileSync(usePath, tmpVisitor.getOutput());
-            }
-            else if (item.outputType === RefdesOutputType.CreateExternalFile) {
-                const dir = environment.dirname(usePath);
-                const ext = environment.extname(usePath);
-                const basename = environment.basename(filePath, ext);
-                usePath = environment.join(dir, `${basename}${globals_js_1.RefdesFileSuffix}`);
-                const output = tmpVisitor.getOutputForExternalRefdesFile();
-                const inputDir = environment.dirname(inputPath);
-                const relativeFilePath = environment.relative(inputDir, filePath);
-                const jsonFile = {
-                    format: 'v1',
-                    library: libraryName,
-                    file: relativeFilePath,
-                    items: output,
-                };
-                environment.writeFileSync(usePath, JSON.stringify(jsonFile, null, 4));
-            }
+            environment.writeFileSync(usePath, tmpVisitor.getOutput());
             let display = 'Refdes annotations';
             if (libraryName) {
                 display += ` for library ${libraryName}`;
             }
             console.log(`${display} saved to ${usePath}`);
         }
+        if (externalRefdesLibraries.length > 0) {
+            const inputDir = environment.dirname(inputPath);
+            const inputExt = environment.extname(inputPath);
+            const inputBasename = environment.basename(inputPath, inputExt);
+            const refdesFilePath = environment.join(inputDir, `${inputBasename}${globals_js_1.RefdesFileSuffix}`);
+            const libraries = [];
+            for (const item of externalRefdesLibraries) {
+                const { scriptData, tokens, tree, filePath, libraryName } = item;
+                const tmpVisitor = new RefdesAnnotationVisitor_js_1.RefdesAnnotationVisitor(true, scriptData, tokens, componentLinks);
+                await tmpVisitor.visit(tree);
+                const output = tmpVisitor.getOutputForExternalRefdesFile();
+                const relativeFilePath = environment.relative(inputDir, filePath);
+                libraries.push({
+                    name: libraryName,
+                    path: relativeFilePath,
+                    items: output,
+                });
+            }
+            const sortedLibs = libraries.sort((a, b) => {
+                return a.name.localeCompare(b.name);
+            });
+            const jsonFile = {
+                format: 'v1',
+                description: 'Stores external refdes for libraries',
+                libraries: sortedLibs,
+            };
+            environment.writeFileSync(refdesFilePath, JSON.stringify(jsonFile, null, 4));
+            console.log(`External refdes annotations saved to ${refdesFilePath}`);
+        }
     }
 }
 var RefdesOutputType;

package/dist/cjs/visitor.js

@@ -1386,24 +1386,34 @@ class ParserVisitor extends BaseVisitor_js_1.BaseVisitor {
         }
     }
     async checkLibraryHasRefdesFile(filePath) {
-        const dir = this.environment.dirname(filePath);
-        const ext = this.environment.extname(filePath);
-        const basename = this.environment.basename(filePath, ext);
-        const annotatedFilePath = this.environment.join(dir, `${basename}${globals_js_1.RefdesFileSuffix}`);
-        const exists = await this.environment.exists(annotatedFilePath);
+        if (this.filePathStack.length === 0) {
+            return;
+        }
+        const mainFilePath = this.environment.getAbsolutePath(this.filePathStack[0]);
+        const mainDir = this.environment.dirname(mainFilePath);
+        const mainExt = this.environment.extname(mainFilePath);
+        const mainBasename = this.environment.basename(mainFilePath, mainExt);
+        const refdesFilePath = this.environment.join(mainDir, `${mainBasename}${globals_js_1.RefdesFileSuffix}`);
+        const exists = await this.environment.exists(refdesFilePath);
         if (exists) {
-            this.log(`Import has refdes file: ${annotatedFilePath}`);
-            const fileData = await this.environment.readFile(annotatedFilePath);
+            this.log(`Main schematic has refdes file: ${refdesFilePath}`);
+            const fileData = await this.environment.readFile(refdesFilePath);
             const jsonData = JSON.parse(fileData);
-            const baseFilePath = this.environment.getAbsolutePath(this.filePathStack[0]);
-            const basePathDirectory = this.environment.dirname(baseFilePath);
-            const { file, items } = jsonData;
-            for (const item of items) {
-                const parts = item.split(':');
-                const refdes = parts[4];
-                const useFilePath = this.environment.join(basePathDirectory, file);
-                const key = this.getRefdesFileAnnotation(useFilePath, Number(parts[0]), Number(parts[1]), Number(parts[2]), Number(parts[3]));
-                this.refdesFileAnnotations.set(key, refdes);
+            const relativeLibraryPath = this.environment.relative(mainDir, filePath);
+            const { libraries = [] } = jsonData;
+            for (const library of libraries) {
+                const { path: libraryPath, items } = library;
+                if (libraryPath === relativeLibraryPath) {
+                    this.log(`Found refdes annotations for library at: ${libraryPath}`);
+                    const useFilePath = this.environment.join(mainDir, libraryPath);
+                    for (const refdes in items) {
+                        const val = items[refdes];
+                        const parts = val.split(':');
+                        const key = this.getRefdesFileAnnotation(useFilePath, Number(parts[0]), Number(parts[1]), Number(parts[2]), Number(parts[3]));
+                        this.refdesFileAnnotations.set(key, refdes);
+                    }
+                    break;
+                }
             }
         }
     }

package/dist/esm/RefdesAnnotationVisitor.js

@@ -117,12 +117,12 @@ export class RefdesAnnotationVisitor extends BaseVisitor {
         return this.resultText;
     }
     getOutputForExternalRefdesFile() {
-        const result = [];
+        const result = {};
         this.modifications.forEach((modification, ctx) => {
             const { line: startLine, column: startColumn } = ctx.start;
             const { line: stopLine, column: stopColumn } = ctx.stop;
             const joinedRefdes = modification.refdes.join(',');
-            result.push(`${startLine}:${startColumn}:${stopLine}:${stopColumn}:${joinedRefdes}`);
+            result[joinedRefdes] = `${startLine}:${startColumn}:${stopLine}:${stopColumn}`;
         });
         return result;
     }

package/dist/esm/helpers.js

@@ -152,7 +152,7 @@ export async function validateScript(filePath, scriptData, options) {
 async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens, componentLinks, importedLibraries, environment) {
     const { inputPath = null, updateSource = false, saveAnnotatedCopy = undefined, } = options;
     if (inputPath && (updateSource || saveAnnotatedCopy !== undefined)) {
-        const annotatedFiles = [{
+        const sourceAnnotatedFiles = [{
                 isMainFile: true,
                 scriptData,
                 tokens,
@@ -160,6 +160,7 @@ async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens,
                 filePath: inputPath,
                 outputType: RefdesOutputType.WithSource
             }];
+        const externalRefdesLibraries = [];
         for (const library of importedLibraries) {
             let outputType = RefdesOutputType.None;
             if (library.enableRefdesAnnotation) {
@@ -171,17 +172,23 @@ async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens,
             if (outputType !== RefdesOutputType.None) {
                 const { libraryFilePath, libraryName, tokens: libTokens, tree: libTree } = library;
                 const libraryScriptData = await environment.readFile(libraryFilePath, { encoding: 'utf8' });
-                annotatedFiles.push({
+                const annotatedFile = {
                     tokens: libTokens,
                     tree: libTree,
                     filePath: libraryFilePath,
                     scriptData: libraryScriptData,
                     libraryName,
                     outputType
-                });
+                };
+                if (outputType === RefdesOutputType.CreateExternalFile) {
+                    externalRefdesLibraries.push(annotatedFile);
+                }
+                else {
+                    sourceAnnotatedFiles.push(annotatedFile);
+                }
             }
         }
-        for (const item of annotatedFiles) {
+        for (const item of sourceAnnotatedFiles) {
             const { scriptData, tokens, tree, filePath, libraryName, isMainFile = false } = item;
             const tmpVisitor = new RefdesAnnotationVisitor(true, scriptData, tokens, componentLinks);
             await tmpVisitor.visit(tree);
@@ -195,31 +202,42 @@ async function DefaultPostAnnotationCallback(options, scriptData, tree, tokens,
             else if (isMainFile && typeof saveAnnotatedCopy === 'string') {
                 usePath = saveAnnotatedCopy;
             }
-            if (item.outputType === RefdesOutputType.WithSource) {
-                environment.writeFileSync(usePath, tmpVisitor.getOutput());
-            }
-            else if (item.outputType === RefdesOutputType.CreateExternalFile) {
-                const dir = environment.dirname(usePath);
-                const ext = environment.extname(usePath);
-                const basename = environment.basename(filePath, ext);
-                usePath = environment.join(dir, `${basename}${RefdesFileSuffix}`);
-                const output = tmpVisitor.getOutputForExternalRefdesFile();
-                const inputDir = environment.dirname(inputPath);
-                const relativeFilePath = environment.relative(inputDir, filePath);
-                const jsonFile = {
-                    format: 'v1',
-                    library: libraryName,
-                    file: relativeFilePath,
-                    items: output,
-                };
-                environment.writeFileSync(usePath, JSON.stringify(jsonFile, null, 4));
-            }
+            environment.writeFileSync(usePath, tmpVisitor.getOutput());
             let display = 'Refdes annotations';
             if (libraryName) {
                 display += ` for library ${libraryName}`;
             }
             console.log(`${display} saved to ${usePath}`);
         }
+        if (externalRefdesLibraries.length > 0) {
+            const inputDir = environment.dirname(inputPath);
+            const inputExt = environment.extname(inputPath);
+            const inputBasename = environment.basename(inputPath, inputExt);
+            const refdesFilePath = environment.join(inputDir, `${inputBasename}${RefdesFileSuffix}`);
+            const libraries = [];
+            for (const item of externalRefdesLibraries) {
+                const { scriptData, tokens, tree, filePath, libraryName } = item;
+                const tmpVisitor = new RefdesAnnotationVisitor(true, scriptData, tokens, componentLinks);
+                await tmpVisitor.visit(tree);
+                const output = tmpVisitor.getOutputForExternalRefdesFile();
+                const relativeFilePath = environment.relative(inputDir, filePath);
+                libraries.push({
+                    name: libraryName,
+                    path: relativeFilePath,
+                    items: output,
+                });
+            }
+            const sortedLibs = libraries.sort((a, b) => {
+                return a.name.localeCompare(b.name);
+            });
+            const jsonFile = {
+                format: 'v1',
+                description: 'Stores external refdes for libraries',
+                libraries: sortedLibs,
+            };
+            environment.writeFileSync(refdesFilePath, JSON.stringify(jsonFile, null, 4));
+            console.log(`External refdes annotations saved to ${refdesFilePath}`);
+        }
     }
 }
 var RefdesOutputType;

package/dist/esm/visitor.js

@@ -1376,24 +1376,34 @@ export class ParserVisitor extends BaseVisitor {
         });
     };
     async checkLibraryHasRefdesFile(filePath) {
-        const dir = this.environment.dirname(filePath);
-        const ext = this.environment.extname(filePath);
-        const basename = this.environment.basename(filePath, ext);
-        const annotatedFilePath = this.environment.join(dir, `${basename}${RefdesFileSuffix}`);
-        const exists = await this.environment.exists(annotatedFilePath);
+        if (this.filePathStack.length === 0) {
+            return;
+        }
+        const mainFilePath = this.environment.getAbsolutePath(this.filePathStack[0]);
+        const mainDir = this.environment.dirname(mainFilePath);
+        const mainExt = this.environment.extname(mainFilePath);
+        const mainBasename = this.environment.basename(mainFilePath, mainExt);
+        const refdesFilePath = this.environment.join(mainDir, `${mainBasename}${RefdesFileSuffix}`);
+        const exists = await this.environment.exists(refdesFilePath);
         if (exists) {
-            this.log(`Import has refdes file: ${annotatedFilePath}`);
-            const fileData = await this.environment.readFile(annotatedFilePath);
+            this.log(`Main schematic has refdes file: ${refdesFilePath}`);
+            const fileData = await this.environment.readFile(refdesFilePath);
             const jsonData = JSON.parse(fileData);
-            const baseFilePath = this.environment.getAbsolutePath(this.filePathStack[0]);
-            const basePathDirectory = this.environment.dirname(baseFilePath);
-            const { file, items } = jsonData;
-            for (const item of items) {
-                const parts = item.split(':');
-                const refdes = parts[4];
-                const useFilePath = this.environment.join(basePathDirectory, file);
-                const key = this.getRefdesFileAnnotation(useFilePath, Number(parts[0]), Number(parts[1]), Number(parts[2]), Number(parts[3]));
-                this.refdesFileAnnotations.set(key, refdes);
+            const relativeLibraryPath = this.environment.relative(mainDir, filePath);
+            const { libraries = [] } = jsonData;
+            for (const library of libraries) {
+                const { path: libraryPath, items } = library;
+                if (libraryPath === relativeLibraryPath) {
+                    this.log(`Found refdes annotations for library at: ${libraryPath}`);
+                    const useFilePath = this.environment.join(mainDir, libraryPath);
+                    for (const refdes in items) {
+                        const val = items[refdes];
+                        const parts = val.split(':');
+                        const key = this.getRefdesFileAnnotation(useFilePath, Number(parts[0]), Number(parts[1]), Number(parts[2]), Number(parts[3]));
+                        this.refdesFileAnnotations.set(key, refdes);
+                    }
+                    break;
+                }
             }
         }
     }

package/dist/types/RefdesAnnotationVisitor.d.ts

@@ -27,7 +27,7 @@ export declare class RefdesAnnotationVisitor extends BaseVisitor {
     private generateRefdesAnnotationComment;
     private addRefdesAnnotationComment;
     getOutput(): string;
-    getOutputForExternalRefdesFile(): string[];
+    getOutputForExternalRefdesFile(): Record<string, string>;
     private generateModifiedText;
     private buildContextTokenRanges;
     private findContextForToken;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "circuitscript",
-    "version": "0.3.1",
+    "version": "0.3.2",
     "description": "Interpreter for the circuitscript language",
     "homepage": "https://circuitscript.net",
     "engines": {