Merge pull request #1 from rictic/ci

Format, lint, add github CI

.eslintignore

@@ -0,0 +1,6 @@
+/dist
+/.wireit
+/bench/bundles
+/vendor
+/examples
+/bench

.eslintrc.cjs

@@ -0,0 +1,23 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+  ],
+  rules: {
+    'no-constant-condition': 'off',
+    '@typescript-eslint/await-thenable': 'off',
+    '@typescript-eslint/no-floating-promises': 'off',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {argsIgnorePattern: '^_', varsIgnorePattern: '^_'},
+    ],
+  },
+};

.github/workflows/tests.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+
+    env:
+      WIREIT_LOGGER: 'quiet-ci'
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - run: npm ci
+      - run: npm test
+
+  lint-and-format:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run format:check

.gitignore

@@ -2,3 +2,4 @@
 /node_modules
 /.wireit
 /bench/bundles
+/.eslintcache

.prettierignore

@@ -0,0 +1,4 @@
+/dist
+/.wireit
+/bench/bundles
+/vendor

README.md

@@ -8,7 +8,7 @@ Usage:
 
 ```js
 // Full example at examples/fetch.js
-import { parse } from "jsonriver";
+import {parse} from 'jsonriver';
 
 const response = await fetch(`https://jsonplaceholder.typicode.com/posts`);
 const vals = parse(response.body);
@@ -22,7 +22,7 @@ for await (const val of vals) {
 What does it mean that we give you a sequence of increasingly complete values? Consider this JSON:
 
 ```json
-{"name":"Alex", "keys":[1,20,300]}
+{"name": "Alex", "keys": [1, 20, 300]}
 ```
 
 If you gave this to jsonriver one byte at a time it would yield this sequence of values:

bench/jsonparse.html

@@ -4,8 +4,8 @@
    * Copyright Google LLC
    * SPDX-License-Identifier: BSD-3-Clause
    */
-  import * as bench from "/bench.js";
-  import { smallJsonString } from "./data.js";
+  import * as bench from '/bench.js';
+  import {smallJsonString} from './data.js';
   bench.start();
   for (let i = 0; i < 100; i++) {
     await JSON.parse(smallJsonString);

bench/jsonriver.html

@@ -4,9 +4,9 @@
    * Copyright Google LLC
    * SPDX-License-Identifier: BSD-3-Clause
    */
-  import * as bench from "/bench.js";
-  import { smallJsonString } from "./data.js";
-  import { parse } from "./bundles/bundle.min.js";
+  import * as bench from '/bench.js';
+  import {smallJsonString} from './data.js';
+  import {parse} from './bundles/bundle.min.js';
   async function* toStream(str) {
     yield str;
   }

bench/node-bench.js

@@ -8,24 +8,24 @@
 // it depends on a bunch of Node built-ins and the like, so just doing a
 // simple microbenchmark here.
 
-import { streamJsonParser } from "./stream-json.js";
-import { parse } from "./bundles/bundle.min.js";
-import { parse as unoptimizedParse } from "./bundles/baseline.min.js";
-import * as fs from "node:fs";
-import * as path from "node:path";
+import {streamJsonParser} from './stream-json.js';
+import {parse} from './bundles/bundle.min.js';
+import {parse as unoptimizedParse} from './bundles/baseline.min.js';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 
-const dirname = new URL(".", import.meta.url).pathname;
+const dirname = new URL('.', import.meta.url).pathname;
 const smallJsonString = fs.readFileSync(
   path.join(dirname, `../vendor/testdata/small-file.json`),
-  { encoding: "utf-8" }
+  {encoding: 'utf-8'},
 );
 const mediumJsonString = fs.readFileSync(
   path.join(dirname, `../vendor/testdata/medium-file.json`),
-  { encoding: "utf-8" }
+  {encoding: 'utf-8'},
 );
 const largeJsonString = fs.readFileSync(
   path.join(dirname, `../vendor/testdata/large-file.json`),
-  { encoding: "utf-8" }
+  {encoding: 'utf-8'},
 );
 
 async function* toStream(str) {
@@ -48,19 +48,19 @@ async function jsonParseOld(jsonString) {
 
 const comparisons = [
   {
-    name: "jsonriver",
+    name: 'jsonriver',
     parse: jsonParse,
   },
   {
-    name: "jsonriver v0.1",
+    name: 'jsonriver v0.1',
     parse: jsonParseOld,
   },
   {
-    name: "stream-json",
+    name: 'stream-json',
     parse: streamJsonParser,
   },
   {
-    name: "JSON.parse",
+    name: 'JSON.parse',
     parse: JSON.parse,
   },
 ];
@@ -89,19 +89,19 @@ async function benchmarkFile(comparisons, str, name, numTimes) {
   console.log(`Parsing ${name} averaged over ${numTimes} runs`);
   for (let i = 0; i < comparisons.length; i++) {
     console.log(
-      `  ${comparisons[i].name.padEnd(15, " ")} ${mean(times[i])
+      `  ${comparisons[i].name.padEnd(15, ' ')} ${mean(times[i])
         .toFixed(3)
-        .padStart(10, " ")}ms ±${stdDev(times[i]).toFixed(2)}ms`
+        .padStart(10, ' ')}ms ±${stdDev(times[i]).toFixed(2)}ms`,
     );
   }
-  console.log("\n");
+  console.log('\n');
 }
 
-await benchmarkFile(comparisons, smallJsonString, "a small file (64KiB)", 100);
+await benchmarkFile(comparisons, smallJsonString, 'a small file (64KiB)', 100);
 await benchmarkFile(
   comparisons,
   mediumJsonString,
-  "a medium file (1.4MiB)",
-  100
+  'a medium file (1.4MiB)',
+  100,
 );
-await benchmarkFile(comparisons, largeJsonString, "a large file (25MiB)", 3);
+await benchmarkFile(comparisons, largeJsonString, 'a large file (25MiB)', 3);

bench/stream-json.js

@@ -4,12 +4,12 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-import * as nodeStream from "node:stream";
-import { createRequire } from "node:module";
+import * as nodeStream from 'node:stream';
+import {createRequire} from 'node:module';
 const require = createRequire(import.meta.url);
-const { chain } = require("stream-chain");
-const { parser } = require("stream-json");
-const Asm = require("stream-json/Assembler");
+const {chain} = require('stream-chain');
+const {parser} = require('stream-json');
+const Asm = require('stream-json/Assembler');
 
 export async function streamJsonParser(str) {
   // create a node stream with just str
@@ -21,6 +21,6 @@ export async function streamJsonParser(str) {
     resolve = r;
   });
   const asm = Asm.connectTo(chain([stream, parser()]));
-  asm.on("done", (asm) => resolve(asm.current));
+  asm.on('done', (asm) => resolve(asm.current));
   return promise;
 }

examples/fetch.js

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-import { parse } from "jsonriver";
+import {parse} from 'jsonriver';
 
 class Renderer {
   prevEnd = 0;
@@ -16,7 +16,7 @@ class Renderer {
         // We haven't gotten any of the title yet, skip it.
         continue;
       }
-      process.stdout.write(first ? "\r" : "\n");
+      process.stdout.write(first ? '\r' : '\n');
       process.stdout.write(`${post.id}: ${post.title}`);
       first = false;
       this.prevEnd = i;
@@ -36,7 +36,7 @@ for await (const posts of postsStream) {
   // first results immediately before the rest of the data has even arrived.
   renderer.render(posts);
 }
-process.stdout.write("\n");
+process.stdout.write('\n');
 
 async function* delay(stream) {
   for await (const chunk of stream) {