Initial commit

Co-Authored-By: Gary Zhao <[email protected]>
Co-Authored-By: Kayleigh Foley <[email protected]>
Co-Authored-By: Matt Zaso <[email protected]>
Co-Authored-By: Molly Elfers <[email protected]>

Author: 5 people

.circleci/config.yml

@@ -0,0 +1,56 @@
+version: 2
+
+defaults: &defaults
+  working_directory: ~/repo
+  docker:
+    - image: circleci/node:10.15.0
+
+jobs:
+  test:
+    <<: *defaults
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{arch}}-{{ checksum "package.json" }}
+            - v1-dependencies-{{arch}}-
+
+      - run: yarn install
+
+      - save_cache:
+          key: v1-dependencies-{{arch}}-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+
+      - run:
+          name: Check format
+          command: yarn format:check
+
+      - run:
+          name: Run linter
+          command: yarn lint
+
+      - run:
+          name: Run tests
+          command: yarn test --ci
+
+
+  release:
+    <<: *defaults
+
+    steps:
+      - checkout
+      - run: yarn install
+      - run: yarn build
+      - run: yarn semantic-release
+
+workflows:
+  version: 2
+
+  test:
+    jobs:
+      - test
+      - release:
+          requires:
+            - test

.gitignore

@@ -0,0 +1,12 @@
+node_modules
+coverage
+.nyc_output
+.DS_Store
+*.log
+.vscode
+.idea
+compiled
+.awcache
+.rpt2_cache
+docs
+dist

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "printWidth": 100,
+  "trailingComma": "all"
+}

CONTRIBUTING.md

@@ -0,0 +1,140 @@
+# Contributing
+
+Thank you for your interest in contributing to an Intercom project.
+
+## Table of contents
+
+- [Development](#development)
+  - [Installation](#installation)
+  - [Project structure](#project-structure)
+- [Code of Conduct](#code-of-conduct)
+  - [Our pledge](#our-pledge)
+  - [Our standards](#our-standards)
+  - [Our responsibilities](#our-responsibilities)
+  - [Scope](#scope)
+  - [Enforcement](#enforcement)
+  - [Attribution](#attribution)
+
+## Development
+
+### Installation
+
+This project is a Rollup-based TypeScript NodeJS library. To get the source and make changes:
+
+```bash
+git clone [email protected]:intercom/contentful-typescript-codegen.git
+cd contentful-typescript-codegen
+yarn install
+```
+
+To ensure everything is set up correctly:
+
+```bash
+yarn test
+```
+
+### Project structure
+
+This project consists of three main parts, and the `src/` folder mostly reflects this:
+
+1. The **CLI entry point**, which is responsible for parsing command line arguments, loading the
+   Contentful environment from the parent module's setup, and printing the generated TypeScript to
+   the specified output location.
+1. The **TypeScript code generators**, which are helpers that print out things like interfaces,
+   union types, and other TypeScript type structures.
+1. The **Contentful code generators**, which receive Contentful objects (like Content Types and
+   Fields) and use the **TypeScript code generators** to turn them into interfaces.
+
+The TypeScript code generators utilize one another to eventually resolve a giant string. This big,
+ugly string is ultimately passed through Prettier and sent back to the CLI layer to print to a file.
+
+All generators have roughly the following shape:
+
+```ts
+interface Generator {
+  (thing: SomeParticularObject, options?: OptionsForGenerator): string
+}
+```
+
+Testing mostly consists of snapshot testing. Tests use `prettier`, where applicable, to make the
+snapshots easier to read and to make sure they parse as valid TypeScript. Note that using `prettier`
+on too "narrow" of a test (i.e., _just_ a field) will cause a parser error. In such cases, just let
+the snapshot be ugly and let "broader" tests handle regressions involving potentially unparseable
+code.
+
+## Code of Conduct
+
+### Our pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+### Our standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2019 Intercom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,107 @@
+# contentful-typescript-codegen
+
+Generate typings from your Contentful environment.
+
+- Content Types become interfaces.
+- Locales (and your default locale) become string types.
+- Assets and Rich Text link to Contentful's types.
+
+At Intercom, we use this in our [marketing site] to increase developer confidence and productivity,
+ensure that breaking changes to our Content Types don't cause an outage, and because it's neat.
+
+[marketing site]: https://www.intercom.com
+
+## Usage
+
+```sh
+yarn install --dev contentful-typescript-codegen
+```
+
+Then, add the following to your `package.json`:
+
+```jsonc
+{
+  // ...
+  "scripts": {
+    "contentful-typescript-codegen": "contentful-typescript-codegen --output @types/generated/contentful.d.ts"
+  }
+}
+```
+
+Feel free to change the output path to whatever you like.
+
+Next, the codegen will expect you to have created a file called `getContentfulEnvironment.js` in the
+root of your project directory, and it should export a promise that resolves with your Contentful
+environment.
+
+The reason for this is that you can do whatever you like to set up your Contentful Management
+Client. Here's an example:
+
+```js
+const contentfulManagement = require("contentful-management")
+
+module.exports = function() {
+  const contentfulClient = contentfulManagement.createClient({
+    accessToken: process.env.CONTENTFUL_MANAGEMENT_API_ACCESS_TOKEN,
+  })
+
+  return contentfulClient
+    .getSpace(process.env.CONTENTFUL_SPACE_ID)
+    .then(space => space.getEnvironment(process.env.CONTENTFUL_ENVIRONMENT))
+}
+```
+
+### Command line options
+
+```
+Usage
+  $ contentful-typescript-codegen --output <file> <options>
+
+Options
+  --output,      -o  Where to write to
+  --poll,        -p  Continuously refresh types
+  --interval N,  -i  The interval in seconds at which to poll (defaults to 15)
+```
+
+## Example output
+
+Here's an idea of what the output will look like for a Content Type:
+
+```ts
+interface IBlogPostFields {
+  /** Title */
+  title: string
+
+  /** Body */
+  body: Document
+
+  /** Author link */
+  author: IAuthor
+
+  /** Image */
+  image: Asset
+
+  /** Published? */
+  published: boolean | null
+
+  /** Tags */
+  tags: string[]
+
+  /** Blog CTA variant */
+  ctaVariant: "new-cta" | "old-cta"
+}
+
+/**
+ * A blog post.
+ */
+export interface IBlogPost extends Entry<IBlogPostFields> {}
+```
+
+You can see that a few things are handled for you:
+
+- Documentation comments are automatically generated from Contentful descriptions.
+- Links, like `author`, are resolved to other TypeScript interfaces.
+- Assets are handled properly.
+- Validations on symbols and text fields are expanded to unions.
+- Non-required attributes automatically have `| null` appended to their type.
+- The output is formatted using **your** Prettier config.

jest.config.js

@@ -0,0 +1,18 @@
+module.exports = {
+  transform: {
+    ".(ts|tsx)": "ts-jest",
+  },
+  testEnvironment: "node",
+  testRegex: "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+  moduleFileExtensions: ["ts", "tsx", "js"],
+  coveragePathIgnorePatterns: ["/node_modules/", "/test/", "/src/contentful-typescript-codegen.ts"],
+  coverageThreshold: {
+    global: {
+      branches: 90,
+      functions: 95,
+      lines: 95,
+      statements: 95,
+    },
+  },
+  collectCoverageFrom: ["src/**/*.{js,ts}"],
+}

lint-staged.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  "{src,test}/**/*.ts": ["prettier --write", "git add"],
+}