@andrivet/z80-assembler 1.3.2 → 1.4.0

package/libs/z80-assembler/src/lib/types/Error.ts

@@ -0,0 +1,105 @@
+/**
+ * Z80 Assembler in Typescript
+ *
+ * File:        Error.ts
+ * Description: Compilation errors
+ * Author:			Sebastien Andrivet
+ * License:			GPLv3
+ * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
+ */
+
+import {MatchAttempt, SyntaxErr} from "../grammar/z80";
+import {Position} from "./Types";
+
+/**
+ * A compilation error.
+ */
+class CompilationError extends Error {
+  /**
+   * Constructor.
+   * @param position Position (filename, line, offset) where the error occurred.
+   * @param message Description of the error.
+   */
+  constructor(public readonly position: Position, message: string) {
+    super(message);
+  }
+
+  /**
+   * Format the error.
+   */
+  override toString() {
+    return `File '${this.position.filename}', Line ${this.position.pos.line}:${this.position.pos.offset+1} - ${this.message}`;
+  }
+
+  /**
+   * Format internal MatchAttempt.
+   * @param match The MatchAttempt to format.
+   * @private
+   */
+  private static formatMatch(match: MatchAttempt) {
+    if(match.kind === 'EOF') return " end of code";
+    const not = match.negated ? 'not ' : '';
+    const literal = match.literal
+      // Escaped chars except escaped backslashes.
+      .replace(/\\([^\\])/g, '$1')
+      // Escaped backslashes.
+      .replace(/\\\\/g, '\\');
+    return ` ${not}${literal}`;
+  }
+
+  /**
+   * Format a syntax error.
+   * @param err a syntax error.
+   * @private
+   */
+  private static formatError(err: SyntaxErr): string {
+    if(err.expmatches.length === 1) {
+      const match = err.expmatches[0];
+      const literal = match.kind === 'EOF' ? 'the end of the code' : match.literal;
+      return `${match.negated ? 'Does not expect ' : 'Expect '}${literal}`;
+    }
+    return `Syntax error, expected one of: ${err.expmatches.map(m => CompilationError.formatMatch(m))}`
+  }
+
+  /**
+   * 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 {
+    return new CompilationError({filename: filename, pos: e.pos}, this.formatError(e));
+  }
+
+  /**
+   * Create a compilation error from different errors.
+   * @param filename Filename where the error occurred.
+   * @param e The error
+   */
+  static fromAny(filename: string, e: any) { // eslint-disable-line
+    // Already a compilation error? Return it.
+    if(e instanceof CompilationError) return e;
+    // A syntax error?
+    if(e instanceof SyntaxErr) return this.fromSyntaxErr(filename, e);
+    // Something else?
+    return new CompilationError({filename: filename, pos: {line: 1, offset: 0, overallPos: 0}}, e.toString());
+  }
+
+  /**
+   * 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 { // eslint-disable-line
+    return (err as CompilationError).position !== undefined;
+  }
+
+  /**
+   * 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[] { // eslint-disable-line
+    const errs = err as CompilationError[];
+    return errs.length !== undefined && (errs.length === 0 || errs[0].position !== undefined);
+  }
+}
+
+export {CompilationError};

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

@@ -7,41 +7,56 @@
  * 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 {
-    lines: Line[];
-    filename: string;
+  // An array of lines (AST).
+  lines: Line[];
+  // A filename associated with this lines.
+  filename: string;
 }
+
 /**
  * The result of a compilation.
  */
 interface CompilationInfo {
-    outputName: string;
-    bytes: bytes;
-    sld: string;
-    errs: CompilationError[];
+  // 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[];
 }
+
 /**
  * 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/libs/z80-assembler/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "types": ["vitest", "vite/client"]
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/libs/z80-assembler/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

package/libs/z80-assembler/tsconfig.spec.json

@@ -0,0 +1,19 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": ["vitest/globals", "vitest/importMeta", "vite/client", "node"]
+  },
+  "include": [
+    "vite.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts"
+  ]
+}

package/libs/z80-assembler/vite.config.ts

@@ -0,0 +1,58 @@
+import { defineConfig } from 'vite';
+
+import viteTsConfigPaths from 'vite-tsconfig-paths';
+import dts from 'vite-plugin-dts';
+import { joinPathFragments } from '@nx/devkit';
+
+export default defineConfig({
+  cacheDir: '../../node_modules/.vite/z80-assembler',
+  assetsInclude: ['**/*.zx81'],
+
+  plugins: [
+    dts({
+      entryRoot: 'src',
+      tsConfigFilePath: joinPathFragments(__dirname, 'tsconfig.lib.json'),
+      skipDiagnostics: true,
+    }),
+
+    viteTsConfigPaths({
+      root: '../../',
+    }),
+  ],
+
+  // Uncomment this if you are using workers.
+  // worker: {
+  //  plugins: [
+  //    viteTsConfigPaths({
+  //      root: '../../',
+  //    }),
+  //  ],
+  // },
+
+  // Configuration for building your library.
+  // See: https://vitejs.dev/guide/build.html#library-mode
+  build: {
+    lib: {
+      // Could also be a dictionary or array of multiple entry points.
+      entry: 'src/index.ts',
+      name: 'z80-assembler',
+      fileName: 'index',
+      // Change this to the formats you want to support.
+      // Don't forgot to update your package.json as well.
+      formats: ['es', 'cjs'],
+    },
+    rollupOptions: {
+      // External packages that should not be bundled into your library.
+      external: [],
+    },
+  },
+
+  test: {
+    globals: true,
+    cache: {
+      dir: '../../node_modules/.vitest',
+    },
+    environment: 'jsdom',
+    include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+  },
+});

package/nx.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "./node_modules/nx/schemas/nx-schema.json",
+  "affected": {
+    "defaultBase": "master"
+  },
+  "tasksRunnerOptions": {
+    "default": {
+      "runner": "nx/tasks-runners/default",
+      "options": {
+        "cacheableOperations": ["build", "lint", "test"]
+      }
+    }
+  },
+  "targetDefaults": {
+    "build": {
+      "dependsOn": ["^build"],
+      "inputs": ["production", "^production"]
+    },
+    "test": {
+      "inputs": ["default", "^production"]
+    },
+    "lint": {
+      "inputs": [
+        "default",
+        "{workspaceRoot}/.eslintrc.json",
+        "{workspaceRoot}/.eslintignore"
+      ]
+    }
+  },
+  "namedInputs": {
+    "default": ["{projectRoot}/**/*", "sharedGlobals"],
+    "production": [
+      "default",
+      "!{projectRoot}/**/?(*.)+(spec|test).[jt]s?(x)?(.snap)",
+      "!{projectRoot}/tsconfig.spec.json",
+      "!{projectRoot}/.eslintrc.json"
+    ],
+    "sharedGlobals": []
+  },
+  "generators": {
+    "@nx/react": {
+      "application": {
+        "style": "css",
+        "linter": "eslint",
+        "bundler": "vite",
+        "babel": true
+      },
+      "component": {
+        "style": "css"
+      },
+      "library": {
+        "style": "css",
+        "linter": "eslint"
+      }
+    }
+  }
+}

package/package.json

@@ -1,20 +1,58 @@
 {
   "name": "@andrivet/z80-assembler",
-  "version": "1.3.2",
-  "description": "A Z80 assembler entirely written in Typescript and derived from a PEG grammar.",
-  "author": "Sebastien Andrivet",
+  "version": "1.4.0",
   "license": "GPLv3",
-  "type": "commonjs",
-  "keywords": [
-    "z80",
-    "assembler",
-    "ZX81"
-  ],
-  "publishConfig": {
-    "access": "public"
+  "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"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/andrivet/z80-assembler"
+  "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"
   }
 }

package/tsconfig.base.json

@@ -0,0 +1,22 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "rootDir": ".",
+    "sourceMap": true,
+    "declaration": false,
+    "moduleResolution": "node",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "target": "es2015",
+    "module": "esnext",
+    "lib": ["es2020", "dom"],
+    "skipLibCheck": true,
+    "skipDefaultLibCheck": true,
+    "baseUrl": ".",
+    "paths": {
+      "@andrivet/z80-assembler": ["libs/z80-assembler/src/index.ts"]
+    }
+  },
+  "exclude": ["node_modules", "tmp"]
+}