• Stars
    star
    179
  • Rank 214,039 (Top 5 %)
  • Language
    JavaScript
  • License
    Apache License 2.0
  • Created over 7 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🤖 Compare your base branch to a pull request and run plugins over it to view differences

pr-bot

Build Status Coverage Status dependencies Status devDependencies Status

This is a small utility to run a set of "plugins" against a Pull Request on Travis and then report a set of results to GitHub.

Example PR-Bot Output

Getting Started

To use pr-bot you'll need to set up a few things:

  1. Create a GitHub account to use for bot activity. This will be the account login and profile photo that you'll see when the bot comments on a pull request.

  2. Add the GitHub bot account to your project as a collaborator. https://github.com/<owner>/<repo>/settings/collaboration. Be sure to accept the invite email! This will enable the bot to set PR statuses.

  3. Create a personal access token for the GitHub bot account. The access token must at least have the public_repo scope enabled.

  4. In the Travis settings for your repository, set the personal access token as an environment variable called GITHUB_TOKEN.

    Imgur

  5. Add pr-bot as a dependency to your project:

    npm install --save-dev pr-bot
  6. Create a file called pr-bot.config.js at the root of your project (i.e. this file needs to be commited to your GitHub repository).

  7. In this new file add the following:

    const prbot = require('pr-bot');
    
    module.exports = {
      botUsername: `<Add the GitHub Username for your Bot Account Here>`,
      repoDetails: {
        owner: "<Add the repo owner, i.e. GoogleChrome>",
        repo: "<Add the repo name, i.e. workbox>"
      },
      plugins: [
        new prbot.plugins.Size({
          globPattern: '**/*.js',
          globOptions: {
            ignore: [
              '**/node_modules/**/*',
            ]
          },
        }),
      ],
    };
  8. Add the following to your .travis.yml file

    after_script:
      - npm install -g pr-bot
      - pr-bot

Now you can commit your code and if everything is set up correctly, you'll see comments from your bot account.

Example output from Size Plugin from pr-bot

Running Locally

You can see what pr-bot will do locally with the following:

npm install --global pr-bot
pr-bot

This is useful if you want to see the file differences without waiting on Travis.

Example console output from Size Plugin from pr-bot

Customising Config Path

You can use the -c flag to define a custom config path:

pr-bot -c ./some-path-my-config.js

Customising Install and Build

If npm install && npm build will not suffice for your project, you define a buildCommand parameter in your config file to define the command to run in the two checkouts of your project.

module.exports = {
  // Custom build command in travis.config.js
  buildCommand: `npm install && gulp`,


  botUsername: `....`,
  plugins: [...]
}

How it Works

When you run pr-bot it checks out two versions of your project.

  1. If run locally, it'll checkout the default branch of your repo AND use the current directory and the current files for the second version.
  2. If run on Travis, it'll checkout the base of the Pull Request, or the target branch, for the first version and it'll checkout the Pull Request commit as the second version.

These are checked out into tempory files under /tmp and pr-bot will npm install && npm run build in each repository.

After this, each plugin defined in your config file will be called with a beforePath and afterPath. This allows plugins to compare files or anything else they want.

Plugins are expected to return a promise that resolves to an object with a prettyLog parameter and a markdownLog parameter. The prettyLog is used to display plugin output to the console and markdownLog is used to print to the GitHub comment raised against the Pull Request.

Adding Custom Plugins

You can build custom plugins, the key things to note are:

Your plugin must:

  1. ..have a name property.
  2. ..have a run method with a signature of run({beforePath, afterPath} = {}).
  3. ..return a Promise from the run method.

And your plugin should:

  1. ..resolve the run promise with an objectwith prettyLog and markdownLog string parameters to print out info and if you wish to mark the Pull Request as a bad PR (set status to failure), you can return the parameter failPR with true.

A basic plugin can look like this:

{
  name: 'Example Plugin',
  run: () => {
    return Promise.resolve({
      failPR: false,
      prettyLog: 'Hello from example plugin.',
      markdownLog: '## Hello from example plugin.'
    });
  },
}

If you want, your custom plugin can also extend the PluginInterface from the module with const PluginInterface = require('pr-bot').PluginInterface;.

Different Base Branch

When developing on a new version, the default branch on GitHub may not be the branch you want to compare PR's (or locally).

You can compare to other branches using the overrideBaseBranch config.

module.exports = {
  overrideBaseBranch: '<name of branch',
  ...
};

More Repositories

1

squoosh

Make images smaller using best-in-class codecs, right in the browser.
TypeScript
21,605
star
2

comlink

Comlink makes WebWorkers enjoyable.
TypeScript
11,198
star
3

quicklink

⚡️Faster subsequent page-loads by prefetching in-viewport links during idle time
JavaScript
11,024
star
4

ndb

ndb is an improved debugging experience for Node.js, enabled by Chrome DevTools
JavaScript
10,913
star
5

carlo

Web rendering surface for Node applications
JavaScript
9,313
star
6

ProjectVisBug

FireBug for designers › Edit any webpage, in any state https://a.nerdy.dev/gimme-visbug
JavaScript
5,452
star
7

sw-precache

[Deprecated] A node module to generate service worker code that will precache specific resources so they work offline.
JavaScript
5,236
star
8

react-adaptive-hooks

Deliver experiences best suited to a user's device and network constraints
JavaScript
5,097
star
9

ui-element-samples

A collection of prototyped UI elements
JavaScript
4,101
star
10

sw-toolbox

[Deprecated] A collection of service worker tools for offlining runtime requests
JavaScript
3,621
star
11

webpack-libs-optimizations

Using a library in your webpack project? Here’s how to optimize it
3,365
star
12

critters

🦔 A Webpack plugin to inline your critical CSS and lazy-load the rest.
JavaScript
3,330
star
13

psi

PageSpeed Insights Reporting for Node
JavaScript
3,100
star
14

bubblewrap

Bubblewrap is a Command Line Interface (CLI) that helps developers to create a Project for an Android application that launches an existing Progressive Web App (PWAs) using a Trusted Web Activity.
TypeScript
2,375
star
15

lighthousebot

Run Lighthouse in CI, as a web service, using Docker. Pass/Fail GH pull requests.
JavaScript
2,235
star
16

preload-webpack-plugin

Please use https://github.com/vuejs/preload-webpack-plugin instead.
JavaScript
2,162
star
17

worker-plugin

👩‍🏭 Adds native Web Worker bundling support to Webpack.
JavaScript
1,914
star
18

prerender-loader

📰 Painless universal pre-rendering for Webpack.
JavaScript
1,912
star
19

simplehttp2server

A simple HTTP/2 server for development
Go
1,735
star
20

jsvu

JavaScript (engine) Version Updater
JavaScript
1,698
star
21

size-plugin

Track compressed Webpack asset sizes over time.
JavaScript
1,672
star
22

clooney

Clooney is an actor library for the web. Use workers without thinking about workers.
JavaScript
1,419
star
23

browser-fs-access

File System Access API with legacy fallback in the browser
JavaScript
1,383
star
24

proxx

A game of proximity
TypeScript
1,315
star
25

dark-mode-toggle

A custom element that allows you to easily put a Dark Mode 🌒 toggle or switch on your site:
JavaScript
1,174
star
26

application-shell

Service Worker Application Shell Architecture
JavaScript
1,169
star
27

pwacompat

PWACompat to bring Web App Manifest to older browsers
JavaScript
1,130
star
28

container-query-polyfill

A polyfill for CSS Container Queries
TypeScript
1,127
star
29

idlize

Helper classes and methods for implementing the idle-until-urgent pattern
JavaScript
1,061
star
30

houdini-samples

Demos for different Houdini APIs
JavaScript
974
star
31

jsbi

JSBI is a pure-JavaScript implementation of the official ECMAScript BigInt proposal.
JavaScript
908
star
32

css-triggers

A reference for the render impact of mutating CSS properties.
JavaScript
893
star
33

howto-components

Literate code examples for common UI patterns.
JavaScript
851
star
34

tooling.report

tooling.report a quick way to determine the best build tool for your next web project, or if tooling migration is worth it, or how to adopt a tool's best practice into your existing configuration and code base.
JavaScript
848
star
35

page-lifecycle

PageLifecycle.js is a tiny JavaScript library that allows developers to easily observe Page Lifecycle API state changes cross browser
JavaScript
803
star
36

css-paint-polyfill

CSS Custom Paint / Paint Worklet polyfill with special browser optimizations.
JavaScript
709
star
37

web-audio-samples

Web Audio API samples by Chrome Web Audio Team
JavaScript
686
star
38

chrome-for-testing

JavaScript
667
star
39

picture-in-picture-chrome-extension

JavaScript
667
star
40

estimator.dev

🧮 Calculate the size and performance impact of switching to modern JavaScript syntax.
JavaScript
665
star
41

comlink-loader

Webpack loader to offload modules to Worker threads seamlessly using Comlink.
JavaScript
616
star
42

pwa-wp

WordPress feature plugin to bring Progressive Web Apps (PWA) to Core
PHP
615
star
43

ProgressiveWordPress

A Sample WordPress-based Progressive Web App
JavaScript
570
star
44

web-push-codelab

JavaScript
557
star
45

text-app

A text editor for ChromeOS and Chrome
JavaScript
552
star
46

gulliver

A PWA directory, focusing on collecting PWA best practices and examples.
JavaScript
549
star
47

wasm-feature-detect

A small library to detect which features of WebAssembly are supported.
JavaScript
546
star
48

progressive-tooling

A list of community-built, third-party tools that can be used to improve page performance
JavaScript
546
star
49

svgomg-twa

A sample that project Trusted Web Activities technology to wrap SVGOMG in an Android Application
Shell
519
star
50

web-vitals-report

Measure and report on your Web Vitals data in Google Analytics
JavaScript
503
star
51

text-editor

A text editor build on the Native File System APIs
JavaScript
501
star
52

pptraas.com

Puppeteer as a service
JavaScript
455
star
53

progressive-rendering-frameworks-samples

Samples and demos from the Progressive Rendering I/O talk
JavaScript
411
star
54

wasm-bindgen-rayon

An adapter for enabling Rayon-based concurrency on the Web with WebAssembly.
JavaScript
403
star
55

MiniMobileDeviceLab

A mini mobile web device lab
Objective-C
396
star
56

webm-wasm

webm-wasm lets you create webm videos in JavaScript via WebAssembly.
C++
394
star
57

link-to-text-fragment

Browser extension that allows for linking to arbitrary text fragments.
JavaScript
390
star
58

cronet-sample

A sample for the Cronet library
Java
390
star
59

buffer-backed-object

Buffer-backed objects in JavaScript.
JavaScript
372
star
60

pinch-zoom

TypeScript
370
star
61

webpack-training-project

A training project for learning Webpack optimizations
JavaScript
368
star
62

samesite-examples

Examples of using the SameSite cookie attribute in a variety of language, libraries, and frameworks.
HTML
366
star
63

airhorn

Air horn
JavaScript
361
star
64

AutoWebPerf

AutoWebPerf provides a flexible and scalable framework for running web performance audits with arbitrary audit tools including PageSpeedInsights, WebPageTest and more.
JavaScript
353
star
65

first-input-delay

A JavaScript library for measuring First Input Delay (FID) in the browser.
JavaScript
347
star
66

tti-polyfill

Time-to-interactive polyfill
JavaScript
333
star
67

react-shrine

"Shrine" Progressive Web App sample built with React
JavaScript
330
star
68

dynamic-import-polyfill

A fast, tiny polyfill for dynamic import() that works in all module-supporting browsers
JavaScript
320
star
69

wasi-fs-access

This is a demo shell powered by WebAssembly, WASI, Asyncify and File System Access API.
TypeScript
312
star
70

native-url

Node's url module implemented using the built-in URL API.
JavaScript
284
star
71

two-up

TypeScript
281
star
72

adaptive-loading

Demos for Adaptive Loading - differentially deliver fast, lighter experiences for users on slow networks & devices
JavaScript
264
star
73

so-pwa

A progressive web app to read Stack Overflow content.
JavaScript
255
star
74

import-from-worker

It’s like import(), but runs the module in a worker.
JavaScript
249
star
75

sample-pie-shop

Example e-commerce site to explore PWA (Progressive Web App) use cases.
JavaScript
237
star
76

file-drop

A simple file drag and drop custom-element
TypeScript
232
star
77

serial-terminal

Demo application for the Web Serial API.
TypeScript
226
star
78

form-troubleshooter

TypeScript
215
star
79

postcss-jit-props

A CSS custom property helper based on PostCSS. Supply a pool of variables and this plugin will add them to the stylesheet as they are used.
JavaScript
215
star
80

audioworklet-polyfill

🔊 Polyfill AudioWorklet using the legacy ScriptProcessor API.
JavaScript
190
star
81

http2-push-manifest

Generate a list of static resources for http2 push.
JavaScript
187
star
82

pointer-tracker

Track mouse/touch/pointer events for a given element.
TypeScript
184
star
83

discovery

Discoveries on Sustainable Loading research
177
star
84

imagecapture-polyfill

MediaStream ImageCapture polyfill. Take photos from the browser as easy as .takePhoto().then(processPhoto)
JavaScript
176
star
85

tasklets

JavaScript
176
star
86

telnet-client

TypeScript
166
star
87

extension-manifest-converter

Python
164
star
88

credential-management-sample

Credential Management Sample
HTML
157
star
89

wadb

A TypeScript implementation of the Android Debug Bridge(ADB) protocol over WebUSB
TypeScript
156
star
90

extension-update-testing-tool

Tool for testing the update flow for Chrome Extensions during development, including permission grants.
JavaScript
154
star
91

wasm-av1

Port of the AV1 Video codec to WebAssembly
C
154
star
92

houdini.how

A community-driven gathering place for CSS Houdini worklets and resources.
JavaScript
152
star
93

pwa-workshop-codelab

JavaScript
152
star
94

perf-track

Tracking framework performance and usage at scale
Svelte
150
star
95

kv-storage-polyfill

A polyfill for the kv-storage built-in module.
JavaScript
146
star
96

http2push-gae

Drop-in HTTP2 push on App Engine
HTML
140
star
97

chromeos_smart_card_connector

Smart Card Connector App for Chrome OS
C++
135
star
98

snapshot

TypeScript
133
star
99

devwebfeed

Firehose of team++ resources
JavaScript
130
star
100

sample-currency-converter

A sample currency conversion Progressive Web App
JavaScript
129
star