open-index/open-npm huggingface dataset:
npm package: @octoguild/eslint-config-core
Description: `npm i @octoguild/eslint-config-core -D`
Latest version: 2.0.2

## Install

`npm i @octoguild/eslint-config-core -D`

or

`yarn add @octoguild/eslint-config-core --dev`



### Usage (ESLint 9 flat config)

The package is **ESM** (`"type": "module"`). `index.js` default-exports a **flat config array** (parser and plugins are loaded via `import`).

Use it from your project’s `eslint.config.js` / `eslint.config.mjs`:

```js
import path from 'node:path'
import { fileURLToPath } from 'node:url'
import core from '@octoguild/eslint-config-core'

const tsconfigRootDir = path.dirname(fileURLToPath(import.meta.url))

export default [
  ...core,
  {
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.json'],
        tsconfigRootDir,
      },
    },
  },
]
```

If tooling returns an interop wrapper, use `...(core.default ?? core)`.

Legacy `.eslintrc` + `extends: ["@octoguild/core"]` is not supported by this flat export—migrate the consuming app to flat config.
npm package: @octoguild/eslint-config-react
Description: `npm i @octoguild/eslint-config-react -D`
Latest version: 2.0.2

## Install

`npm i @octoguild/eslint-config-react -D`

or

`yarn add @octoguild/eslint-config-react --dev`



### Usage (ESLint 9 flat config)

This package is **ESM** (`"type": "module"`). The default export is a flat config array (includes **pragma-auto** rules).

```js
import path from 'node:path'
import { fileURLToPath } from 'node:url'
import react from '@octoguild/eslint-config-react'

const tsconfigRootDir = path.dirname(fileURLToPath(import.meta.url))

export default [
  ...react,
  {
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.json'],
        tsconfigRootDir,
      },
    },
  },
]
```

### Pragma presets

- **Default (`@octoguild/eslint-config-react`)** — pragma-auto: `@emotion/jsx-import` off, `react/no-unknown-property` ignores `css`.
- **`@octoguild/eslint-config-react/pragma-manual`** — ESM module that **default-exports** a `rules` object (`@emotion/jsx-import`: error). Import it and add `{ rules: … }` to your flat config when you want manual pragma instead of the default; you will usually mirror `react/index.js` but swap the pragma-auto import for pragma-manual.
npm package: @octoguild/eslint-config-react-native
Description: `npm i @octoguild/eslint-config-react-native -D`
Latest version: 2.0.2

## Install

`npm i @octoguild/eslint-config-react-native -D`

or

`yarn add @octoguild/eslint-config-react-native --dev`



### Usage (ESLint 9 flat config)

This package is **ESM** (`"type": "module"`). It default-exports a flat config array (React core + React Native + Detox env for `*.spec.*`).

```js
import path from 'node:path'
import { fileURLToPath } from 'node:url'
import reactNative from '@octoguild/eslint-config-react-native'

const tsconfigRootDir = path.dirname(fileURLToPath(import.meta.url))

export default [
  ...reactNative,
  {
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.json'],
        tsconfigRootDir,
      },
    },
  },
]
```

### Detox

Spec globs: `*.spec.ts`, `*.spec.tsx`, `*.spec.js`, `*.spec.jsx` (paths prefixed with `./**/` as in the legacy config).
npm package: @octoguild/eslint-config-server
Description: Set of rules for typescript + mocha tests project
Latest version: 2.0.0

## Description

Set of rules for typescript + mocha tests project


## Install

`npm i @octoguild/eslint-config-server -D`

or

`yarn add @octoguild/eslint-config-server --dev`



### Usage (ESLint 9 flat config)

This package is **ESM** (`"type": "module"`). It default-exports a flat config array.

```js
import path from 'node:path'
import { fileURLToPath } from 'node:url'
import server from '@octoguild/eslint-config-server'

const tsconfigRootDir = path.dirname(fileURLToPath(import.meta.url))

export default [
  ...server,
  {
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.json'],
        tsconfigRootDir,
      },
    },
  },
]
```

Node + Mocha globals are included via the `globals` package (`globals.node`, `globals.mocha`).
npm package: @octohash/eslint-config
Description: Personal ESLint config based on @antfu/eslint-config with opinionated extensions.
Author: jinghaihan
Latest version: 0.3.1

# @octohash/eslint-config

[![npm version][npm-version-src]][npm-version-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]

A personal ESLint config, built as an extension of
[`@antfu/eslint-config`](https://github.com/antfu/eslint-config).

## Install

```bash
pnpm add -D @octohash/eslint-config eslint
```

## Usage

```ts
import { defineConfig } from '@octohash/eslint-config'

export default defineConfig()
```

## What This Adds

- Adds first-class `Tailwind CSS` linting/formatting rules powered by
  [`eslint-plugin-better-tailwindcss`](https://github.com/schoero/eslint-plugin-better-tailwindcss)
- Includes `catalogs-sort` rules for consistent dependency catalog ordering

## Tailwind CSS

No extra setup is required in most projects:

- Tailwind v4: auto-detects a CSS entry that imports `tailwindcss`
- Tailwind v3: auto-detects `tailwind.config.*`

You can still override with `settings.entryPoint` or `settings.tailwindConfig`
when needed.

## Credits

Inspired by
[`@antfu/eslint-config`](https://github.com/antfu/eslint-config)
and
[`eslint-config-hyoban`](https://github.com/hyoban/eslint-config-hyoban).

## License

[MIT](./LICENSE) License © [jinghaihan](https://github.com/jinghaihan)

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@octohash/eslint-config?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/@octohash/eslint-config
[npm-downloads-src]: https://img.shields.io/npm/dm/@octohash/eslint-config?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/@octohash/eslint-config
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@octohash/eslint-config?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=@octohash/eslint-config
[license-src]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/jinghaihan/@octohash/eslint-config/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/@octohash/eslint-config
npm package: @octohash/tsconfig
Description: Shared TypeScript config for my projects.
Author: jinghaihan
Latest version: 0.2.0

# @octohash/tsconfig

Shared TypeScript configuration presets for different environments.

```sh
pnpm add -D @octohash/tsconfig
```

## Usage

Extend one of the provided configurations in your tsconfig.json based on your project type:

```json
{
  // base | node | web | library
  "extends": "@octohash/tsconfig/web.json"
}
```

## Recommendation

Choose the preset that most closely matches your project environment:

+ `node.json` for backend/Node.js projects

+ `web.json` for frontend/browser projects

+ `library.json` when building shareable libraries

+ `base.json` as a starting point for custom configurations

You can always extend and override specific settings in your project's tsconfig.json as needed.

## License

[MIT](./LICENSE) License © [jinghaihan](https://github.com/jinghaihan)
npm package: @octojessi/5-min-demo-rhoticity
Description: Functions for working with the Fibonacci sequence and things
Author: rhoticity
Latest version: 6.0.8

| Linux | Windows | MacOS|
|-------|-------|-------|
| ![](https://github.com/rebelware/fibonacci-generator/workflows/node-ci/badge.svg)  | ![](https://github.com/rebelware/fibonacci-generator/workflows/node-ci/badge.svg) | ![](https://github.com/rebelware/fibonacci-generator/workflows/node-ci/badge.svg) |
# fib-tools

## Get the nth Number

```javascript
const {getNumber} = require('@bbq-beets/fib-tools')
assert.strictEqual(getNumber(8), 21)
```

## Get a List of Numbers

```javascript
const {getList} = require('@bbq-beets/fib-tools')
assert.strictDeepEqual(getList(8), [0, 1, 1, 2, 3, 5, 8, 13, 21])
```

## Get a Sequence of Numbers   

```javascript   
const {getSequence} = require('@bbq-beets/fib-tools')

const seq = getSequence()

for (const n of seq) {
  console.log(n) // The next Fibonacci number in the sequence
}
```
## Code Scanning Demo

This repository demonstrates an instance of CWE-020: Improper Imput Validation. 

1. Run through the setup flow in the security tab to enable code scanning. Commit directly to master. 
2. Go to actions, and confirm that the analysis has run successfully.
3. Edit script.js and add this code snippet. Create a PR. Wait for validation. 

```js

function endsWith(x, y) {
  return x.lastIndexOf(y) === x.length - y.length;
}

```
npm package: @octojessi/5-min-demo-rhoticity-2
Description: Functions for working with the Fibonacci sequence and things
Author: rhoticity
Latest version: 6.3.3

| Linux | Windows | MacOS|
|-------|-------|-------|
| ![](https://github.com/rebelware/fibonacci-generator/workflows/node-ci/badge.svg)  | ![](https://github.com/rebelware/fibonacci-generator/workflows/node-ci/badge.svg) | ![](https://github.com/rebelware/fibonacci-generator/workflows/node-ci/badge.svg) |
# fib-tools

## Get the nth Number

```javascript
const {getNumber} = require('@bbq-beets/fib-tools')
assert.strictEqual(getNumber(8), 21)
```

## Get a List of Numbers

```javascript
const {getList} = require('@bbq-beets/fib-tools')
assert.strictDeepEqual(getList(8), [0, 1, 1, 2, 3, 5, 8, 13, 21])
```

## Get a Sequence of Numbers   

```javascript   
const {getSequence} = require('@bbq-beets/fib-tools')

const seq = getSequence()

for (const n of seq) {
  console.log(n) // The next Fibonacci number in the sequence
}
```
## Code Scanning Demo

This repository demonstrates an instance of CWE-020: Improper Imput Validation. 

1. Run through the setup flow in the security tab to enable code scanning. Commit directly to master. 
2. Go to actions, and confirm that the analysis has run successfully.
3. Edit script.js and add this code snippet. Create a PR. Wait for validation. 

```js

function endsWith(x, y) {
  return x.lastIndexOf(y) === x.length - y.length;
}

```
npm package: @octojessi/actions-deploy-demo
Description: Functions for working with the Fibonacci sequence
Author: Jessi Moths
Latest version: 4.5.16

# fib-tools

![](https://github.com/bbq-beets/fib-tools/workflows/CI/badge.svg)

## Get the nth Number

```javascript
const {getNumber} = require('@bbq-beets/fib-tools')
assert.strictEqual(getNumber(8), 21)
```asdfasdfadsf

## Get a List of Numbers

```javascript
const {getList} = require('@bbq-beets/fib-tools')
assert.strictDeepEqual(getList(8), [0, 1, 1, 2, 3, 5, 8, 13, 21])
```

## Get a Sequence of Numbers

```javascript
const {getSequence} = require('@bbq-beets/fib-tools')

const seq = getSequence()

for (const n of seq) {
  console.log(n) // The next Fibonacci number in the sequence
}
```
npm package: @octokit-next/request-error
Description: Error class for Octokit request errors
Author: Gregor Martynus
Latest version: 3.0.0

# request-error.js

> Error class for Octokit request errors

[![@latest](https://img.shields.io/npm/v/@octokit-next/request-error.svg)](https://www.npmjs.com/package/@octokit-next/request-error)
[![Build Status](https://github.com/octokit-next/request-error.js/workflows/Test/badge.svg)](https://github.com/octokit-next/request-error.js/actions?query=workflow%3ATest)

## Usage

<table>
<tbody valign=top align=left>
<tr><th>
Browsers
</th><td width=100%>
Load <code>@octokit-next/request-error</code> directly from <a href="https://cdn.skypack.dev">cdn.skypack.dev</a>
        
```html
<script type="module">
import { RequestError } from "https://cdn.skypack.dev/@octokit-next/request-error";
</script>
```

</td></tr>
<tr><th>
Node
</th><td>

Install with <code>npm install @octokit-next/request-error</code>

```js
import { RequestError } from "@octokit-next/request-error";
```

</td></tr>
</tbody>
</table>

```js
const error = new RequestError("Oops", 500, {
  request: {
    method: "POST",
    url: "https://api.github.com/foo",
    body: {
      bar: "baz",
    },
    headers: {
      authorization: "token secret123",
    },
  },
  response: {
    status: 500,
    url: "https://api.github.com/foo"
    headers: {
      "x-github-request-id": "1:2:3:4",
    },
    data: {
      foo: "bar"
    }
  },
});

error.message; // Oops
error.status; // 500
error.request; // { method, url, headers, body }
error.response; // { url, status, headers, data }
```

## LICENSE

[MIT](LICENSE)
npm package: @octokit-next/types
Description: Shared TypeScript definitions for upcoming Octokit SDK
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types`

> Shared TypeScript definitions for upcoming Octokit SDK

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-openapi
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghec
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghec

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghec";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghec-diff-to-api.github.com
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghec-diff-to-api.github.com

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghec-diff-to-api.github.com";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.0
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 2.5.2

# @octokit-next/types-openapi-ghes-3.0

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.0";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.0-diff-to-ghes-3.1
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 2.5.2

# @octokit-next/types-openapi-ghes-3.0-diff-to-ghes-3.1

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.0-diff-to-ghes-3.1";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.1
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 2.5.2

# @octokit-next/types-openapi-ghes-3.1

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.1";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.1-diff-to-ghes-3.2
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 2.5.2

# @octokit-next/types-openapi-ghes-3.1-diff-to-ghes-3.2

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.1-diff-to-ghes-3.2";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.2
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.2

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.2";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.2-diff-to-api.github.com
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 2.5.2

# @octokit-next/types-openapi-ghes-3.2-diff-to-api.github.com

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.2-diff-to-api.github.com";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.2-diff-to-ghes-3.3
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.2-diff-to-ghes-3.3

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.2-diff-to-ghes-3.3";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.3
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.3

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.3";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.3-diff-to-ghes-3.4
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.3-diff-to-ghes-3.4

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.3-diff-to-ghes-3.4";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.4
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.4

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.4";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.4-diff-to-ghes-3.5
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.4-diff-to-ghes-3.5

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.4-diff-to-ghes-3.5";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.5
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.5

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.5";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.5-diff-to-ghes-3.6
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.5-diff-to-ghes-3.6

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.5-diff-to-ghes-3.6";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.6
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.6

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.6";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-ghes-3.6-diff-to-api.github.com
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-ghes-3.6-diff-to-api.github.com

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-ghes-3.6-diff-to-api.github.com";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-github.ae
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-github.ae

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-github.ae";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-openapi-github.ae-diff-to-api.github.com
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 3.0.0

# @octokit-next/types-openapi-github.ae-diff-to-api.github.com

> Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com

This package is continously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/)

## Usage

```ts
import { components } from "@octokit-next/types-openapi-github.ae-diff-to-api.github.com";

type Repository = components["schemas"]["full-repository"];
```

## License

[MIT](LICENSE)
npm package: @octokit-next/types-rest-api
Description: Types for github.com REST API requests and responses
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api`

> Types for github.com REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

## Usage

Importing the package will add all of GitHub's REST API endpoints to the `Octokit.ApiVersions["github.com"]` interface

```ts
import "@octokit-next/types-rest-api";
```

The package also exports an `Operation` generic which turns a REST API endpoint defined in a transpiled OpenAPI spec to an `Endpoint` object with `parameters`, `request`, and `response` keys.

```ts
import { paths } from "@octokit-next/types-openapi";
import { Operation } from "@octokit-next/types-rest-api";

type MyEndpoint = Operation<paths, "GET", "/">;
```

The `Operation` call signature is

```ts
Operation<paths, method, path[, requiredPreview]>
```

- `paths` is the paths object from a transpiled OpenAPI spec using [`openapi-typescript`](https://github.com/drwpow/`openapi-typescript), such as any of the `@octokit-next/types-openapi*` packages
- `method` is the HTTP method, such as `get`, `post`, `patch`, etc. (lowercase)
- `path` is the path to the endpoint, such as `/repos/:owner/:repo`
- `requiredPreview` is a string of the name of the preview if one is required in order to use that endpoint
npm package: @octokit-next/types-rest-api-ghec
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for GHEC
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghec`

> Types for GHEC REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-ghec-compatible
Description: Types for GHEC (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghec-compatible`

> Types for GHEC (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GHEC. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "ghec-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "ghec"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "ghec",
  },
});
```
npm package: @octokit-next/types-rest-api-ghes-3.0
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 2.5.2

# `@octokit-next/types-rest-api-ghes-3.0`

> Types for GHES 3.0 REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-ghes-3.0-compatible
Description: Types for GHES 3.0 (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 2.5.2

# `@octokit-next/types-rest-api-ghes-3.0-compatible`

> Types for GHES 3.0 (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GHES 3.0. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "ghes-3.0-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "ghes-3.0"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "ghes-3.0",
  },
});
```
npm package: @octokit-next/types-rest-api-ghes-3.1
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
Author: Gregor Martynus
Latest version: 2.5.2

# `@octokit-next/types-rest-api-ghes-3.1`

> Types for GHES 3.1 REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-ghes-3.1-compatible
Description: Types for GHES 3.1 (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 2.5.2

# `@octokit-next/types-rest-api-ghes-3.1-compatible`

> Types for GHES 3.1 (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GHES 3.1. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "ghes-3.1-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "ghes-3.1"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "ghes-3.1",
  },
});
```
npm package: @octokit-next/types-rest-api-ghes-3.2
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for GHES 3.2
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.2`

> Types for GHES 3.2 REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-ghes-3.2-compatible
Description: Types for GHES 3.2 (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.2-compatible`

> Types for GHES 3.2 (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GHES 3.2. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "ghes-3.2-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "ghes-3.2"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "ghes-3.2",
  },
});
```
npm package: @octokit-next/types-rest-api-ghes-3.3
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for GHES 3.3
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.3`

> Types for GHES 3.3 REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-ghes-3.3-compatible
Description: Types for GHES 3.3 (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.3-compatible`

> Types for GHES 3.3 (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GHES 3.3. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "ghes-3.3-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "ghes-3.3"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "ghes-3.3",
  },
});
```
npm package: @octokit-next/types-rest-api-ghes-3.4
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for GHES 3.4
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.4`

> Types for GHES 3.4 REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-ghes-3.4-compatible
Description: Types for GHES 3.4 (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.4-compatible`

> Types for GHES 3.4 (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GHES 3.4. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "ghes-3.4-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "ghes-3.4"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "ghes-3.4",
  },
});
```
npm package: @octokit-next/types-rest-api-ghes-3.5
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for GHES 3.5
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.5`

> Types for GHES 3.5 REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-ghes-3.5-compatible
Description: Types for GHES 3.5 (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.5-compatible`

> Types for GHES 3.5 (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GHES 3.5. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "ghes-3.5-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "ghes-3.5"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "ghes-3.5",
  },
});
```
npm package: @octokit-next/types-rest-api-ghes-3.6
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for GHES 3.6
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.6`

> Types for GHES 3.6 REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-ghes-3.6-compatible
Description: Types for GHES 3.6 (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-ghes-3.6-compatible`

> Types for GHES 3.6 (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GHES 3.6. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "ghes-3.6-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "ghes-3.6"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "ghes-3.6",
  },
});
```
npm package: @octokit-next/types-rest-api-github.ae
Description: Generated TypeScript definitions based on GitHub's OpenAPI spec for GITHUB.AE
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-github.ae`

> Types for GITHUB.AE REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit-next/types-rest-api-github.ae-compatible
Description: Types for GITHUB.AE (compatible) REST API requests and responses
Author: Gregor Martynus
Latest version: 3.0.0

# `@octokit-next/types-rest-api-github.ae-compatible`

> Types for GITHUB.AE (compatible) REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)

The goal for this package is to enable developers to build code that will work in both environments: github.com and GITHUB.AE. Only endpoints and properties that exist in both have types by default.

The version can be overwritten on a per-request basis as needed.

## Usage

```ts
const octokit = new Octokit({
  version: "github.ae-compatible",
});
const response = await octokit.request("GET /");
```

The routes suggested for `octokit.request(route)` are only the ones that exist for `version: "github.com"` and have no overrides for `version: "github.ae"`. The same is true for `response.headers`.

To override the version specified in the constructor it can be set using the `request.version` option

```ts
const ghesOnlyResponse = await octokit.request("GET /admins/users", {
  request: {
    version: "github.ae",
  },
});
```
npm package: @octokit-next/types-rest-api-github.com
Description: Types for github.com REST API requests and responses
Author: Gregor Martynus
Latest version: 1.7.1

# `@octokit-next/types-rest-api-github.com`

> Types for github.com REST API requests and responses

🚫⚠️ This package is part of an experimental Octokit SDK for testing purpose only - DO NOT USE

[learn more](https://github.com/octokit/octokit-next.js)
npm package: @octokit/app-permissions
Description: machine-readable, always up-to-date GitHub App permissions
Author: Gregor Martynus
Latest version: 2.1.0

# app-permissions

> machine-readable, always up-to-date GitHub App permissions

This repository is scraping the [Permissions required for GitHub Apps](https://docs.github.com/en/rest/reference/permissions-required-for-github-apps) app on an hourly basis and generates the [`generated/api.github.com.json`](generated/api.github.com.json) file.

## Usage

The structure of the JSON export looks like this

```
permissions
  api.github.com
    permissions
      [name of permission]
        url # documentation URL
        read # array of routes with read access
        write # array of routes with write access
    paths
      [http path]
        [http method]
          permission # name of permission
          access # "read" or "write"
```

### Node.js

```js
const appPermissions = require("@octokit/app-permissions");

const createIssuePermissions =
  appPermissions["api.github.com"].paths["/repos/{owner}/{repo}/issues"].post;
console.log(
  `Required app permissions to create an issue: %o`,
  createIssuePermissions,
);

const issuesPermission = appPermissions["api.github.com"].permissions.issues;
console.log(`"issues" read access paths: %o`, issuesPermission.read);
console.log(`"issues" write access paths: %o`, issuesPermission.write);
```

### Download

All generated JSON files are uploaded as assets to each [GitHub release](https://github.com/octokit/app-permissions/releases)

## See also

- [octokit/graphql-schema](https://github.com/octokit/graphql-schema) – GitHub’s GraphQL Schema with validation
- [octokit/openapi](https://github.com/octokit/openapi) – GitHub REST API route specifications
- [octokit/webhooks](https://github.com/octokit/webhooks) – GitHub Webhooks specifications

## License

[MIT](LICENSE)
npm package: @octokit/graphql-schema
Description: GitHub's GraphQL Schema with validation. Automatically updated.
Author: Gregor Martynus
Latest version: 15.26.1

# graphql-schema

> GitHub’s GraphQL Schema with validation. Automatically updated.

![Test](https://github.com/octokit/graphql-schema/workflows/Test/badge.svg)

## Usage

### Validation

```js
import { validate } from "@octokit/graphql-schema";
const errors = validate(`
{
  viewer {
    login
  }
}
`);

// errors is array. Contains errors if any
```

You can also load the current Schema directly as JSON or [IDL](https://en.wikipedia.org/wiki/Interface_description_language).

```js
import { schema } from "@octokit/graphql-schema";
schema.json; // JSON version
schema.idl; // IDL version
```

### Schema as Types

```ts
import { graphql } from "@octokit/graphql";
import { Repository } from "@octokit/graphql-schema";

const { repository } = await graphql<{ repository: Repository }>(
  `
    {
      repository(owner: "octokit", name: "graphql.js") {
        issues(last: 3) {
          edges {
            node {
              title
            }
          }
        }
      }
    }
  `,
  {
    headers: {
      authorization: `token secret123`,
    },
  },
);
```

## Local setup

```
git clone https://github.com/octokit/graphql-schema.git
cd graphql-schema
npm install
npm test
```

Update schema files (`GITHUB_TOKEN` requires no scope)

```
GITHUB_TOKEN=... npm run update
```

## See also

- [octokit/openapi](https://github.com/octokit/openapi) – GitHub's OpenAPI specification with `x-octokit` extension
- [octokit/webhooks](https://github.com/octokit/webhooks) – GitHub Webhooks specifications
- [octokit/app-permissions](https://github.com/octokit/app-permissions) – GitHub App permission specifications

## LICENSE

[MIT](LICENSE.md)
npm package: @octokit/openapi
Description: GitHub's official OpenAPI spec with Octokit extensions
Author: Gregor Martynus
Latest version: 22.0.0

# openapi

> GitHub's official OpenAPI spec with Octokit extensions

[![@latest](https://img.shields.io/npm/v/@octokit/openapi.svg)](https://www.npmjs.com/package/@octokit/openapi)

Amends operations from [GitHub's official OpenAPI specification](https://github.com/github/rest-api-description/) with an `x-octokit` extension that includes the following keys

- `changes`: see change files in [changes/](changes/)

## Download

Download from https://unpkg.com/browse/@octokit/openapi/generated/

## Node Usage

```js
const { schemas } = require("@octokit/openapi");
const version = schemas["api.github.com"].info.version;
const paths = Object.keys(schemas["api.github.com"].paths).sort();
```

## GitHub Actions usage

1. Install [Octokit Release Notifier app](https://github.com/apps/octokit-release-notifier/)
2. Create a new workflow file:

```yml
name: Update OpenAPI
on:
  repository_dispatch:
    types: [octokit/openapi release]

jobs:
  published:
    runs-on: ubuntu-latest
    steps:
      - run: "echo: 'new release: ${{ github.event.release.tag_name }}'"
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

[MIT](LICENSE)