add exclude option to twirp.json (#127)

* add exclude option to twirp.json

fixes 113.

* Update README.md

Co-authored-by: Tate <[email protected]>

Author: tatethurston

README.md

@@ -586,17 +586,53 @@ TwirpScript aims to be zero config, but can be configured by creating a `.twirp.
   ```
  
   Setting `root` to `src`:
- 
-  A.proto would `import` B.proto as follows:
- 
-  ```protobuf
-  import "B.proto";
-  ```
- 
-  TypeScript projects will generally want to set this value to match their `rootDir`, particularly when using [Protocol Buffers Well-Known Types](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) so that the generated well-known type files are under the `rootDir`.
+
+// twirp.json
+
+```json
+{
+  "root": "src"
+}
+```
+
+A.proto would `import` B.proto as follows:
+
+```protobuf
+import "B.proto";
+```
+
+TypeScript projects will generally want to set this value to match their `rootDir`, particularly when using [Protocol Buffers Well-Known Types](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) so that the generated well-known type files are under the `rootDir`.
+
 </td>
 <td>string (filepath)</td>
 </tr>
+<tr>
+  <td>exclude</td>
+<td>
+   An array of patterns that should be skipped when searching for `.proto` files.
+  
+   Example:
+  
+   If we have the following project structure:
+   /src
+     /foo
+       A.proto
+     /bar
+       B.proto
+  
+   Setting `exclude` to `["/bar/"]`:
+  
+   // twirp.json
+   ```json
+   {
+     exclude: ["/bar/"]
+   }
+   ```
+  
+   Will only process A.proto (B.proto) will be excluded from TwirpScript's code generation.
+</td>
+  <td>string[] (RegExp pattern)</td>
+</tr>
 <tr>
   <td>dest</td>
 <td>
@@ -624,6 +660,13 @@ TwirpScript aims to be zero config, but can be configured by creating a `.twirp.
  
   Setting `dest` to `out` will generate the following:
  
+  // twirp.json
+  ```json
+  {
+    dest: 'out',
+  }
+  ```
+ 
   ```
   /src
     A.proto
@@ -637,6 +680,14 @@ TwirpScript aims to be zero config, but can be configured by creating a `.twirp.
   Note that the generated directory structure will mirror the `proto` paths exactly as is, only nested under the `dest` directory. If you want to change this, for instance, to omit `src` from the `out` directory above, you can set the `root`.
   
   Setting `root` to `src` (in addition to setting `dest` to `out`) will generate the following:
+ 
+  // twirp.json
+  ```json
+  {
+    root: 'src',
+    dest: 'out',
+  }
+  ```
   
   ```
   /src

examples/config-exclude/.twirp.json

@@ -0,0 +1,3 @@
+{
+  "exclude": ["/bar/"]
+}

examples/config-exclude/README.md

@@ -0,0 +1,8 @@
+# TwirpScript Config Exclude Example
+
+## Getting Started
+
+### Running Locally
+
+1. `yarn install`
+2. `yarn build`

examples/config-exclude/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "config-exclude",
+  "scripts": {
+    "build": "yarn twirpscript && yarn tsc"
+  },
+  "dependencies": {
+    "twirpscript": "*"
+  },
+  "devDependencies": {
+    "typescript": "^4.3.5"
+  }
+}

examples/config-exclude/src/bar/B.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+import "A.proto";
+
+message Bar {
+  Foo foo = 1;
+}

examples/config-exclude/src/foo/A.pb.ts

@@ -0,0 +1,111 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+// Source: src/foo/A.proto
+
+import type { ByteSource } from "twirpscript";
+import { BinaryReader, BinaryWriter } from "twirpscript";
+
+//========================================//
+//                 Types                  //
+//========================================//
+
+export interface Foo {
+  name: string;
+}
+
+//========================================//
+//        Protobuf Encode / Decode        //
+//========================================//
+
+export const Foo = {
+  /**
+   * Serializes a Foo to protobuf.
+   */
+  encode: function (foo: Partial<Foo>): Uint8Array {
+    return Foo._writeMessage(foo, new BinaryWriter()).getResultBuffer();
+  },
+
+  /**
+   * Deserializes a Foo from protobuf.
+   */
+  decode: function (bytes: ByteSource): Foo {
+    return Foo._readMessage(Foo.initialize(), new BinaryReader(bytes));
+  },
+
+  /**
+   * Serializes a Foo to JSON.
+   */
+  encodeJSON: function (foo: Partial<Foo>): string {
+    return JSON.stringify(Foo._writeMessageJSON(foo));
+  },
+
+  /**
+   * Deserializes a Foo from JSON.
+   */
+  decodeJSON: function (json: string): Foo {
+    return Foo._readMessageJSON(Foo.initialize(), JSON.parse(json));
+  },
+
+  /**
+   * Initializes a Foo with all fields set to their default value.
+   */
+  initialize: function (): Foo {
+    return {
+      name: "",
+    };
+  },
+
+  /**
+   * @private
+   */
+  _writeMessage: function (
+    msg: Partial<Foo>,
+    writer: BinaryWriter
+  ): BinaryWriter {
+    if (msg.name) {
+      writer.writeString(1, msg.name);
+    }
+    return writer;
+  },
+
+  /**
+   * @private
+   */
+  _writeMessageJSON: function (msg: Partial<Foo>): Record<string, unknown> {
+    const json: Record<string, unknown> = {};
+    if (msg.name) {
+      json.name = msg.name;
+    }
+    return json;
+  },
+
+  /**
+   * @private
+   */
+  _readMessage: function (msg: Foo, reader: BinaryReader): Foo {
+    while (reader.nextField()) {
+      const field = reader.getFieldNumber();
+      switch (field) {
+        case 1: {
+          msg.name = reader.readString();
+          break;
+        }
+        default: {
+          reader.skipField();
+          break;
+        }
+      }
+    }
+    return msg;
+  },
+
+  /**
+   * @private
+   */
+  _readMessageJSON: function (msg: Foo, json: any): Foo {
+    const name = json.name ?? json.name;
+    if (name) {
+      msg.name = name;
+    }
+    return msg;
+  },
+};

examples/config-exclude/src/foo/A.proto

@@ -0,0 +1,5 @@
+syntax = "proto3";
+
+message Foo {
+  string name = 1;
+}

examples/config-exclude/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "Node",
+    "noEmitOnError": false,
+    "noUnusedLocals": true,
+    "outDir": "dist",
+    "rootDir": ".",
+    "strict": true,
+    "target": "ES2019"
+  },
+  "include": ["src", "out"]
+}