Changed generator version numbers (#342)

* Changed generator version numbers * Use quiet mode off * Trying github actions change * Debug the check markdown links github action * fix typos * fix typos * Apostrophe * troubleshoot github action markdown files * fix images * Links updated * fix image links * doc revisions * update jest tests * prettier-ignore statements * more prettier fixes * / * add file path to config for markdown links * working on it * update test * prettier ignore * check all markdown * fix readme links * fix links last time? * remove /
fern-api · Jul 6, 2022 · bde7779 · bde7779
1 parent 58d7207
commit bde7779
Show file tree

Hide file tree

Showing 45 changed files with 1,168 additions and 271 deletions.
diff --git a/.github/workflows/action.yml b/.github/workflows/action.yml
@@ -1,16 +1,11 @@
-# Danny trying this out! July 4, 2022
-
 name: Check Markdown links
 
 on: push
 
+# prettier-ignore
 jobs:
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
-      - uses: gaurav-nelson/github-action-markdown-link-check@v1
-        with:
-          folder-path: "docs"
-          use-quiet-mode: "yes"
-          # config-file: "mlc_config.json"
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.yarn/cache/@jest-core-npm-28.1.2-d632a1ee2e-dd67cc911c.zip b/.yarn/cache/@jest-core-npm-28.1.2-d632a1ee2e-dd67cc911c.zip
diff --git a/.yarn/cache/@jest-environment-npm-28.1.2-5ba92d7c1b-5bffc464e9.zip b/.yarn/cache/@jest-environment-npm-28.1.2-5ba92d7c1b-5bffc464e9.zip
diff --git a/.yarn/cache/@jest-expect-npm-28.1.2-c1ba663cb5-ee470cdd3a.zip b/.yarn/cache/@jest-expect-npm-28.1.2-c1ba663cb5-ee470cdd3a.zip
diff --git a/.yarn/cache/@jest-fake-timers-npm-28.1.2-708e436e77-d6e6b1a12f.zip b/.yarn/cache/@jest-fake-timers-npm-28.1.2-708e436e77-d6e6b1a12f.zip
diff --git a/.yarn/cache/@jest-globals-npm-28.1.2-a3b0bd62de-f07b7d0a2d.zip b/.yarn/cache/@jest-globals-npm-28.1.2-a3b0bd62de-f07b7d0a2d.zip
diff --git a/.yarn/cache/@jest-reporters-npm-28.1.2-8a0dea0c1e-26aa66e8ea.zip b/.yarn/cache/@jest-reporters-npm-28.1.2-8a0dea0c1e-26aa66e8ea.zip
diff --git a/.yarn/cache/@jest-source-map-npm-28.1.2-c3d608514f-b82a5c2e93.zip b/.yarn/cache/@jest-source-map-npm-28.1.2-c3d608514f-b82a5c2e93.zip
diff --git a/.yarn/cache/@jest-transform-npm-28.1.2-6f3b28178a-cd8d1bdf1a.zip b/.yarn/cache/@jest-transform-npm-28.1.2-6f3b28178a-cd8d1bdf1a.zip
diff --git a/.yarn/cache/@jridgewell-trace-mapping-npm-0.3.14-c78fcccfdf-b9537b9630.zip b/.yarn/cache/@jridgewell-trace-mapping-npm-0.3.14-c78fcccfdf-b9537b9630.zip
diff --git a/.yarn/cache/babel-jest-npm-28.1.2-9fe49235c4-1aa605ef4d.zip b/.yarn/cache/babel-jest-npm-28.1.2-9fe49235c4-1aa605ef4d.zip
diff --git a/.yarn/cache/jest-circus-npm-28.1.2-7f50bea781-c8f2e024e4.zip b/.yarn/cache/jest-circus-npm-28.1.2-7f50bea781-c8f2e024e4.zip
diff --git a/.yarn/cache/jest-cli-npm-28.1.2-cbf6c8906a-527873c257.zip b/.yarn/cache/jest-cli-npm-28.1.2-cbf6c8906a-527873c257.zip
diff --git a/.yarn/cache/jest-config-npm-28.1.2-56df4d8edb-ddc4de7a28.zip b/.yarn/cache/jest-config-npm-28.1.2-56df4d8edb-ddc4de7a28.zip
diff --git a/.yarn/cache/jest-environment-node-npm-28.1.2-a3cfa6adac-cee61a3e25.zip b/.yarn/cache/jest-environment-node-npm-28.1.2-a3cfa6adac-cee61a3e25.zip
diff --git a/.yarn/cache/jest-npm-28.1.2-0cb80d72d4-8ad37088c4.zip b/.yarn/cache/jest-npm-28.1.2-0cb80d72d4-8ad37088c4.zip
diff --git a/.yarn/cache/jest-resolve-dependencies-npm-28.1.2-3bd416d27e-2f822678b5.zip b/.yarn/cache/jest-resolve-dependencies-npm-28.1.2-3bd416d27e-2f822678b5.zip
diff --git a/.yarn/cache/jest-runner-npm-28.1.2-f1340306c4-51e46779e6.zip b/.yarn/cache/jest-runner-npm-28.1.2-f1340306c4-51e46779e6.zip
diff --git a/.yarn/cache/jest-runtime-npm-28.1.2-ae8fb2675f-d9a2f45a7b.zip b/.yarn/cache/jest-runtime-npm-28.1.2-ae8fb2675f-d9a2f45a7b.zip
diff --git a/.yarn/cache/jest-snapshot-npm-28.1.2-c457ca7d89-5c33c8b05d.zip b/.yarn/cache/jest-snapshot-npm-28.1.2-c457ca7d89-5c33c8b05d.zip
diff --git a/.yarn/cache/v8-to-istanbul-npm-9.0.1-58bbce7857-a49c34bf0a.zip b/.yarn/cache/v8-to-istanbul-npm-9.0.1-58bbce7857-a49c34bf0a.zip
diff --git a/docs/README.md b/docs/README.md
@@ -8,7 +8,7 @@
 
 Fern reads in your [Fern API Definition](#what-is-a-fern-api-definition), invokes remote [generators](#what-are-fern-generators), and creates clients, server stubs, and interactive documentation for your API.
 
-- **Client libraries**: one generated SDK for each supported platform and language that's automatically published to a registry (e.g., npm, maven, pypi)!
+- **Client libraries**: one generated SDK for each supported platform and language that's automatically published to a registry (e.g., NPM, Maven, PyPI)!
 
 - **Servers**: get server stubs for your API so all you need to do is implement the server logic.
 
@@ -22,20 +22,20 @@ Write your [Fern API Definition](#what-is-a-fern-api-definition) before writing
 
 ### 2. Best-in-class code generation
 
-Ferrari makes luxury sports cars. Fern generates kick-ass code. It is designed to optimize for high quality code generation. Generated code is **idiomatic** (i.e., it follows the convention of the language) and **strongly typed** (i.e., the types of variables and objects are explicitly specified).
+Ferrari makes luxury sports cars. Fern generates kick-ass code. It is designed to optimize for high-quality code generation. Generated code is **idiomatic** (i.e., it follows the convention of the language) and **strongly typed** (i.e., the types of variables and objects are explicitly specified).
 
 ### 3. Iterate faster
 
 With an API definition, development projects that involve multiple engineers/teams (e.g., backend, web, mobile) can proceed much faster. Frontend teams can immediately start building components regardless of whether or not the backend is ready.
 
 ## What is a Fern API Definition?
 
-A [**Fern API Definition**](definition.md) is a set of YAML files that describe your API.
+A [**Fern API Definition**](markdown_files/definition.md#what-is-a-fern-api-definition) is a set of YAML files that describe your API.
 
 ## What are Fern Generators?
 
-[**Generators**](generators.md) convert a Fern API Definition into clients, servers, and documentation.
+[**Generators**](markdown_files/generators.md) convert a Fern API Definition into clients, servers, and documentation.
 
 ## How is this different than OpenAPI?
 
-Fern is optimized for [kick-ass codegen](faq.md#1-how-is-fern-different-than-openapi-fka-swagger).
+Fern is optimized for [kick-ass codegen](markdown_files/faq.md#_1-how-is-fern-different-than-openapi-fka-swagger).
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -2,20 +2,15 @@
 
 - Getting started
 
-  - [Tutorial: IMDb](imdb.md)
-  - [CLI](cli.md)
+  - [Tutorial: IMDb](markdown_files/imdb.md)
+  - [CLI](markdown_files/cli.md)
 
 - Concepts
 
-  - [Fern API Definition](definition.md)
-  - [Generators](generators.md)
-  - [Types](types.md)
-  - [Services](services.md)
-  - [Errors](errors.md)
-  - [IDs](ids.md)
-  - [Imports](imports.md)
+  - [Fern API Definition](markdown_files/definition.md)
+  - [Generators](markdown_files/generators.md)
 
 - Reference
-
-  - [FAQs](faq.md)
+  p
+  - [FAQs](markdown_files/faq.md)
   - [Join the Discord](https://discord.gg/JkkXumPzcG)
diff --git a/docs/assets/postman-testing.png b/docs/assets/postman-testing.png
diff --git a/docs/assets/server.ts error message.png b/docs/assets/server.ts error message.png
diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/channels.md → docs/markdown_files/channels.md b/docs/channels.md → docs/markdown_files/channels.md
diff --git a/docs/cli.md → docs/markdown_files/cli.md b/docs/cli.md → docs/markdown_files/cli.md
diff --git a/docs/definition.md → docs/markdown_files/definition.md b/docs/definition.md → docs/markdown_files/definition.md
diff --git a/docs/errors.md → docs/markdown_files/errors.md b/docs/errors.md → docs/markdown_files/errors.md
diff --git a/docs/markdown_files/faq.md b/docs/markdown_files/faq.md
@@ -0,0 +1,21 @@
+# Frequently Asked Questions
+
+## 1. How is Fern different than OpenAPI (f.k.a Swagger)?
+
+- **Higher-quality code generation**: Fern is more restrictive in what you can model, enabling idiomatic, easy-to-use code generation.
+
+- **Protocol agnostic**: Fern lets you define RESTful services alongside WebSocket subscriptions.
+
+- **Ease of use**: Fern runs code generators remotely and manages publishing packages to registries (e.g., NPM, Maven, PyPI). You get a dependency that you can start using right away.
+
+## 2. How does remote code generation work?
+
+Code generators run remotely in the cloud. They take a set of Fern API Definition YAML files, run the generators listed in `.fernrc.yml, and produce generated files as an output. Files can output locally (i.e., seen in the file system of your IDE) or remotely (i.e., in a package manager like NPM, Maven, or PyPI).
+
+### Generating clients
+
+![client generators](../assets/diagrams/frontend-diagram.png)
+
+### Generating servers
+
+![server generators](../assets/diagrams/backend-diagram.png)
diff --git a/docs/fern-config-json.md → docs/markdown_files/fern-config-json.md b/docs/fern-config-json.md → docs/markdown_files/fern-config-json.md
diff --git a/docs/fernrc.md → docs/markdown_files/fernrc.md b/docs/fernrc.md → docs/markdown_files/fernrc.md
diff --git a/docs/generators.md → docs/markdown_files/generators.md b/docs/generators.md → docs/markdown_files/generators.md
@@ -1,6 +1,4 @@
-## Fern Generators
-
-Generators
+# Fern Generators
 
 |  **Name**  |                                       **Description**                                        |   **CLI Command**   |                                            **Library**                                             |
 | :--------: | :------------------------------------------------------------------------------------------: | :-----------------: | :------------------------------------------------------------------------------------------------: |

diff --git a/docs/ids.md → docs/markdown_files/ids.md b/docs/ids.md → docs/markdown_files/ids.md
@@ -9,11 +9,10 @@ ids:
     type: integer
 ```
 
-## Key benefit of IDs
+## The key benefit of IDs
 
 Without IDs, developers can accidentally send a string/number of the wrong ID to an endpoint and the compiler doesn't know the difference. This can lead to bugs in production.
-
-With branded types `MovieId` is defined as:
+With branded types, `MovieId` is defined as:
 
 ```typescript
 export type MovieId = string & { __MovieId: void };

diff --git a/docs/imdb.md → docs/markdown_files/imdb.md b/docs/imdb.md → docs/markdown_files/imdb.md
@@ -15,7 +15,7 @@ Create a new folder for this tutorial and `cd` into it. Let's create a new npm p
 
 ```bash
 npm init -y
-npm install typescript ts-node express @types/express
+npm install typescript express @types/express ts-node
 ```
 
 This will set us up for a new TypeScript backend repo. We'll also install fern:
@@ -52,11 +52,10 @@ fern.config.json
 
 </details>
 
-## Step 3: Add generators
+## Step 3: Add TypeScript generator
 
 ```bash
 fern add typescript
-fern add postman
 ```
 
 <br>
@@ -71,37 +70,28 @@ fern add postman
 -generators: []
 +generators:
 +  - name: fernapi/fern-typescript
-+    version: 0.0.101
++    version: x.x.xxx
 +    generate: true
 +    config:
 +      mode: server
-+  - name: fernapi/fern-postman
-+    version: 0.0.6
-+    generate:
-+      enabled: true
-+      output: ./generated-postman.json
 ```
 
 </details>
 
-## Step 4: Run generators
-
-```bash
-fern generate
-```
+## Step 4: Run the generator
 
-In terminal, you'll see `Published @imdb-fern/api-server@x.x.x` which we'll add as a dependency.
+In the terminal, you'll see `Published @imdb-fern/imdb-api-server@x.x.x` which we'll add as a dependency. By default, Fern publishes dependencies to a private registry.
 
 ```bash
+# Teach npm about the Fern private registry
 npm config set --location project @imdb-fern:registry https://npm-dev.buildwithfern.com/
+
 npm install @imdb-fern/api-server@x.x.x
 ```
 
-In your files, you'll also see a `generated-postman.json` that we'll import to Postman later.
-
 ## Step 5: Implement the server
 
-We'll create a new file `server.ts` in the root of our project. This will be a simple express server that servers our IMDb API.
+We'll create a new file `server.ts` at the root of our project. This will be a simple express server that serves our IMDb API.
 
 ```ts
 // server.ts
@@ -117,13 +107,13 @@ app.use(
   })
 );
 
-console.log("Listening on port 8080!");
+console.log("Listening for requests...");
 app.listen(8080);
 ```
 
 Our IDE will give us red lines indicating that we need to add missing properties.
 
-![server.ts error message](assets/tutorial/server.ts%20error%20message.png)
+![server.ts error message](../assets/tutorial/server.ts%20error%20message.png)
 
 You can implement the missing methods, for example:
 
@@ -149,23 +139,34 @@ You can implement the missing methods, for example:
 +  }
  }))
 
- console.log("Listening on port 8080!");
+ console.log("Listening for requests...");
  app.listen(8080);
 ```
 
 ## Step 6: Run the server
 
 ```bash
-./node_modules/.bin/ts-node server.ts
+npx ts-node server.ts
 ```
 
+In the terminal, you should see `Listening for requests...`
+
+## Step 6: Add the Postman generator
+
+```bash
+fern add postman
+fern generate
+```
+
+In the `api/` folder you'll see `collection.json` that we'll import to Postman.
+
 ## Step 7: Hit the server from Postman
 
-Open Postman and File -> Import `api/generated-postman.json` that we generated in Step 4.
+Open Postman and File -> Import `api/generated-postman/collection.json`.
 
 Select the `createMovie` endpoint and hit `Send`. You should get a response back from your server **`iron-man-3`**.
 
-![postman-testing](assets/tutorial/postman-testing.png)
+![postman-testing](../assets/tutorial/postman-testing.png)
 
 ## Step 8: Celebrate
 

diff --git a/docs/imports.md → docs/markdown_files/imports.md b/docs/imports.md → docs/markdown_files/imports.md
diff --git a/docs/services.md → docs/markdown_files/services.md b/docs/services.md → docs/markdown_files/services.md
@@ -1,14 +1,14 @@
 # Defining a service
 
-This page is about defining a REST service, which communciates over HTTP.
+This page is about defining a REST service, which communicates over HTTP.
 
-_If you're interested in defining a realtime API (e.g. over WebSocket), you'll likely want to [define a channel](channels.md) instead._
+_If you're interested in \_defining a \_real-time_ API (_e.g. over WebSocket), you'll likely want to [define a channel](channels.md) instead._
 
 A service consists of **endpoints**. Each endpoint has a path and an associated HTTP method (e.g. `GET`, `POST`).
 
 ## Requests and responses
 
-Endpoints can optionally provided requests and responses, which are used as the HTTP message body.
+Endpoints can optionally provide requests and responses, which are used as the HTTP message body.
 
 ```diff-yaml diff-highlight
 types:
@@ -124,7 +124,7 @@ Every endpoint can specify [errors](errors.md) - i.e. responses that indicate th
 
 ## Authentication
 
-Services require authentication. Currently, Fern only supports bearer tokens using the via the `Authorization` header.
+Services require authentication. Currently, Fern only supports bearer tokens using the `Authorization` header.
 
 ```diff-yaml diff-highlight
 types:

diff --git a/docs/types.md → docs/markdown_files/types.md b/docs/types.md → docs/markdown_files/types.md
diff --git a/mlc_config.json b/mlc_config.json
diff --git a/package.json b/package.json
@@ -54,7 +54,7 @@
     "husky": "^7.0.4",
     "immer": "^9.0.15",
     "is-ci": "^3.0.1",
-    "jest": "^28.1.1",
+    "jest": "^28.1.2",
     "lint-staged": "^12.3.7",
     "lodash": "^4.17.21",
     "mrlint": "^0.0.36",

diff --git a/packages/add-generator/src/addGenerator.ts b/packages/add-generator/src/addGenerator.ts
@@ -2,7 +2,7 @@ import { GeneratorInvocationSchema, WorkspaceDefinitionSchema } from "@fern-api/
 
 const JAVA_GENERATOR_INVOCATION: GeneratorInvocationSchema = {
     name: "fernapi/fern-java",
-    version: "0.0.45",
+    version: "0.0.55",
     generate: true,
     config: {
         packagePrefix: "com",
@@ -12,7 +12,7 @@ const JAVA_GENERATOR_INVOCATION: GeneratorInvocationSchema = {
 
 const TYPESCRIPT_GENERATOR_INVOCATION: GeneratorInvocationSchema = {
     name: "fernapi/fern-typescript",
-    version: "0.0.117",
+    version: "0.0.123",
     generate: true,
     config: {
         mode: "server",

diff --git a/packages/ete-tests/src/__test__/add/__snapshots__/add.test.ts.snap b/packages/ete-tests/src/__test__/add/__snapshots__/add.test.ts.snap
@@ -5,13 +5,13 @@ exports[`fern add 1`] = `
 definition: src
 generators:
   - name: fernapi/fern-java
-    version: 0.0.45
+    version: 0.0.55
     generate: true
     config:
       packagePrefix: com
       mode: client_and_server
   - name: fernapi/fern-typescript
-    version: 0.0.117
+    version: 0.0.123
     generate: true
     config:
       mode: server