Skip to content

Commit 050faaf

Browse files
author
Kapil Gowru
committed
feat: first commit with all files copied over
0 parents  commit 050faaf

File tree

1,895 files changed

+92674
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,895 files changed

+92674
-0
lines changed

‎CONTRIBUTING.md‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Contributing
2+
3+
Thanks for being here! This monorepo contains Fern's documentation, the Fern CLI, the Fern Definition,
4+
the OpenAPI importer, as well as all of our generators.
5+
6+
Fern is open source, but many of the people working on it do so as their day job. As a potential contributor,
7+
your changes and ideas are welcome, but we can't guarantee that they will be prioritized nor reviewed in a
8+
timely manner (_if ever_). With that said, we generally encourage users to start with a GitHub issue to
9+
discuss a feature or fix before writing any code. You're still welcome to include a patch as a proof-of-concept,
10+
but please do not be offended if we rewrite your patch from scratch.
11+
12+
Like all open-source projects, Fern's resources are limited. If your patch isn’t a top priority, it may not
13+
receive the attention you expect.
14+
15+
<br>
16+
17+
## Setup
18+
19+
The Fern repo is primarily written in TypeScript and relies on [PnPm](https://pnpm.io/) for package management.
20+
21+
Once you have cloned or forked the repository, run through the steps below.
22+
23+
### Step 1: Install dependencies
24+
25+
```sh
26+
pnpm install
27+
```
28+
29+
### Step 2: Compile
30+
31+
To compile all the packages in this monorepo, run `pnpm compile`.
32+
33+
To compile a single package, filter to the relevant package: `pnpm --filter @fern-api/openapi-parser compile`.
34+
35+
### Step 3: Testing
36+
37+
This repo contains both unit tests and integration (end-to-end) tests.
38+
39+
To run all the unit tests: `pnpm test`.
40+
41+
To run unit tests for a single package: `pnpm --filter @fern-api/openapi-parser test`
42+
43+
To run the integration tests: `pnpm test:ete`.
44+
45+
Many of our tests rely on [snapshot testing](https://jestjs.io/docs/snapshot-testing). To rewrite snapshots, use `pnpm test:update` or `pnpm test:ete:update`.
46+
47+
<br>
48+
49+
## Repository Architecture
50+
51+
Below we talk through the large components of this monorepo and how to contribute to each one.
52+
53+
<br>
54+
55+
## Documentation
56+
57+
Fern's documentation is hosted live at the URL https://buildwithfern.com/learn. We appreciate any help we can get that makes our documentation more digestible.
58+
59+
If you find gaps within our documentation, please open an [issue](https://github.com/fern-api/fern/issues/new?assignees=&labels=documentation&projects=&template=documentation-suggestion.md&title=%5BFern%27s+Documentation%5D+)
60+
61+
### Editing Documentation
62+
63+
Our documentation is powered by Fern's Docs product. All of the configuration for the docs lives in [docs.yml](./fern/docs.yml).
64+
65+
To edit the docs, you can modify `docs.yml` or any of the markdown that it references.
66+
67+
To validate that the docs, run:
68+
69+
```sh
70+
fern check
71+
```
72+
73+
To preview the documentation, run:
74+
75+
```sh
76+
fern docs dev
77+
```
78+
79+
Finally, when you make a PR to update the docs, a PR preview link will be generated which will allow you
80+
to test if your changes came out as intended. [Here](https://github.com/fern-api/fern/pull/4330) is a sample PR with a preview link.
81+
82+
<br>
83+
84+
## Fern CLI
85+
86+
The Fern CLI lives in a directory called [cli](./packages/cli/cli/) and the entrypoint is [cli.ts](./packages/cli/cli/src/cli.ts).
87+
88+
### Building the CLI from source
89+
90+
For testing purposes, you can build a local version of the CLI by running `pnpm fern:build`. This compiles and builds a CLI
91+
that communicates with our production cloud environment.
92+
93+
The CLI is outputted to `packages/cli/cli/dist/prod/cli.cjs`.
94+
95+
Once the CLI has been built, you can navigate to any `fern` folder and invoke it by running
96+
97+
```sh
98+
FERN_NO_VERSION_REDIRECTION=true node /<path to fern git repo>/packages/cli/cli/dist/prod/cli.cjs <args>
99+
```
100+
101+
### Development CLI
102+
103+
To build a CLI that communicates with Fern's development cloud environment, run the command `pnpm fern-dev:build`.
104+
105+
Once the CLI has been built, you can navigate to any `fern` folder and invoke it by running
106+
107+
```sh
108+
FERN_NO_VERSION_REDIRECTION=true node /<path to fern git repo>/packages/cli/cli/dist/dev/cli.cjs <args>
109+
```
110+
111+
<br>
112+
113+
## Generators
114+
115+
All of Fern's generators live in a directory called [generators](./generators/). This directory contains generators for several languages such as
116+
[typescript](./generators/typescript/), [python](./generators/python/), [go](./generators/go).
117+
118+
Some of the generators are written in the language they generate (i.e. Python is written in python, Go is written in Go, and Java is written in Java).
119+
We are moving to a world where each generator will be written in TypeScript so that we can share more utilities and enforce a consistent structure
120+
in the generator.
121+
122+
### Generator Testing
123+
124+
**Note**: Please make sure that the docker daemon is running before running commands below.
125+
126+
To test our generators we have built a CLI called seed.
127+
128+
Seed handles building the generators from source and running them against all of the
129+
[test definitions](./test-definitions/fern/) that are present in the repository. Generated code is then stored in a directory named
130+
[seed](./seed/).
131+
132+
Each generator configures a `seed.yml`. For example, the TypeScript generator's configuration lives [here](./seed/ts-sdk/seed.yml).
133+
134+
Seed also handles running scripts against the generated code to make sure that the generated code compiles and works
135+
as intended. For example, in the TypeScript generator seed runs `yarn install` and `yarn build` to compile the source code.
136+
137+
To build seed, simply run
138+
139+
```sh
140+
pnpm seed:build
141+
```
142+
143+
**Note**: If you make any changes to the seed [source code](./packages/seed/src/) then you will need to rerun `pnpm seed:build`.
144+
145+
To run seed, you can use the command:
146+
147+
```
148+
pnpm seed test [--generator <generator-id>] [--fixture <fixture-name>] [--skip-scripts] [--local]
149+
```
150+
151+
Below are some examples of using the command.
152+
153+
- For a single generator: `pnpm seed test --generator python-sdk`
154+
- For a single generator and test definition: `pnpm seed test --generator python-sdk --fixture file-download`
155+
- For a single generator, test definition, and skipping scripts: `pnpm seed test --generator python-sdk --fixture file-download --skip-scripts`
156+
- For running the generator locally (not on docker): `pnpm seed test --generator python-sdk`
157+
158+
### Running seed against a custom fern definition
159+
160+
It may be valuable to run seed on a particular Fern definition or OpenAPI spec. To do this,
161+
you can use the `seed run` command and point it at the fern folder:
162+
163+
```
164+
pnpm seed run [--generator <generator-id>] [--path /path/to/fern/folder] [--audience <audience>]
165+
```
166+
167+
Below are some examples of using the command.
168+
169+
- Pointed at a fern folder: `pnpm seed run --generator ts-sdk --path /Users/jdoe/fern --audience external`
170+
- Pointed at a fern folder with an audience: `pnpm seed run --generator ts-sdk --path /Users/jdoe/fern`
171+
- Pointed at a fern folder with multiple apis: `pnpm seed run --generator ts-sdk --path /Users/jdoe/fern/apis/<name-of-api>`
172+
173+
<br>
174+
175+
## Feedback
176+
177+
If you have any feedback on what we could improve, please [open an issue](https://github.com/fern-api/fern/issues/new) to discuss it!

‎DOCSTODO.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## These are open items of areas to improve with the Docs V2 revamp.
2+
3+
- https://buildwithfern.slack.com/archives/C0811KJCBL4/p1749843216981529
4+
- https://buildwithfern.slack.com/archives/C05J55L8JES/p1749852300828139
5+
- https://buildwithfern.slack.com/archives/C07EQ2VEFU5/p1750085639878549
6+
- https://buildwithfern.slack.com/archives/C052DFWVCG6/p1750097991824229?thread_ts=1750093356.728189&cid=C052DFWVCG6
7+
- Add on-prem docs to enterprise https://buildwithfern.slack.com/archives/C069FN9958X/p1750085336657299
8+
- https://buildwithfern.slack.com/archives/C052DFWVCG6/p1750105603399839

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

0 commit comments

Comments
 (0)