Tate/npm (#180)

* switch to npm from yarn

* update examples on precommit

Author: tatethurston

.github/workflows/ci.yml

@@ -13,10 +13,10 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: "16.x"
-          cache: "yarn"
-      - run: yarn
-      - run: yarn lint
-      - run: yarn package:build
-      - run: yarn test:ci && yarn codecov --token=$CODECOV_TOKEN
+          cache: "npm"
+      - run: npm install
+      - run: npm run lint
+      - run: npm run package:build
+      - run: npm run test:ci && npx codecov --token=$CODECOV_TOKEN
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/publish.yml

@@ -10,9 +10,9 @@ jobs:
       - uses: actions/setup-node@v2
         with:
           node-version: "16.x"
-          cache: "yarn"
+          cache: "npm"
           registry-url: "https://registry.npmjs.org"
-      - run: yarn package:build
+      - run: npm run package:build
       - run: cd dist && npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,6 +1,6 @@
 **/dist/*
 !**/dist/index.html
-package-lock.json
 todo.txt
-node_modules
 coverage
+node_modules
+tsconfig.tsbuildinfo

.husky/pre-commit

@@ -1,4 +1,6 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn lint:fix --staged
+npm run package:build
+npm run examples:regen
+npm run lint:fix

CHANGELOG.md

@@ -55,7 +55,7 @@ throw new TwirpError({ code: "code", msg: "msg" });
 
 ## v0.0.56
 
-Users will need to `yarn twirpscript` to regenerate their `.pb.ts` / `.pb.js` files when adopting this version.
+Users will need to `npx twirpscript` to regenerate their `.pb.ts` / `.pb.js` files when adopting this version.
 
 - The generated message serializer/deserializer objects have been split into two separate objects: one for JSON and one for Protobuf. This enables smaller client bundles when using a bundler that supports tree shaking / dead code elimination. Many users will be unaffected by this change, but this is a breaking change for users that use message encode/decode methods directly in their source code.
 
@@ -234,7 +234,7 @@ Changes:
 
 ## v0.0.44
 
-This version has breaking changes between the generated code and the runtime. Run `yarn twrispcript` to update your generated `.pb.ts` when updating to this version.
+This version has breaking changes between the generated code and the runtime. Run `npx twrispcript` to update your generated `.pb.ts` when updating to this version.
 
 TwirpScript now ships with JSON serializers and supports the `json_name` option described [here](https://developers.google.com/protocol-buffers/docs/proto3#json). This enables clients to specify custom JSON field names.
 
@@ -256,7 +256,7 @@ Changes:
 ## v0.0.41
 
 - Breaking Change: field names are now camelCased by @tatethurston in https://github.com/tatethurston/TwirpScript/pull/97.
-  `yarn twirpscript` will regenerate your `.pb.ts` files with the correct casing. If you run into significant issues with this change or prefer snake_case, please open an issue.
+  `npx twirpscript` will regenerate your `.pb.ts` files with the correct casing. If you run into significant issues with this change or prefer snake_case, please open an issue.
 
 ## v0.0.40
 
@@ -305,7 +305,7 @@ Changes:
 
 This release includes breaking changes:
 
-1. The generated `.pb.ts` files have been restructured. You'll need to run `yarn twirpscript` to regenerate your `.pb.ts` files after updating.
+1. The generated `.pb.ts` files have been restructured. You'll need to run `npx twirpscript` to regenerate your `.pb.ts` files after updating.
 2. `context`'s `service` and `method` properties now point to generated objects instead of simply being strings (eg previously these were "Haberdasher" and "MakeHat" and now these properties point to generated objects. This enables more powerful runtime reflection, eg:
 
 ```

README.md

@@ -92,14 +92,14 @@ To learn more about the motivation behind Twirp (and a comparison to REST APIs a
    Or install from a [precompiled binary](https://github.com/protocolbuffers/protobuf/releases).
 
 1. Add this package to your project:
-   `yarn add twirpscript` or `npm install twirpscript`
+   `npm install twirpscript` or `yarn add twirpscript`
 
 ## Getting Started
 
 ### Overview 📖
 
 1. Define your service in a `.proto` file.
-2. Run `yarn twirpscript` to generate JavaScript or TypeScript code from your `.proto` file. This will generate JSON and Protobuf clients, a service interface, and service utilities.
+2. Run `npx twirpscript` to generate JavaScript or TypeScript code from your `.proto` file. This will generate JSON and Protobuf clients, a service interface, and service utilities.
 3. If you only need a client, you're done! Use the generated client to make requests to your server.
 4. Implement the generated service interface.
 5. Add your implemented service to your application server's routes.
@@ -132,11 +132,11 @@ message Hat {
 }
 ```
 
-#### 2. Run `yarn twirpscript`
+#### 2. Run `npx twirpscript`
 
 This will generate `haberdasher.pb.ts` (or `haberdasher.pb.js` for JavaScript users) in the same directory as as `haberdasher.proto`. Any comments will become [TSDoc](https://github.com/microsoft/tsdoc) comments and will show inline in supported editors.
 
-`yarn twirpscript` will compile all`.proto` files in your project.
+`npx twirpscript` will compile all`.proto` files in your project.
 
 #### 3. Use the client
 

examples/authentication/README.md

@@ -4,5 +4,5 @@
 
 ### Running Locally
 
-1. `yarn install`
-2. `yarn start`
+1. `npm install`
+2. `npm start`