All javascript, no typescript

platypii · platypii · commit 04bfd474b88c · 2024-01-04T11:11:00.000-08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,6 +9,6 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: npm i
-      - run: npm run build
       - run: npm run lint
+      - run: npm run typecheck
       - run: npm test
diff --git a/index.html b/index.html
@@ -31,7 +31,7 @@
   <body>
     <div id="dropzone">Drop .parquet file here</div>
     <script type="module">
-      import { parquetMetadata, toJson } from './dist/metadata.js'
+      import { parquetMetadata, toJson } from './src/metadata.js'
 
       const dropZone = document.getElementById('dropzone')
 
diff --git a/package.json b/package.json
@@ -11,18 +11,18 @@
     "type": "git",
     "url": "https://github.com/hyparam/hyparquet"
   },
-  "main": "dist/hyparquet.js",
+  "main": "src/hyparquet.js",
   "files": [
-    "dist"
+    "src"
   ],
   "type": "module",
-  "types": "dist/hyparquet.d.ts",
+  "types": "src/hyparquet.d.ts",
   "scripts": {
-    "build": "tsc && cp src/*.js dist",
     "coverage": "vitest run --coverage",
     "demo": "http-server -o",
-    "lint": "eslint . --ext .ts,.js",
-    "test": "vitest run"
+    "lint": "eslint .",
+    "test": "vitest run",
+    "typecheck": "tsc"
   },
   "devDependencies": {
     "@types/node": "20.10.6",
diff --git a/src/hyparquet.d.ts b/src/hyparquet.d.ts
@@ -0,0 +1,17 @@
+/**
+ * Read parquet data rows from a file
+ *
+ * @param {ArrayBuffer} arrayBuffer parquet file contents
+ * @returns {any[][]} row data
+ */
+export function parquetRead(arrayBuffer: ArrayBuffer): any[][]
+
+
+/**
+ * Read parquet header, metadata, and schema information from a file
+ *
+ * @typedef {import("./hyparquet.js").FileMetaData} FileMetaData
+ * @param {ArrayBuffer} arrayBuffer parquet file contents
+ * @returns {FileMetaData} metadata object
+ */
+export function parquetMetadata(arrayBuffer: ArrayBuffer): any
diff --git a/src/hyparquet.js b/src/hyparquet.js
@@ -1,12 +1,13 @@
 import { parquetMetadata } from './metadata.js'
+export { parquetMetadata }
 
 /**
  * Read parquet data rows from a file
  *
  * @param {ArrayBuffer} arrayBuffer parquet file contents
  * @returns {any[][]} row data
  */
-export function parquetRead(arrayBuffer: ArrayBuffer): any[][] {
+export function parquetRead(arrayBuffer) {
   const metadata = parquetMetadata(arrayBuffer)
   throw new Error('not implemented')
 }
diff --git a/src/metadata.js b/src/metadata.js
@@ -3,7 +3,7 @@ import { deserializeTCompactProtocol } from './thrift.js'
 /**
  * Read parquet header, metadata, and schema information from a file
  *
- * @typedef {import("./types.js").FileMetaData} FileMetaData
+ * @typedef {import("./types.d.ts").FileMetaData} FileMetaData
  * @param {ArrayBuffer} arrayBuffer parquet file contents
  * @returns {FileMetaData} metadata object
  */
diff --git a/src/thrift.js b/src/thrift.js
@@ -19,7 +19,7 @@ const CompactType = {
 /**
  * Parse TCompactProtocol
  *
- * @typedef {import("./types.js").Decoded<T>} Decoded
+ * @typedef {import("./types.d.ts").Decoded<T>} Decoded
  * @template T
  * @param {ArrayBuffer} arrayBuffer
  * @returns {Decoded<Record<string, any>>}
diff --git a/test/metadata.test.js b/test/metadata.test.js
@@ -1,6 +1,6 @@
 import { promises as fs } from 'fs'
 import { describe, expect, it } from 'vitest'
-import { parquetMetadata, toJson } from '../src/metadata'
+import { parquetMetadata, toJson } from '../src/metadata.js'
 
 /**
  * Helper function to read .parquet file into ArrayBuffer
diff --git a/test/snappy.test.js b/test/snappy.test.js
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { snappyUncompress } from '../src/snappy'
+import { snappyUncompress } from '../src/snappy.js'
 
 describe('snappy uncompress', () => {
   it('decompresses valid input correctly', () => {
diff --git a/test/thrift.test.js b/test/thrift.test.js
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { deserializeTCompactProtocol, toVarInt } from '../src/thrift'
+import { deserializeTCompactProtocol, toVarInt } from '../src/thrift.js'
 
 describe('deserializeTCompactProtocol function', () => {
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -4,11 +4,11 @@
     "checkJs": true,
     "lib": ["esnext", "dom"],
     "module": "nodenext",
-    "outDir": "dist",
+    "noEmit": true,
+    "resolveJsonModule": true,
     "skipLibCheck": true,
-    "sourceMap": true,
     "strict": true,
     "target": "esnext",
   },
-  "include": ["src"]
+  "include": ["src", "test"]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,13 @@`
`1`	`1`	`import { parquetMetadata } from './metadata.js'`
	`2`	`+export { parquetMetadata }`
`2`	`3`
`3`	`4`	`/**`
`4`	`5`	`* Read parquet data rows from a file`
`5`	`6`	`*`
`6`	`7`	`* @param {ArrayBuffer} arrayBuffer parquet file contents`
`7`	`8`	`* @returns {any[][]} row data`
`8`	`9`	`*/`
`9`		`-export function parquetRead(arrayBuffer: ArrayBuffer): any[][] {`
	`10`	`+export function parquetRead(arrayBuffer) {`
`10`	`11`	`const metadata = parquetMetadata(arrayBuffer)`
`11`	`12`	`throw new Error('not implemented')`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import { deserializeTCompactProtocol } from './thrift.js'`
`3`	`3`	`/**`
`4`	`4`	`* Read parquet header, metadata, and schema information from a file`
`5`	`5`	`*`
`6`		`- * @typedef {import("./types.js").FileMetaData} FileMetaData`
	`6`	`+ * @typedef {import("./types.d.ts").FileMetaData} FileMetaData`
`7`	`7`	`* @param {ArrayBuffer} arrayBuffer parquet file contents`
`8`	`8`	`* @returns {FileMetaData} metadata object`
`9`	`9`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ const CompactType = {`
`19`	`19`	`/**`
`20`	`20`	`* Parse TCompactProtocol`
`21`	`21`	`*`
`22`		`- * @typedef {import("./types.js").Decoded<T>} Decoded`
	`22`	`+ * @typedef {import("./types.d.ts").Decoded<T>} Decoded`
`23`	`23`	`* @template T`
`24`	`24`	`* @param {ArrayBuffer} arrayBuffer`
`25`	`25`	`* @returns {Decoded<Record<string, any>>}`