package refactor (#37)

* package refactor

* exclude uint8array from nonnullable

.eslintrc.cjs

@@ -1,13 +1,17 @@
 // eslint-disable-next-line no-undef
 module.exports = {
   root: true,
-  ignorePatterns: ["dist", "examples", "e2e", "well-known-types"],
+  ignorePatterns: ["dist", "*.pb.ts", "*.pb.js"],
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+  },
+  env: {
+    browser: true,
+    node: true,
+  },
   plugins: ["@typescript-eslint"],
-  extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "prettier",
-  ],
+  extends: ["eslint:recommended", "prettier"],
   overrides: [
     {
       files: ["*.ts"],
@@ -18,6 +22,7 @@ module.exports = {
         project: ["./tsconfig.json"],
       },
       extends: [
+        "plugin:@typescript-eslint/recommended",
         "plugin:@typescript-eslint/recommended-requiring-type-checking",
       ],
       rules: {

.github/workflows/ci.yml

@@ -20,9 +20,9 @@ jobs:
           node-version-file: ".nvmrc"
           cache: "pnpm"
       - run: pnpm install --frozen-lockfile
-      - run: pnpm package:build
+      - run: (cd packages/protoscript && pnpm package:build)
       # run again to link bin that is now available after package:build
-      - run: pnpm install
+      - run: pnpm install --frozen-lockfile
       - run: pnpm lint
       - run: pnpm test:ci && pnpm codecov --token=$CODECOV_TOKEN
         env:

.github/workflows/publish.yml

@@ -14,7 +14,9 @@ jobs:
           cache: "pnpm"
           registry-url: "https://registry.npmjs.org"
       - run: pnpm install --frozen-lockfile
+      - run: cp README.md LICENSE CHANGELOG.md packages/protoscript
+      - run: cd packages/protoscript
       - run: pnpm package:build
-      - run: cd dist && npm publish
+      - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,6 +1,5 @@
 **/dist/*
-!**/dist/package.json
 coverage
 node_modules
 todo.txt
-well-known-types/**/*.pb.ts
+packages/well-known-types/**/*.pb.ts

.husky/pre-commit

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-pnpm run package:build
+(cd packages/protoscript && pnpm run package:build)
 pnpm run regen
 pnpm run lint:fix

DEVELOPMENT.md

@@ -43,7 +43,3 @@ As part of installation, husky pre-commit hooks are installed to run linters aga
 ### Publishing
 
 There are CI and publishing GitHub workflows in `./github/workflows`. These are named `ci.yml` and `publish.yml`.
-
-### Note
-
-`protoscript` package self referencing is used by the wellknowntypes. right now works in a surprising manner: the package is built into dist, but the source package.json has the same name as the package.json that will be generated into dist. This results in self referencing using the source directory when everything is built.

e2e/conformance/package.json

@@ -1,8 +1,10 @@
 {
   "name": "conformance",
+  "type": "module",
   "scripts": {
     "build": "esbuild runner.ts --bundle --platform=node --target=es2020 --outfile=dist/runner.cjs",
-    "conformance:build": "./bin/generate_conformance_test_runner.sh"
+    "conformance:build": "./bin/generate_conformance_test_runner.sh",
+    "typecheck": "tsc --noEmit"
   },
   "dependencies": {
     "protoscript": "workspace:*"

e2e/conformance/runner.ts

@@ -59,7 +59,7 @@ function test(request: ConformanceRequest): ConformanceResponse {
     } else if (request.jsonPayload) {
       testMessage = TestAllTypesProto3JSON.decode(request.jsonPayload);
     } else {
-      return { runtimeError: `${request} not supported` };
+      return { runtimeError: "request not supported" };
     }
   } catch (err) {
     // > This string should be set to indicate parsing failed.  The string can

e2e/conformance/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "dist"
+  },
+  "exclude": ["dist"]
+}

e2e/serialization/package.json

@@ -1,5 +1,9 @@
 {
   "name": "test-serialization",
+  "type": "module",
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
   "dependencies": {
     "protoscript": "workspace:*"
   }

e2e/serialization/test.ts

@@ -1,4 +1,3 @@
-import { describe, it } from "@jest/globals";
 import { Baz, Foo, FooJSON } from "./message.pb.js";
 
 const nestedMessage: Foo.FooBar = {

e2e/serialization/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "dist"
+  },
+  "exclude": ["dist"]
+}

e2e/treeshaking/TreeshakingTest.ts

@@ -1,3 +1,3 @@
-import { TreeshakingTest } from "./treeshaking.pb";
+import { TreeshakingTest } from "./treeshaking.pb.js";
 
 export default TreeshakingTest.initialize();

e2e/treeshaking/TreeshakingTestJSON.ts

@@ -1,3 +1,3 @@
-import { TreeshakingTestJSON } from "./treeshaking.pb";
+import { TreeshakingTestJSON } from "./treeshaking.pb.js";
 
 export default TreeshakingTestJSON.initialize();

e2e/treeshaking/package.json

@@ -1,8 +1,12 @@
 {
   "name": "test-serialization",
+  "type": "module",
   "dependencies": {
     "protoscript": "workspace:*"
   },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
   "devDependencies": {
     "esbuild": "^0.18.16"
   }

e2e/treeshaking/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "dist"
+  },
+  "exclude": ["dist"]
+}

examples/closure-compiler/package.json

@@ -1,5 +1,6 @@
 {
   "name": "js-example",
+  "type": "module",
   "main": "index.js",
   "license": "MIT",
   "scripts": {