open-index/open-npm huggingface dataset:
npm package: @studyportals/goldeneye-lighthouse
Description: <h1 align="center" style="border-bottom: none;">goldeneye-lighthouse 💡</h1> <h3 align="center">AWS CDK Library</h3> <p align="center">   <a href="https://github.com/studyportals/goldeneye-lighthouse/actions/workflows/test.yml">     <img alt="Build states
Latest version: 1.0.10

<h1 align="center" style="border-bottom: none;">goldeneye-lighthouse 💡</h1>
<h3 align="center">AWS CDK Library</h3>
<p align="center">
  <a href="https://github.com/studyportals/goldeneye-lighthouse/actions/workflows/test.yml">
    <img alt="Build states" src="https://github.com/studyportals/goldeneye-lighthouse/actions/workflows/test.yml/badge.svg">
  </a>
</p>

## Overview

GoldenEye Lighthouse is an AWS CDK (Cloud Development Kit) library designed to
seamlessly integrate Google Lighthouse tests into web applications onboarded
into GoldenEye within an AWS CodePipeline. This allows you to automate the
performance auditing process as part of your CI/CD pipeline.

## Features

- **Integration with AWS CodePipeline**: Easily add Lighthouse tests as part of
  your CodePipeline.
- **Detailed Reports**: Access detailed reports generated by Google Lighthouse
  to identify performance bottlenecks.

## Getting Started

### Prerequisites

- AWS CLI installed and configured
- Node.js and npm installed
- AWS CDK installed (`npm install -g aws-cdk`)

### Installation

Install the Lighthouse library using npm:

```bash
npm i @studyportals/goldeneye-lighthouse
```

### Usage

```typescript
import * as cdk from '@aws-cdk/core';
import { LighthouseTests } from '@studyportals/goldeneye-lighthouse';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'LighthouseTestsStack');

new LighthouseTests(stack, 'MyLighthouseTests', {
  lhci: {
    categories: ['accessibility', 'best-practices', 'seo'],
    chromeFlags: ['--no-sandbox', '--headless'],
    extraHeaders: JSON.stringify({ 'x-foo': 'bar' }),
    runs: 1,
    urls: ['https://example.com']
  },
  persistResults: true,
  serviceDescriptor: 'my-service',
  serviceEnvironment: 'PR',
  sourceArtifact: mySourceArtifact,
  testReportsBucket: myTestReportsBucket
});
```

## Useful commands

- `npm run build` compile TypeScript to JavaScript
- `npm run watch` watch for changes and compile
- `npm run test` perform the jest unit tests
npm package: @studyportals/goldeneye-lighthouse-check
Description: <h1 align="center" style="border-bottom: none;">goldeneye-lighthouse 💡</h1> <h3 align="center">AWS CDK Library</h3> <p align="center">   <a href="https://github.com/studyportals/goldeneye-lighthouse/actions/workflows/test.yml">     <img alt="Build states
Latest version: 0.0.1-alpha.12
npm package: @studyportals/goldeneye-w3c
Description: GoldenEye W3C is a hybrid library designed to work with both the **AWS CDK** and the **AWS SDK**. This library enables seamless integration of W3C checks into an AWS CodePipeline and handles reporting in GitHub Pull Requests.
Latest version: 1.0.16

# GoldenEye W3C

GoldenEye W3C is a hybrid library designed to work with both the **AWS CDK** and the **AWS SDK**. This library enables seamless integration of W3C checks into an AWS CodePipeline and handles reporting in GitHub Pull Requests.

## Overview

GoldenEye W3C provides two distinct modules:
- **CDK Module**: This module helps create and attach a W3C check to an AWS CodePipeline. It allows for seamless integration of the W3C validation process into your pipeline.
- **SDK Module**: The SDK module manages how the results of the W3C check are reported within GitHub's Pull Requests, ensuring that code quality is continuously monitored.

The W3C check implementation is based on the [goldeneye-w3c-submitter](https://github.com/studyportals/goldeneye-w3c-submitter) Docker image.

## How It Works

### CodePipeline Integration

GoldenEye adds the StageOptions generated by the CDK part. This allows you to attach a W3C check to your pipeline, ensuring that all changes are compliant with W3C standards.

1. The **`docker-compose.yml`** file is published as an S3 artifact.
2. This artifact is downloaded and executed within the **CodeBuild** phase of your CodePipeline.
3. The CodeBuild project uses the [goldeneye-w3c-submitter](https://github.com/studyportals/goldeneye-w3c-submitter) Docker image to run the W3C checks.
4. Results from the checks are generated and processed.

### GitHub Pull Request Reporting

The SDK module handles reporting for GitHub Pull Requests. After the W3C check completes, the results are posted back to the associated Pull Request, ensuring that all changes are compliant with W3C standards.

## Installation

`npm install`

## Usage

Make sure you have session credentials for the AWS account 478262784215 (PLOP Dev)

export VALIDATOR_SUBMITTER_IMAGE=478262784215.dkr.ecr.eu-central-1.amazonaws.com/goldeneye-w3c:latest

## Test

Run `npm run test` to execute the CDK tests.

### CDK Integration

To integrate W3C checks into your AWS CodePipeline using the AWS CDK:

```bash
npm install goldeneye-w3c