circuitscript 0.0.22 → 0.0.25

package/__tests__/testCLI.ts

@@ -1,68 +0,0 @@
-import { execSync } from 'child_process';
-import figlet from 'figlet';
-import { existsSync, mkdirSync, readFileSync, unlinkSync } from 'fs';
-
-describe('test cli program', () => {
-
-    const tmpFolder = '__tests__/tmp';
-
-    const baseCommand = 'node build/src/main.js';
-
-    test('start program and display help', () => {
-        const result = execSync(baseCommand).toString();
-        const circuitscriptText = figlet.textSync('circuitscript', {
-            font: 'Small Slant'
-        });
-
-        expect(result.includes(circuitscriptText)).toBe(true);
-
-        const options = 
-`Options:
-  -V, --version                   output the version number
-  -i, --input text <input text>   Input text directly
-  -f, --input-file <path>         Input file
-  -o, --output <path>             Output path
-  -c, --current-directory <path>  Set current directory
-  -k, --kicad-netlist <filename>  Create KiCad netlist
-  -w, --watch                     Watch for file changes
-  -n, --dump-nets                 Dump out net information
-  -d, --dump-data                 Dump data during parsing
-  -s, --stats                     Show stats during generation
-  -h, --help                      display help for command`
-
-        expect(result.includes(options)).toBe(true);
-    });
-
-    test('pass in file and output directly', () => {
-        const result = execSync(baseCommand + ' -f __tests__/renderData/script1.cst').toString();
-        const expected = readFileSync('__tests__/renderData/script1.cst.svg').toString();
-        expect(result.trim()).toBe(expected);
-    });
-
-    test.each([false, true])('pass in file and output file (with stats: %s)', (withStatsFlag: boolean) => {
-        const outputPath = '__tests__/tmp/result1.svg';
-        if (existsSync(outputPath)) {
-            unlinkSync(outputPath);
-        }
-
-        if (!existsSync(tmpFolder)) {
-            mkdirSync(tmpFolder);
-        }
-
-        const statsFlag = withStatsFlag ? ' -s ' : '';
-
-        const result = execSync(`${baseCommand} -f __tests__/renderData/script1.cst -o ${outputPath} ${statsFlag}`).toString();
-
-        const outputFile = readFileSync(outputPath).toString();
-        const expected = readFileSync('__tests__/renderData/script1.cst.svg').toString();
-
-        expect(outputFile.trim()).toBe(expected.trim());
-
-        expect(
-            result.includes('Lexing took:') &&
-            result.includes('Parsing took:') &&
-            result.includes('Layout took:') &&
-            result.includes('Render took:')
-        ).toBe(withStatsFlag);
-    });
-});

package/__tests__/testMathOps.ts

@@ -1,36 +0,0 @@
-import { runScript } from "./helpers.js";
-
-const script1 = `
-b = 10
-a = -b
-`
-
-const script2 = `
-b = 10
-a = -b / 2 - 1
-`
-
-describe('Simple math tests', () => {
-    test.each([
-        ["a = -1 + 2", 1],
-        ["a = 1 + 2", 3],
-        ["a = 1 + 2 * 3", 7],
-        ["a = 5 - 1", 4],
-        ["a = 5 - 1 * 2", 3],
-        ["a = 10 / 2", 5],
-        ["a = 1 + 9 / 3", 4],
-        ["a = 1+20-2", 19],
-        ["a = -1+2", 1],
-        ["a = -123", -123],
-        ["a = 0-123", -123],
-        [script1, -10],
-        [script2, -6]
-    ])('math test - %s', async (script, expectedResult) => {
-        const {visitor, hasError} = await runScript(script);
-
-        expect(hasError).toBe(false);
-
-        const variables = visitor.dumpVariables();
-        expect(variables.get('a')).toBe(expectedResult);
-    });
-})

package/__tests__/testMergeWires.ts

@@ -1,141 +0,0 @@
-import { Geometry } from "../src/geometry";
-
-describe('geometry merge wires test', () => {
-
-    test('wire connected end to end', () => {
-
-        const wire1 = [
-            { x: 100, y: 100 },
-            { x: 200, y: 100 }
-        ];
-
-        const wire2 = [
-            { x: 200, y: 100 },
-            { x: 200, y: 120 }
-        ];
-
-        const { intersectPoints, segments } = Geometry.mergeWires([wire1, wire2]);
-        expect(segments).toStrictEqual([
-            [
-                [100, 100], [200, 100]
-            ],
-            [
-                [200, 100], [200, 120],
-            ]
-        ]);
-
-        expect(intersectPoints).toStrictEqual([]);
-    });
-
-    test('wire connected at some point of wire 1', () => {
-
-        const wire1 = [
-            { x: 100, y: 100 },
-            { x: 200, y: 100 }
-        ];
-
-        const wire2 = [
-            { x: 160, y: 100 },
-            { x: 160, y: 120 }
-        ];
-
-        const { intersectPoints, segments } = Geometry.mergeWires([wire1, wire2]);
-
-        expect(segments).toStrictEqual([
-            [
-                [100, 100], [160, 100]
-            ],
-            [
-                [160, 100], [200, 100],
-            ],
-            [
-                [160, 100], [160, 120],
-            ]
-        ]);
-
-        expect(intersectPoints).toStrictEqual([
-            [160, 100, 3],
-        ])
-    });
-
-    test('wire connected at some point of wire 2', () => {
-
-        const wire1 = [
-            { x: 100, y: 100 },
-            { x: 200, y: 100 }
-        ];
-
-        const wire2 = [
-            { x: 160, y: 100 },
-            { x: 160, y: 120 }
-        ];
-
-        const { intersectPoints, segments } = Geometry.mergeWires([wire2, wire1]);
-
-        expect(segments).toStrictEqual([
-            [
-                [160, 100], [160, 120]
-            ],
-            [
-                [100, 100], [160, 100],
-            ],
-            [
-                [160, 100], [200, 100],
-            ]
-        ]);
-
-        expect(intersectPoints).toStrictEqual([
-            [160, 100, 3],
-        ])
-    });
-
-    test('overlapping wires', () => {
-
-        const wire1 = [
-            { x: 100, y: 100 },
-            { x: 140, y: 100 }
-        ];
-
-        const wire2 = [
-            { x: 120, y: 100 },
-            { x: 160, y: 100 }
-        ];
-
-        const { intersectPoints, segments } = Geometry.mergeWires([wire1, wire2]);
-
-        // No intersection points, because only have two segments
-        // connected at each point.
-        expect(intersectPoints).toStrictEqual([]);
-
-        expect(segments).toStrictEqual(
-            [
-                [[120, 100], [140, 100]],
-                [[100, 100], [120, 100]],
-                [[140, 100], [160, 100]]
-            ]
-        );
-    });
-
-    test('reversed wires', () => {
-
-        const wire1 = [
-            { x: 100, y: 100 },
-            { x: 140, y: 100 }
-        ];
-
-        const wire2 = [
-            { x: 140, y: 100 },
-            { x: 100, y: 100 }
-        ];
-
-        const { intersectPoints, segments } = Geometry.mergeWires([wire1, wire2]);
-
-        expect(intersectPoints).toStrictEqual([]);
-        expect(segments).toStrictEqual(
-            [
-                [[100, 100], [140, 100]]
-            ]
-        );
-    });
-
-});

package/__tests__/testParse.ts

@@ -1,263 +0,0 @@
-
-import { findItem, findItemByRefDes, runScript } from './helpers.js';
-import { script1, script10, script11, script12, script13, script14, script15, script16, script2, 
-    script3, script6, script7, script8, script9 } from './parseScripts.js';
-
-describe('test parsing', () => {
-
-    test.each([
-        ["create component command", script1],
-        ["function to create component and branching", script2],
-        ["nested branching, add with pin selected", script3],
-        ["'at' and 'to' commands will clone net components", script6],
-        ["resolve instances in upper contexts", script7],
-        ["components in function parameters", script8],
-        ["resolve nets in local and upper contexts", script9],
-        ["assignment in at/to/add statement", script10],
-        ["net namespace local and global", script11],
-        ["create component with __is_net", script12],
-        ["corret nets after function call and also `join` keyword", script13],
-        ["path with 'point' keyword", script14],
-        ["path with 'parallel' keyword", script15],
-        ["consecutive blocks with 'join' then 'point'", script16]
-        
-    ])('parse script - %s', async (description, scriptTest) => {
-        // Test only parsing, does not check the correctness of the 
-        // parsed result!
-
-        // Access scripts like this to prevent having to 
-        // define the script content before the test itself
-        const {hasError, componentPinNets} = await runScript(scriptTest.script);
-
-        expect(hasError).toBe(false);
-        expect(componentPinNets).toStrictEqual(scriptTest.expected);
-    });
-
-    test('component annotation', async () => {
-        const { hasError, visitor } = await runScript(`
-import lib
-
-variant = "MainVariantX"
-gnd = dgnd()
-
-at net("5V")
-wire down 20
-branch:
-    wire down 20
-    add res(10k) ..angle = 90
-    ..place = (variant == "MainVariant")
-    wire down 20 to gnd
-
-wire right 40
-branch:
-    wire down 20
-    add res(20k) ..angle = 90
-    ..place = true
-    wire down 20
-    to gnd
-
-wire right 40
-branch:
-    wire down 20
-    add cap(100n)
-    wire down 20
-    to gnd
-`);
-        expect(hasError).toBe(false);
-
-        visitor.annotateComponents();
-        const instances = visitor.dumpInstances();
-
-        expect(findItem(instances, 'res', 'R1', 'numeric:10k')).not.toBeNull();
-        expect(findItem(instances, 'res', 'R2', 'numeric:20k')).not.toBeNull();
-        expect(findItem(instances, 'cap', 'C1', 'numeric:100n')).not.toBeNull();
-    });
-
-    test('component annotation with custom type param', async () => {
-
-        const script = `
-import lib
-
-v5v = supply("5V")
-gnd = dgnd()
-
-a = create component:
-        type: "X"
-        pins: 2
-
-a2 = create component:
-        type: "X"
-        pins: 3
-
-at v5v
-wire down 20 right 20
-to a pin 1
-
-at v5v
-wire down 20 right 20
-to a2 pin 3
-
-`
-        const {hasError, visitor} = await runScript(script);
-        expect(hasError).toBe(false);
-
-        visitor.annotateComponents();
-
-        const instances = visitor.dumpInstances();
-
-        expect(findItemByRefDes(instances, 'X', 'X1')).not.toBeNull();
-        expect(findItemByRefDes(instances, 'X', 'X2')).not.toBeNull();
-    });
-
-    test('component annotation with defined refdes', async () => {
-
-        const script = `
-import lib
-
-v5v = supply("5V")
-gnd = dgnd()
-
-at v5v
-wire down 10 
-add res(10k)
-..refdes = "R2"
-
-wire down 10
-add res(20k)
-
-wire down 10
-add res(30k)
-
-wire down 10
-add res(40k)
-..refdes = "R100"
-`
-        const {hasError, visitor} = await runScript(script);
-        expect(hasError).toBe(false);
-
-        visitor.annotateComponents();
-
-        const instances = visitor.dumpInstances();
-
-        expect(findItem(instances, 'res', 'R2', 'numeric:10k')).not.toBeNull();
-        expect(findItem(instances, 'res', 'R1', 'numeric:20k')).not.toBeNull();
-        expect(findItem(instances, 'res', 'R3', 'numeric:30k')).not.toBeNull();
-        expect(findItem(instances, 'res', 'R100', 
-            'numeric:40k')).not.toBeNull();
-    });
-
-    test('indents in function definition', async() => {
-        // Check that indents within parantheses/brackets are ignored.
-        const script = `
-def test1(a, 
-  b,
-    c):
-    return a + b + c
-
-print(test1(1,2,3))
-`
-        const { hasError, visitor } = await runScript(script);
-        expect(hasError).toBe(false);
-
-        expect(visitor.printStream[0]).toBe(6);
-    });
-
-    test('double dot syntax', async () => {
-        // Check that the double dot syntax works for 'place' parameter
-
-        const script = `
-import lib
-gnd = dgnd()
-
-at net("5V")
-wire down 20
-
-add res(10k)
-..place = false
-
-wire down 20
-
-add res(20k)
-..place = true
-wire down 20
-to gnd
-`
-        const {hasError, visitor} = await runScript(script);
-        expect(hasError).toBe(false);
-
-        visitor.annotateComponents();
-        const instances = visitor.dumpInstances();
-
-        const item1 = findItem(instances, 'res', 'R1', 'numeric:10k');
-        expect(item1.parameters.get('place')).toBe(false);
-
-        const item2 = findItem(instances, 'res', 'R2', 'numeric:20k');
-        expect(item2.parameters.get('place')).toBe(true);
-    });
-
-    test('instance assignment syntax', async () => {
-
-        const script = `
-import lib
-gnd = dgnd()
-
-at supply("5V")
-wire down 20
-add R1 = res(10k)
-wire down 20
-to gnd
-
-# update resistor value
-R1.value = 20k
-R1.place = false
-R1.mpn = "res-12345"
-`;
-
-        const {hasError, visitor} = await runScript(script);
-        expect(hasError).toBe(false);
-
-        visitor.annotateComponents();
-        const instances = visitor.dumpInstances();
-
-        const item1 = findItem(instances, 'res', 'R1', 'numeric:20k');
-        expect(item1.parameters.get('place')).toBe(false);
-        expect(item1.parameters.get('mpn')).toBe('res-12345');
-    });
-
-    test('unary minus operator', async () => {
-        const script = `
-b = 20
-print(b)
-print(-b)
-print(--b)
-print(---b)
-`;
-
-        const { hasError, visitor } = await runScript(script);
-        expect(hasError).toBe(false);
-
-        expect(visitor.printStream).toStrictEqual([20, -20, 20, -20]);
-    });
-});
-
-// This tests that an error is generated at the right position for 
-// overlapping connections
-`
-import lib
-import { async } from '../src/sizing';
-v5v = supply("5v")
-gnd = dgnd()
-
-c1 = cap(100n)
-
-at v5v
-wire down 20
-branch:
-    wire down 20
-    add c1
-    wire down 20
-    to gnd
-
-wire down 40    # error should be here
-to c1 pin 1
-`

package/__tests__/testRender.ts

@@ -1,38 +0,0 @@
-import { readFileSync } from 'fs';
-
-import { LayoutEngine } from "../src/layout.js";
-import { generateSVG2 } from "../src/render.js";
-import { runScript } from "./helpers.js";
-
-const mainPath = '__tests__/renderData/';
-
-describe('Render tests', () => {
-
-    test.each([
-        ['variant and branch rendering', 'script1.cst'],
-        ['simple function', 'script2.cst'],
-        ['simple frame', 'script3.cst'],
-        ['drawing functions for graphics', 'script4.cst'],
-        ['drawing 180 deg flipped components', 'script5.cst'],
-        ['join command', 'script6.cst'],
-        ['parallel command', 'script7.cst'],
-        ['point block command', 'script8.cst']
-
-    ])('render - %s (%s)', async (title, scriptPath) => {
-
-        const script = readFileSync(mainPath + scriptPath, { encoding: 'utf8' });
-        const { hasError, visitor } = await runScript(script);
-        expect(hasError).toBe(false);
-        visitor.annotateComponents();
-
-        const { sequence, nets } = visitor.getGraph();
-
-        const layoutEngine = new LayoutEngine();
-        const graph = await layoutEngine.runLayout(sequence, nets);
-
-        const svgOutput = generateSVG2(graph);
-
-        const expectedSvgOutput = readFileSync(mainPath + scriptPath + ".svg", { encoding: 'utf8' });
-        expect(svgOutput).toBe(expectedSvgOutput);
-    });
-});