skir 0.0.1 → 0.0.2

package/src/project_initializer.ts

@@ -0,0 +1,39 @@
+import * as fs from "fs";
+import * as paths from "path";
+
+export function initializeProject(rootDir: string): void {
+  const skirYmlPath = paths.join(rootDir, "skir.yml");
+
+  // Check if skir.yml already exists
+  if (fs.existsSync(skirYmlPath)) {
+    console.log(
+      "A skir.yml file already exists in this directory. Skipping project initialization.",
+    );
+    return;
+  }
+
+  // Create skir.yml file
+  fs.writeFileSync(skirYmlPath, SKIR_YML_CONTENT, "utf-8");
+
+  // Check if skir-src directory exists
+  const skirSrcDir = paths.join(rootDir, "skir-src");
+  if (!fs.existsSync(skirSrcDir)) {
+    // Create skir-src directory
+    fs.mkdirSync(skirSrcDir, { recursive: true });
+
+    // Create hello_world.skir file
+    const helloWorldPath = paths.join(skirSrcDir, "hello_world.skir");
+    fs.writeFileSync(helloWorldPath, HELLO_WORLD_SKIR_CONTENT, "utf-8");
+  }
+
+  console.log(`Done. Please edit: ${paths.resolve(skirYmlPath)}`);
+}
+
+const SKIR_YML_CONTENT = `srcDir: skir-src
+`;
+
+const HELLO_WORLD_SKIR_CONTENT = `struct Point {
+  x: int32;
+  y: int32;
+}
+`;

package/src/snapshotter.ts

@@ -3,6 +3,7 @@ import { join } from "node:path";
 import { checkBackwardCompatibility } from "./compatibility_checker.js";
 import {
   formatError,
+  makeGreen,
   makeRed,
   renderBreakingChanges,
   renderErrors,
@@ -42,8 +43,9 @@ export async function takeSnapshot(args: {
     });
     process.exit(1);
   }
-  const newSnapshot = makeSnapshot(newModuleSet, new Date());
-  if (sameModules(newSnapshot, makeSnapshot(oldModuleSet, new Date()))) {
+  const now = new Date();
+  const newSnapshot = makeSnapshot(newModuleSet, now);
+  if (sameModules(newSnapshot, makeSnapshot(oldModuleSet, now))) {
     console.log("No changes detected since last snapshot.");
     return;
   }
@@ -51,7 +53,7 @@ export async function takeSnapshot(args: {
     console.error(
       makeRed(
         `Modules have changed since the last snapshot. ` +
-          `Run the command without --check to take a new snapshot.`,
+          `Run the command without 'check' to take a new snapshot.`,
       ),
     );
     process.exit(1);
@@ -110,20 +112,58 @@ async function readLastSnapshot(snapshotPath: string): Promise<
   return moduleSet;
 }
 
+export async function viewSnapshot(args: { rootDir: string }): Promise<void> {
+  const snapshotPath = join(args.rootDir, "skir-snapshot.json");
+  let snapshot: Snapshot;
+  try {
+    const textContent = await readFile(snapshotPath, "utf-8");
+    snapshot = JSON.parse(textContent);
+  } catch (error) {
+    if (error instanceof SyntaxError) {
+      console.error(makeRed(`Corrupted snapshot file: ${snapshotPath}`));
+      console.error(`Error: ${error.toString()}`);
+      process.exit(1);
+    }
+    const isNotFoundError =
+      error instanceof Error && "code" in error && error.code === "ENOENT";
+    if (isNotFoundError) {
+      console.log("No snapshot found.");
+      return;
+    } else {
+      // Rethrow I/O error
+      throw error;
+    }
+  }
+
+  console.log(`Last snapshot: ${snapshot.lastChange}\n`);
+
+  const modulePaths = Object.keys(snapshot.modules).sort();
+  for (const path of modulePaths) {
+    console.log(makeGreen("-".repeat(80)));
+    console.log(makeGreen(path));
+    console.log(makeGreen("-".repeat(80)));
+    console.log();
+    const sourceCode = snapshot.modules[path]!;
+    console.log(sourceCode);
+    console.log();
+  }
+}
+
 function makeSnapshot(moduleSet: ModuleSet, now: Date): Snapshot {
   const modules: { [path: string]: string } = {};
   for (const module of moduleSet.resolvedModules) {
     modules[module.path] = module.sourceCode;
   }
   return {
+    readMe: "DO NOT EDIT. To update, run: npx skir snapshot",
     lastChange: now.toISOString(),
-    modules: modules,
+    modules,
   };
 }
 
 function sameModules(a: Snapshot, b: Snapshot): boolean {
   return (
-    Object.keys(a.modules).length === Object.keys(b.modules).length ||
+    Object.keys(a.modules).length === Object.keys(b.modules).length &&
     Object.entries(a.modules).every(([path, sourceCode]) => {
       return sourceCode === b.modules[path];
     })
@@ -131,6 +171,7 @@ function sameModules(a: Snapshot, b: Snapshot): boolean {
 }
 
 interface Snapshot {
+  readMe: string;
   lastChange: string;
   modules: { [path: string]: string };
 }

package/src/tokenizer.ts

@@ -1,16 +1,30 @@
-import { unquoteAndUnescape } from "./literals.js";
-import type { CodeLine, ErrorSink, Result, SkirError, Token } from "./types.js";
+import {
+  unquoteAndUnescape,
+  type CodeLine,
+  type ErrorSink,
+  type Result,
+  type SkirError,
+  type Token,
+} from "skir-internal";
+
+export interface ModuleTokens {
+  /// Includes regular comments and doc comments.
+  readonly tokens: readonly Token[];
+  /// Includes both kinds of comments.
+  readonly tokensWithComments: readonly Token[];
+  readonly sourceCode: string;
+  readonly modulePath: string;
+}
 
 /** Tokenizes the given module. */
 export function tokenizeModule(
-  code: string,
+  sourceCode: string,
   modulePath: string,
-  keepComments?: "keep-comments",
-): Result<Token[]> {
+): Result<ModuleTokens> {
   const tokens: Token[] = [];
   const errors: SkirError[] = [];
 
-  const lines = new Lines(code, modulePath);
+  const lines = new Lines(sourceCode, modulePath);
 
   // Multiline comment:            \/\*([^*]|\*[^\/])*(\*\/)?
   // Single-line comment:          \/\/[^\n\r]*
@@ -28,7 +42,7 @@ export function tokenizeModule(
 
   let group: RegExpExecArray | null;
   let expectedPosition = 0;
-  while ((group = re.exec(code)) !== null) {
+  while ((group = re.exec(sourceCode)) !== null) {
     const position = re.lastIndex - group[0].length;
 
     // Check that all the regex matches are consecutive.
@@ -37,9 +51,11 @@ export function tokenizeModule(
     if (position !== expectedPosition) {
       const line = lines.advancePosition(expectedPosition);
       const colNumber = expectedPosition - line.position;
+      const text = sourceCode.substring(expectedPosition, position);
       errors.push({
         token: {
-          text: code.substring(expectedPosition, position),
+          text: text,
+          originalText: text,
           position: expectedPosition,
           line: line,
           colNumber: colNumber,
@@ -51,28 +67,19 @@ export function tokenizeModule(
 
     const line = lines.advancePosition(position);
     const colNumber = position - line.position;
-    const token = {
+    const token: Token = {
       text: group[0],
+      originalText: group[0],
       position: position,
       line: line,
       colNumber: colNumber,
     };
 
-    // Skip multiline comments.
-    if (group[1] !== undefined && !keepComments) {
-      // Make sure the multiline comment is terminated.
-      if (!group[1].endsWith("*/")) {
-        errors.push({
-          token: token,
-          message: "Unterminated multi-line comment",
-        });
-      }
-      continue;
-    }
-
-    // Skip single-line comments.
-    if (group[4] !== undefined && !keepComments) {
-      continue;
+    if (group[1] !== undefined && !group[1].endsWith("*/")) {
+      errors.push({
+        token: token,
+        message: "Unterminated multi-line comment",
+      });
     }
 
     if (group[8] !== undefined) {
@@ -126,7 +133,15 @@ export function tokenizeModule(
     }
   }
 
-  return { result: tokens, errors: errors };
+  return {
+    result: {
+      tokens: tokens.filter((t) => !isRegularComment(t.originalText)),
+      tokensWithComments: tokens,
+      sourceCode: sourceCode,
+      modulePath: modulePath,
+    },
+    errors: errors,
+  };
 }
 
 function validateWord(token: Token, errors: ErrorSink): boolean {
@@ -173,6 +188,13 @@ function validateWord(token: Token, errors: ErrorSink): boolean {
   return true;
 }
 
+function isRegularComment(token: string): boolean {
+  return (
+    token.startsWith("/*") ||
+    (token.startsWith("//") && !token.startsWith("///"))
+  );
+}
+
 class Lines {
   /** Splits the given code into multiple lines. */
   constructor(code: string, modulePath: string) {

package/dist/encoding.d.ts

@@ -1,2 +0,0 @@
-export declare function encodeInt32(i: number): Uint8Array;
-//# sourceMappingURL=encoding.d.ts.map

package/dist/encoding.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../src/encoding.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU,CA+BjD"}

package/dist/encoding.js

@@ -1,38 +0,0 @@
-export function encodeInt32(i) {
-    const buffer = new ArrayBuffer(5);
-    const dataView = new DataView(buffer);
-    let n;
-    if (i < 0) {
-        if (i >= -256) {
-            dataView.setUint8(0, 235);
-            dataView.setUint8(1, i + 256);
-            n = 2;
-        }
-        else if (i >= -65536) {
-            dataView.setUint8(0, 236);
-            dataView.setUint16(1, i + 65536, true);
-            n = 3;
-        }
-        else {
-            dataView.setUint8(0, 237);
-            dataView.setInt32(1, i, true);
-            n = 5;
-        }
-    }
-    else if (i < 232) {
-        dataView.setUint8(0, i);
-        n = 1;
-    }
-    else if (i < 65536) {
-        dataView.setUint8(0, 232);
-        dataView.setUint16(1, i, true);
-        n = 3;
-    }
-    else {
-        dataView.setUint8(0, 233);
-        dataView.setInt32(1, i, true);
-        n = 5;
-    }
-    return new Uint8Array(buffer, 0, n);
-}
-//# sourceMappingURL=encoding.js.map

package/dist/encoding.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"encoding.js","sourceRoot":"","sources":["../src/encoding.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,WAAW,CAAC,CAAS;IACnC,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,CAAS,CAAC;IACd,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACV,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1B,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC;YAC9B,CAAC,GAAG,CAAC,CAAC;QACR,CAAC;aAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACvB,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1B,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC;YACvC,CAAC,GAAG,CAAC,CAAC;QACR,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1B,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YAC9B,CAAC,GAAG,CAAC,CAAC;QACR,CAAC;IACH,CAAC;SAAM,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACnB,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxB,CAAC,GAAG,CAAC,CAAC;IACR,CAAC;SAAM,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC;QACrB,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC1B,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAC/B,CAAC,GAAG,CAAC,CAAC;IACR,CAAC;SAAM,CAAC;QACN,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC1B,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC,GAAG,CAAC,CAAC;IACR,CAAC;IACD,OAAO,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AACtC,CAAC"}

package/dist/encoding.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=encoding.test.d.ts.map

package/dist/encoding.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"encoding.test.d.ts","sourceRoot":"","sources":["../src/encoding.test.ts"],"names":[],"mappings":""}

package/dist/encoding.test.js

@@ -1,23 +0,0 @@
-import { expect } from "buckwheat";
-import { describe, it } from "mocha";
-import { encodeInt32 } from "./encoding.js";
-function toHexString(a) {
-    return [...a].map((x) => x.toString(16).padStart(2, "0")).join("");
-}
-describe("encoding", () => {
-    it("encodeInt32 works", () => {
-        expect(toHexString(encodeInt32(4))).toMatch("04");
-        expect(toHexString(encodeInt32(231))).toMatch("e7");
-        expect(toHexString(encodeInt32(232))).toMatch("e8e800");
-        expect(toHexString(encodeInt32(65535))).toMatch("e8ffff");
-        expect(toHexString(encodeInt32(65536))).toMatch("e900000100");
-        expect(toHexString(encodeInt32(2147483647))).toMatch("e9ffffff7f");
-        expect(toHexString(encodeInt32(-255))).toMatch("eb01");
-        expect(toHexString(encodeInt32(-256))).toMatch("eb00");
-        expect(toHexString(encodeInt32(-257))).toMatch("ecfffe");
-        expect(toHexString(encodeInt32(-65536))).toMatch("ec0000");
-        expect(toHexString(encodeInt32(-65537))).toMatch("edfffffeff");
-        expect(toHexString(encodeInt32(-2147483648))).toMatch("ed00000080");
-    });
-});
-//# sourceMappingURL=encoding.test.js.map

package/dist/encoding.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"encoding.test.js","sourceRoot":"","sources":["../src/encoding.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,SAAS,WAAW,CAAC,CAAa;IAChC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACrE,CAAC;AAED,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC3B,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACxD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC9D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACnE,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzD,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC/D,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -1,14 +0,0 @@
-import { expect } from "buckwheat";
-import { describe, it } from "mocha";
-import * as exports from "./index.js";
-describe("index.ts", () => {
-    it("exports the right symbols", () => {
-        // The actual logic is covered in other unit tests.
-        // Here we just want to make sure the right symbols are exported.
-        let _;
-        expect(exports.convertCase("foo", "lowerCamel", "UPPER_UNDERSCORE")).toBe("FOO");
-        expect(exports.capitalize("foo")).toBe("Foo");
-        expect(exports.unquoteAndUnescape('"foo"')).toBe("foo");
-    });
-});
-//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC;AACrC,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AAEtC,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,mDAAmD;QACnD,iEAAiE;QACjE,IAAI,CAAiB,CAAC;QACtB,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAI,CACvE,KAAK,CACN,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}