https://github.com/serlo/unused-graphql-properties

Example for coverage of GraphQL types and fields at serlo.org
https://github.com/serlo/unused-graphql-properties

Last synced: 4 days ago
JSON representation

Example for coverage of GraphQL types and fields at serlo.org

• Host: GitHub
• URL: https://github.com/serlo/unused-graphql-properties
• Owner: serlo
• License: mit
• Created: 2023-11-21T17:46:01.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-09-08T19:09:17.000Z (2 months ago)
• Last Synced: 2024-09-08T20:37:02.013Z (2 months ago)
• Language: TypeScript
• Homepage: https://serlo.github.io/unused-graphql-properties/
• Size: 1.52 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Coverage of GraphQL endpoints of serlo.org

This package contain helper scripts to show the coverage of GraphQL fields and types of serlo.org.

## Setup

1. Clone repo.

2. Install dependencies via `yarn`.

3. Download GraphQL queries of serlo.org via `yarn download-documents`. The queries are stored in the directory `documents/`.

## Usage

- Use `yarn show-coverage` to show the coverage of GraphQL types and fields in the terminal.

- Use `yarn generate-report` to generate a report about the coverage in `public/index.html`.

## Notice

- In [`download_documents.ts`](./download_documents.ts) in the variable `repos` is defined which repositories are scanned for graphql queries.

- In [`download_documents`](./download_documents.ts) there are also the regexes stored which are used to detect GraphQL statements.