• Stars
    star
    184
  • Rank 209,187 (Top 5 %)
  • Language
    JavaScript
  • License
    Apache License 2.0
  • Created about 4 years ago
  • Updated 3 months ago

Reviews

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

Repository Details

Code to parse Chrome's internal extension type definitions—published on NPM as chrome-types

chrome-types

codecov

⚠️ If you're looking for TypeScript definitions for Chrome's extensions, you should depend on chrome-types in your project.

This repo contains JS which parses Chrome's internal extension definitions and outputs TypeScript Definition files. You shouldn't depend on this code: rather, the generated types file is published at chrome-types. Depend on it for your Chrome extensions projects (MV3 and above).

Design

This repo's design is documented in the wiki. Broadly, it reads Chromium's source code to find the internal extensions definitions (in IDL and JSON) and traverses them to generate ".d.ts" files—one for modern extension development (MV3+), and one for all extensions (including the deprecated Platform Apps APIs).

Deploy

This code is run automatically on a daily basis by GitHub Actions. It prepares a ".d.ts" file for Chrome's HEAD revision, annotated with information about the public Chrome release API first became available in, and publishes a new version if the output differs from the previous release.

Usage

This repository is mostly intended as an implementation detail of the https://developer.chrome.com site and for publishing chrome-types on NPM, which happens automaticalty as part of a GitHub Action. You can run it yourself, but if you're just interested in the generated types, you don't need to.

Run "tools/prepare.js" to generate a bundle of JSON representing Chrome's extensions at a specific release. You can then pass this bundle to other tools like "tools/render-tsd.js". See the wiki for more.

Running the code requires Node 16+ as well as a working version of Python (3 is preferred, but 2.7+ should work) installed on your system. This has only been tested on Linux and macOS. Python is used to convert Chromium's internal IDL format to JSON.

More Repositories

1

lighthouse

Automated auditing, performance metrics, and best practices for the web.
JavaScript
28,269
star
2

chrome-extensions-samples

Chrome Extensions Samples
JavaScript
14,888
star
3

workbox

📦 Workbox: JavaScript libraries for Progressive Web Apps
JavaScript
12,346
star
4

web-vitals

Essential metrics for a healthy site.
JavaScript
7,571
star
5

lighthouse-ci

Automate running Lighthouse for every commit, viewing the changes, and preventing regressions
JavaScript
6,377
star
6

rendertron

A Headless Chrome rendering solution
TypeScript
5,936
star
7

samples

A repo containing samples tied to new functionality in each release of Google Chrome.
HTML
5,769
star
8

web.dev

The frontend, backend, and content source code for web.dev
Nunjucks
3,563
star
9

dialog-polyfill

Polyfill for the HTML dialog element
JavaScript
2,443
star
10

web-vitals-extension

A Chrome extension to measure essential metrics for a healthy site
CSS
2,360
star
11

accessibility-developer-tools

This is a library of accessibility-related testing and utility code.
JavaScript
2,280
star
12

developer.chrome.com

The frontend, backend, and content source code for developer.chrome.com
HTML
1,665
star
13

custom-tabs-client

Chrome custom tabs examples
Java
1,399
star
14

chrome-launcher

Launch Google Chrome with ease from node.
TypeScript
1,232
star
15

proxy-polyfill

Proxy object polyfill
JavaScript
1,134
star
16

omnitone

Spatial Audio Rendering on the web.
JavaScript
851
star
17

android-browser-helper

The Android Browser Helper library helps developers use Custom Tabs and Trusted Web Activities on top of the AndroidX browser support library.
Java
693
star
18

devtools-docs

The legacy documentation for Chrome DevTools.
HTML
691
star
19

chromium-dashboard

Chrome Status Dashboard
Python
637
star
20

OriginTrials

Enabling safe experimentation with web APIs
Bikeshed
519
star
21

related-website-sets

Python
395
star
22

audion

Audion is a Chrome extension that adds a Web Audio panel to Developer Tools. This panel visualizes the web audio graph in real-time.
TypeScript
368
star
23

chrome-app-codelab

The goal of this tutorial is to get you building Chrome apps fast. Once you've completed the tutorial, you will have a simple Todo app. We've done our best to capture some of the trickier parts to the development process keeping the sample simple and straightforward.
JavaScript
213
star
24

CrUX

The place to share queries, ideas, or issues related to the Chrome UX Report
Jupyter Notebook
206
star
25

lighthouse-stack-packs

Lighthouse Stack Packs
JavaScript
204
star
26

inert-polyfill

Polyfill for the HTML inert attribute
JavaScript
188
star
27

ip-protection

171
star
28

devtools-samples

Samples for demonstrating DevTools features.
HTML
152
star
29

CertificateTransparency

HTML
148
star
30

browser-bug-search

Search across all major browser vendor issue trackers
JavaScript
114
star
31

multi-device

Chrome multi-device (mobile) docs
HTML
103
star
32

kino

A sample offline streaming video PWA built for web.dev/media
JavaScript
102
star
33

webstatus.dev

A tool to monitor and track the status of all Web Platform features across dimensions that are related to availability and implementation quality across browsers, and adoption by web developers.
Go
97
star
34

webstore-docs

Developer docs for Chrome Web Store:
HTML
65
star
35

jank-busters

Resources for jank busting on the web.
JavaScript
64
star
36

webdev-infra

JavaScript
40
star
37

private-tokens

39
star
38

budget.json

38
star
39

.github

11
star
40

.allstar

7
star
41

CertificateTransparency-todelete

HTML
7
star
42

baseline-status

JavaScript
4
star
43

lighthouse-plugin-example

JavaScript
1
star