Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stackbit/annotation-errors-e2e

Jamstack site created with Stackbit
https://github.com/stackbit/annotation-errors-e2e

git headless jamstack nextjs ssg stackbit static

Last synced: 7 days ago
JSON representation

Jamstack site created with Stackbit

Awesome Lists containing this project

README

        

# Stackbit Annotation Error Test Site

This project can be used to test pre-releases of the cli app. It is configured to load the
monorepo as a git submodule, then uses a yarn workspace to link the local package for dev.
Finally, a `bin/dev.js` wrapper is invoked to launch stackbit in dev mode using this package.

## Getting started

0. Ensure `node --version` is 14.x and `npm --version` is 6.x

1. checkout the project and install node_modules:

```sh
git clone --recursive [email protected]:stackbit/annotation-errors-e2e.git
cd annotation-errors-e2e
yarn
```

If yarn cannot be found, first run `npm i -g yarn`. note: your git needs to be configured with ssh so that
user auth will pass through to the submodule.

2. Open up two command-line prompts in this directory.
a. In the first one run `yarn dev`
b. In the second terminal run `yarn stackbit-dev`

This will open Stackbit in your browser in local dev mode. Refer to the second
command line for reported annotation errors. If this command is run in vscode or WebStorm then the sourcemap links will be navigable.

**Important** One must run yarn again any time the `stackbit` branch changes, as this will force the build to run with the updated code.

## List of errata

1. Header
- Missing title annotation
2. Footer
- Incorrect parent field path (missing `:footer` at the end)

### Original Output

```
error: Found 22 annotation errors
error: AnnotationError: Field path navLinks not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/header[1]/div[1]/nav[1])
error: AnnotationError: Field path header.0 not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/header[1]/div[1]/nav[1]/a[1])
error: AnnotationError: Field path header.0.url not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/header[1]/div[1]/nav[1]/a[1])
error: AnnotationError: Field path header.label not found or does not match content schema (src/components/atoms/Link.tsx:18)
error: AnnotationError: Field path header.1 not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/header[1]/div[1]/nav[1]/a[2])
error: AnnotationError: Field path header.1.url not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/header[1]/div[1]/nav[1]/a[2])
error: AnnotationError: Field path header.label not found or does not match content schema (src/components/atoms/Link.tsx:18)
error: AnnotationError: Field path header.2 not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/header[1]/div[1]/nav[1]/a[3])
error: AnnotationError: Field path header.2.url not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/header[1]/div[1]/nav[1]/a[3])
error: AnnotationError: Field path header.label not found or does not match content schema (src/components/atoms/Link.tsx:18)
error: AnnotationError: Field path content/data/config.json not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/footer[1])
error: AnnotationError: Field path navLinks not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/footer[1]/nav[1])
error: AnnotationError: Field path 0 not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/footer[1]/nav[1]/a[1])
error: AnnotationError: Field path 0.url not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/footer[1]/nav[1]/a[1])
error: AnnotationError: Field path label not found or does not match content schema (src/components/atoms/Link.tsx:18)
error: AnnotationError: Field path 1 not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/footer[1]/nav[1]/a[2])
error: AnnotationError: Field path 1.url not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/footer[1]/nav[1]/a[2])
error: AnnotationError: Field path label not found or does not match content schema (src/components/atoms/Link.tsx:18)
error: AnnotationError: Field path 2 not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/footer[1]/nav[1]/a[3])
error: AnnotationError: Field path 2.url not found or does not match content schema (/html/body[1]/div[1]/div[1]/div[1]/footer[1]/nav[1]/a[3])
error: AnnotationError: Field path label not found or does not match content schema (src/components/atoms/Link.tsx:18)
error: AnnotationError: Field path copyrightText not found or does not match content schema (src/components/atoms/Markdown.tsx:9)
```