@andrivet/z80-assembler 1.4.0 → 1.4.1

package/lib/types/Error.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Z80 Assembler in Typescript
+ *
+ * File:        Error.ts
+ * Description: Compilation errors
+ * Author:			Sebastien Andrivet
+ * License:			GPLv3
+ * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
+ */
+import { SyntaxErr } from "../grammar/z80";
+import { Position } from "./Types";
+/**
+ * A compilation error.
+ */
+declare class CompilationError extends Error {
+    readonly position: Position;
+    /**
+     * Constructor.
+     * @param position Position (filename, line, offset) where the error occurred.
+     * @param message Description of the error.
+     */
+    constructor(position: Position, message: string);
+    /**
+     * Format the error.
+     */
+    toString(): string;
+    /**
+     * Format internal MatchAttempt.
+     * @param match The MatchAttempt to format.
+     * @private
+     */
+    private static formatMatch;
+    /**
+     * Format a syntax error.
+     * @param err a syntax error.
+     * @private
+     */
+    private static formatError;
+    /**
+     * Create a compilation error from a syntax error.
+     * @param filename Filename where the error occurred.
+     * @param e Syntax error.
+     */
+    static fromSyntaxErr(filename: string, e: SyntaxErr): CompilationError;
+    /**
+     * Create a compilation error from different errors.
+     * @param filename Filename where the error occurred.
+     * @param e The error
+     */
+    static fromAny(filename: string, e: any): CompilationError;
+    /**
+     * Check if an error is a compilation error (and cast the error in this case).
+     * @param err The error to check.
+     */
+    static is(err: any): err is CompilationError;
+    /**
+     * Check if an error is an array of compilation errors (and cast the type in this case).
+     * @param err The error to check.
+     */
+    static isArray(err: any): err is CompilationError[];
+}
+export { CompilationError };

package/{libs/z80-assembler/src/lib/types/Types.ts → lib/types/Types.d.ts}

@@ -7,56 +7,41 @@
  * License:			GPLv3
  * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
  */
-
-import {Line, PosInfo} from "../grammar/z80";
-import {CompilationError} from "./Error";
-
-
+import { Line, PosInfo } from "../grammar/z80";
+import { CompilationError } from "./Error";
 /**
  * A byte is represented by a number.
  */
 type byte = number;
-
 /**
  * An array of bytes.
  */
 type bytes = byte[];
-
 /**
  * An address is either a number (known) or null (unknown).
  */
 type Address = number | null;
-
 /**
  * Information about lines.
  */
 interface LinesInfo {
-  // An array of lines (AST).
-  lines: Line[];
-  // A filename associated with this lines.
-  filename: string;
+    lines: Line[];
+    filename: string;
 }
-
 /**
  * The result of a compilation.
  */
 interface CompilationInfo {
-  // The name of the output (output directive).
-  outputName: string;
-  // The bytes, result of the compilation.
-  bytes: bytes;
-  // The Source Level Debugging data.
-  sld: string;
-  // The compilation errors.
-  errs: CompilationError[];
+    outputName: string;
+    bytes: bytes;
+    sld: string;
+    errs: CompilationError[];
 }
-
 /**
  * Position in a source file.
  */
 interface Position {
-  filename: string;
-  pos: PosInfo;
+    filename: string;
+    pos: PosInfo;
 }
-
-export {byte, bytes, Address, LinesInfo, CompilationInfo, Position}
+export { byte, bytes, Address, LinesInfo, CompilationInfo, Position };

package/package.json

@@ -1,58 +1,20 @@
 {
   "name": "@andrivet/z80-assembler",
-  "version": "1.4.0",
+  "version": "1.4.1",
+  "description": "A Z80 assembler entirely written in Typescript and derived from a PEG grammar.",
+  "author": "Sebastien Andrivet",
   "license": "GPLv3",
-  "homepage": "https://andrivet.github.io/z80-assembler",
-  "private": false,
-  "dependencies": {
-    "@swc/helpers": "~0.5.1",
-    "@uiw/react-codemirror": "^4.20.2",
-    "browser-fs-access": "^0.34.1",
-    "codemirror": "^6.0.1",
-    "daisyui": "^3.9.4",
-    "react": "^18.2.0",
-    "react-daisyui": "^4.1.2",
-    "react-dom": "^18.2.0",
-    "react-icons": "^4.9.0"
+  "type": "commonjs",
+  "keywords": [
+    "z80",
+    "assembler",
+    "ZX81"
+  ],
+  "publishConfig": {
+    "access": "public"
   },
-  "devDependencies": {
-    "@nx/eslint-plugin": "^16.3.1",
-    "@nx/js": "^16.3.1",
-    "@nx/linter": "^16.3.1",
-    "@nx/react": "^16.3.1",
-    "@nx/vite": "^16.3.1",
-    "@nx/workspace": "^16.3.1",
-    "@swc/cli": "^0.5.1",
-    "@swc/core": "~1.3.61",
-    "@testing-library/react": "^14.0.0",
-    "@types/node": "^20.2.5",
-    "@types/react": "^18.2.8",
-    "@types/react-dom": "^18.2.4",
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.59.8",
-    "@vitejs/plugin-react": "^4.0.0",
-    "@vitest/coverage-c8": "~0.32.2",
-    "@vitest/ui": "~0.32.2",
-    "autoprefixer": "^10.4.14",
-    "eslint": "^8.57.1",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-cypress": "^2.13.3",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsx-a11y": "^6.7.1",
-    "eslint-plugin-react": "^7.32.2",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "gh-pages": "^5.0.0",
-    "jsdom": "~22.1.0",
-    "nx": "^16.3.1",
-    "postcss": "^8.4.24",
-    "prettier": "^2.8.8",
-    "tailwindcss": "^3.3.2",
-    "tspeg": "^3.3.2",
-    "typescript": "^5.1.3",
-    "vite": "^4.5.5",
-    "vite-plugin-dts": "^2.3.0",
-    "vite-plugin-eslint": "^1.8.1",
-    "vite-tsconfig-paths": "^4.2.0",
-    "vitest": "~0.32.2"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/andrivet/z80-assembler"
   }
 }

package/.editorconfig

@@ -1,13 +0,0 @@
-# Editor configuration, see http://editorconfig.org
-root = true
-
-[*]
-charset = utf-8
-indent_style = space
-indent_size = 2
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.md]
-max_line_length = off
-trim_trailing_whitespace = false

package/.eslintignore

@@ -1,3 +0,0 @@
-node_modules
-libs/z80-assembler/src/lib/grammar/z80.ts
-libs/z80-assembler/src/lib/**/*.test.ts

package/.eslintrc.json

@@ -1,35 +0,0 @@
-{
-  "root": true,
-  "ignorePatterns": ["**/*"],
-  "plugins": ["@nx"],
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-      "rules": {
-        "@nx/enforce-module-boundaries": [
-          "error",
-          {
-            "enforceBuildableLibDependency": true,
-            "allow": [],
-            "depConstraints": [
-              {
-                "sourceTag": "*",
-                "onlyDependOnLibsWithTags": ["*"]
-              }
-            ]
-          }
-        ]
-      }
-    },
-    {
-      "files": ["*.ts", "*.tsx"],
-      "extends": ["plugin:@nx/typescript"],
-      "rules": {}
-    },
-    {
-      "files": ["*.js", "*.jsx"],
-      "extends": ["plugin:@nx/javascript"],
-      "rules": {}
-    }
-  ]
-}

package/.github/workflows/node.js.yml

@@ -1,47 +0,0 @@
-name: CD
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [16.x, 18.x, 20.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - name: Install dependencies
-      run: npm ci --legacy-peer-deps
-    - name: Build
-      run: npx nx build z80-assembler-app --prod --baseHref=/z80-assembler/
-    - name: Run tests
-      run: npx nx test z80-assembler
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v1
-      with:
-        path: dist/apps/z80-assembler-app
-
-  deploy:
-    needs: build
-    permissions:
-      pages: write
-      id-token: write
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2

package/.prettierignore

@@ -1,3 +0,0 @@
-# Add files here to ignore them from prettier formatting
-/dist
-/coverage

package/.prettierrc

@@ -1,3 +0,0 @@
-{
-  "singleQuote": true
-}

package/.vscode/extensions.json

@@ -1,7 +0,0 @@
-{
-  "recommendations": [
-    "nrwl.angular-console",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint"
-  ]
-}

package/apps/z80-assembler-app/.eslintrc.json

@@ -1,18 +0,0 @@
-{
-  "extends": ["plugin:@nx/react", "../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
-  "overrides": [
-    {
-      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.ts", "*.tsx"],
-      "rules": {}
-    },
-    {
-      "files": ["*.js", "*.jsx"],
-      "rules": {}
-    }
-  ]
-}

package/apps/z80-assembler-app/index.html

@@ -1,16 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <title>Z80 Assembler in Typescript</title>
-    <base href="/" />
-
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <link rel="icon" type="image/x-icon" href="/favicon.ico" />
-    <link rel="stylesheet" href="/src/styles.css" />
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-  </body>
-</html>

package/apps/z80-assembler-app/postcss.config.js

@@ -1,24 +0,0 @@
-/**
- * Z80 Assembler in Typescript
- *
- * File:        postcss.config.js
- * Description: Configuration for PostCSS
- * Author:			Sebastien Andrivet
- * License:			GPLv3
- * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
- */
-const { join } = require('path');
-
-// Note: If you use library-specific PostCSS/Tailwind configuration then you should remove the `postcssConfig` build
-// option from your application's configuration (i.e. project.json).
-//
-// See: https://nx.dev/guides/using-tailwind-css-in-react#step-4:-applying-configuration-to-libraries
-
-module.exports = {
-  plugins: {
-    tailwindcss: {
-      config: join(__dirname, 'tailwind.config.js'),
-    },
-    autoprefixer: {},
-  },
-};

package/apps/z80-assembler-app/project.json

@@ -1,70 +0,0 @@
-{
-  "name": "z80-assembler-app",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "apps/z80-assembler-app/src",
-  "projectType": "application",
-  "targets": {
-    "build": {
-      "executor": "@nx/vite:build",
-      "outputs": ["{options.outputPath}"],
-      "defaultConfiguration": "production",
-      "options": {
-        "outputPath": "dist/apps/z80-assembler-app"
-      },
-      "configurations": {
-        "development": {
-          "mode": "development"
-        },
-        "production": {
-          "mode": "production"
-        }
-      }
-    },
-    "dev": {
-      "executor": "@nx/vite:dev-server",
-      "defaultConfiguration": "development",
-      "options": {
-        "buildTarget": "z80-assembler-app:build"
-      },
-      "configurations": {
-        "development": {
-          "buildTarget": "z80-assembler-app:build:development",
-          "hmr": true
-        },
-        "production": {
-          "buildTarget": "z80-assembler-app:build:production",
-          "hmr": false
-        }
-      }
-    },
-    "preview": {
-      "executor": "@nx/vite:preview-server",
-      "defaultConfiguration": "development",
-      "options": {
-        "buildTarget": "z80-assembler-app:build"
-      },
-      "configurations": {
-        "development": {
-          "buildTarget": "z80-assembler-app:build:development"
-        },
-        "production": {
-          "buildTarget": "z80-assembler-app:build:production"
-        }
-      }
-    },
-    "lint": {
-      "executor": "@nx/linter:eslint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["apps/z80-assembler-app/**/*.{ts,tsx,js,jsx}"]
-      }
-    },
-    "serve-static": {
-      "executor": "@nx/web:file-server",
-      "options": {
-        "buildTarget": "z80-assembler-app:build"
-      }
-    }
-  },
-  "tags": []
-}

package/apps/z80-assembler-app/public/manifest.json

@@ -1,25 +0,0 @@
-{
-  "short_name": "React App",
-  "name": "Create React App Sample",
-  "icons": [
-    {
-      "src": "favicon.ico",
-      "sizes": "64x64 32x32 24x24 16x16",
-      "type": "image/x-icon"
-    },
-    {
-      "src": "logo192.png",
-      "type": "image/png",
-      "sizes": "192x192"
-    },
-    {
-      "src": "logo512.png",
-      "type": "image/png",
-      "sizes": "512x512"
-    }
-  ],
-  "start_url": ".",
-  "display": "standalone",
-  "theme_color": "#000000",
-  "background_color": "#ffffff"
-}

package/apps/z80-assembler-app/public/robots.txt

@@ -1,3 +0,0 @@
-# https://www.robotstxt.org/robotstxt.html
-User-agent: *
-Disallow:

package/apps/z80-assembler-app/src/app/app.tsx

@@ -1,122 +0,0 @@
-/**
- * Z80 Assembler in Typescript
- *
- * File:        app.tsx
- * Description: Application view
- * Author:			Sebastien Andrivet
- * License:			GPLv3
- * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
- */
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import styles from './app.module.css';
-
-import React, {useRef, useState} from 'react';
-import {AppOpcodes} from "./opcodes";
-import {Chunk, CompilationError, compile, formatBytes} from "@andrivet/z80-assembler";
-import AppFooter from "./footer";
-import AppHeader from "./header";
-import AppBinary from "./binary";
-import AppEditor, {AppEditorHandlers} from "./editor";
-import Errors from "./errors";
-import {closeDropdown} from "./misc";
-import {fileSave} from "browser-fs-access";
-
-interface BinaryOrOpCodesProps {
-  showOpCodes: boolean,
-  chunks: Chunk[] | undefined;
-}
-
-function BinaryOrOpCodes({showOpCodes, chunks}: BinaryOrOpCodesProps) {
-  return showOpCodes ? <AppOpcodes /> : <AppBinary chunks={chunks} />;
-}
-
-export function App() {
-  const [code, setCode] = useState<string>('');
-  const [filepath, setFilepath] = useState<string>('');
-  const [errors, setErrors] = useState<CompilationError[] | undefined>();
-  const [bytes, setBytes] = useState<number[] | undefined>();
-  const [sld, setSld] = useState<string>('');
-  const [chunks, setChunks] = useState<Chunk[] | undefined>();
-  const [showOpCodes, setShowOpCodes] = useState<boolean>(false);
-  const [outputName, setOutputName] = useState<string | undefined>(undefined);
-  const ref = useRef<AppEditorHandlers>(null);
-
-  function handleGetFileCode(filename: string): string {
-    if(ref.current == null) throw new Error(`Invalid reference to the editor`);
-    return ref.current.getCode(filename);
-  }
-
-  function handleCompile() {
-    const info = compile(filepath, code, handleGetFileCode);
-    if(info.errs.length > 0) {
-      setBytes([]);
-      setSld('');
-      setChunks([]);
-      setErrors(info.errs);
-    }
-    else {
-      setShowOpCodes(false);
-      setOutputName(info.outputName);
-      setBytes(info.bytes);
-      setSld(info.sld);
-      setChunks(formatBytes(info.bytes, 16));
-      setErrors([]);
-    }
-  }
-
-  async function handleSaveBinary() {
-    closeDropdown();
-    if (!bytes || !outputName) return;
-    const data = Uint8Array.from(bytes);
-    const blob = new Blob([data]);
-    await fileSave(blob, {
-      fileName: outputName,
-      extensions: ['.P']
-    });
-  }
-
-  async function handleSaveSld() {
-    closeDropdown();
-    if (sld.length <= 0 || !outputName) return;
-    const blob = new Blob([sld]);
-    await fileSave(blob, {
-      fileName: outputName.replace(/\.P$/, ''),
-      extensions: ['.sld']
-    });
-  }
-
-  return (
-    <div className="flex flex-col h-screen bg-neutral-600">
-      <AppHeader
-        onOpenCode={() => ref.current?.openCode()}
-        onOpenCodeDirectory={() => ref.current?.openCodeDirectory()}
-        onSaveCode={() => ref.current?.saveCode()}
-        onSaveBinary={handleSaveBinary}
-        onSaveSld={handleSaveSld}
-        onClose={() => ref.current?.closeCode()}
-        onCloseAll={() => ref.current?.closeAll()}
-        onCompile={handleCompile}
-        onShowOpCodes={() => setShowOpCodes(true)}
-      />
-      <div className="flex-1 flex m-4 gap-4">
-        <div className="flex flex-col w-2/3">
-          <AppEditor
-            ref={ref}
-            code={code}
-            setFilePath={setFilepath}
-            setCode={setCode}
-            errors={errors}
-            setErrors={setErrors} />
-        </div>
-        <div className="flex flex-col w-1/3 z-0">
-          <BinaryOrOpCodes showOpCodes={showOpCodes} chunks={chunks}/>
-        </div>
-      </div>
-      <Errors errors={errors} />
-      <AppFooter />
-    </div>
-  );
-}
-
-export default App;

package/apps/z80-assembler-app/src/app/binary.tsx

@@ -1,39 +0,0 @@
-/**
- * Z80 Assembler in Typescript
- *
- * File:        binary,tsx
- * Description: Binary view
- * Author:			Sebastien Andrivet
- * License:			GPLv3
- * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
- */
-import React from "react";
-import {Table} from "react-daisyui";
-import {Chunk} from "@andrivet/z80-assembler";
-
-interface AppBinaryProps {
-  chunks: Chunk[] | undefined;
-}
-
-export default function AppBinary({chunks}: AppBinaryProps) {
-  return (chunks == null || chunks.length <= 0) ? null : (
-    <>
-      <h1 className="font-bold mb-2 text-orange-400">Machine Code</h1>
-      <div className="flex flex-auto h-full relative mt-0">
-        <div className="absolute top-0 bottom-0 left-0 right-0 overflow-auto">
-          <Table zebra={true}>
-            <Table.Head>{['Address', 'Bytes']}</Table.Head>
-            <Table.Body>
-              {chunks?.map((data, index) => (
-                <Table.Row key={data.address}  className="font-mono">{[
-                  <strong key={`addr-${data.address}`} className="text-orange-400">{data.address}</strong>,
-                  <span key={`data-${data.address}`} >{data.bytes}</span>
-                ]}</Table.Row>
-              ))}
-            </Table.Body>
-          </Table>
-        </div>
-      </div>
-    </>
-  );
-}