Skip to content

Commit a927994

Browse files
committed
fix(create-eslint-config): add license file
1 parent 6a77a91 commit a927994

5 files changed

Lines changed: 58 additions & 30 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# @code-pushup/eslint-config
22

3-
[![npm](https://img.shields.io/npm/v/%40code-pushup%2Feslint-config.svg)](https://www.npmjs.com/package/@code-pushup/eslint-config)
3+
[![version](https://img.shields.io/github/v/release/code-pushup/eslint-config)](https://github.com/code-pushup/eslint-config/releases/latest)
4+
[![release date](https://img.shields.io/github/release-date/code-pushup/eslint-config)](https://github.com/code-pushup/eslint-config/releases)
5+
[![commit activity](https://img.shields.io/github/commit-activity/m/code-pushup/eslint-config)](https://github.com/code-pushup/eslint-config/pulse/monthly)
6+
[![license](https://img.shields.io/github/license/code-pushup/eslint-config)](https://opensource.org/licenses/MIT)
47
[![CI](https://github.com/code-pushup/eslint-config/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/code-pushup/eslint-config/actions/workflows/ci.yml?query=branch%3Amain)
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
68

79
Monorepo for [Code PushUp](https://github.com/code-pushup/cli) ESLint packages.
810

911
## Packages
1012

11-
| Package | Description |
12-
| :------------------------------------------------------------------- | :------------------------------------------- |
13-
| [`@code-pushup/eslint-config`](./packages/eslint-config/README.md) | Recommended ESLint presets by Code PushUp |
13+
| Package | Description |
14+
| :------------------------------------------------------------------------------- | :-------------------------------------------------------- |
15+
| [`@code-pushup/eslint-config`](./packages/eslint-config/README.md) | Recommended ESLint presets by Code PushUp |
1416
| [`@code-pushup/create-eslint-config`](./packages/create-eslint-config/README.md) | Interactive setup wizard for `@code-pushup/eslint-config` |

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"name": "@code-pushup/eslint-config-workspace",
33
"private": true,
4+
"license": "MIT",
45
"type": "module",
56
"scripts": {
67
"prepare": "husky install",
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Code PushUp
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

packages/create-eslint-config/README.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# @code-pushup/create-eslint-config
22

33
[![npm](https://img.shields.io/npm/v/%40code-pushup%2Fcreate-eslint-config.svg)](https://www.npmjs.com/package/@code-pushup/create-eslint-config)
4-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4+
[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Fcreate-eslint-config)](https://npmtrends.com/@code-pushup/create-eslint-config)
5+
[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup/create-eslint-config)](https://www.npmjs.com/package/@code-pushup/create-eslint-config?activeTab=dependencies)
6+
[![license](https://img.shields.io/npm/l/%40code-pushup%2Fcreate-eslint-config)](https://opensource.org/licenses/MIT)
57

68
Interactive setup wizard for [`@code-pushup/eslint-config`](../eslint-config/README.md).
79

@@ -31,14 +33,14 @@ npm init @code-pushup/eslint-config -- --yes
3133

3234
### Options
3335

34-
| Option | Type | Default | Description |
35-
| --------------------------- | ------------------------------------------------ | ------------- | ---------------------------------- |
36-
| **`--configs`** | `string[]` | | Configs to include |
37-
| **`--tsconfig`** | `string` | auto-detected | Path to tsconfig |
38-
| **`--node-version-source`** | `'node-version'` \| `'engines'` \| `'manual'` | auto-detected | Where to read the Node version |
39-
| **`--node-version`** | `string` | | Node version range (e.g. `>=20.0.0`) |
40-
| **`--dry-run`** | `boolean` | `false` | Preview changes without writing |
41-
| **`--yes`**, `-y` | `boolean` | `false` | Skip prompts and use defaults |
36+
| Option | Type | Default | Description |
37+
| --------------------------- | --------------------------------------------- | ------------- | ------------------------------------ |
38+
| **`--configs`** | `string[]` | | Configs to include |
39+
| **`--tsconfig`** | `string` | auto-detected | Path to tsconfig |
40+
| **`--node-version-source`** | `'node-version'` \| `'engines'` \| `'manual'` | auto-detected | Where to read the Node version |
41+
| **`--node-version`** | `string` | | Node version range (e.g. `>=20.0.0`) |
42+
| **`--dry-run`** | `boolean` | `false` | Preview changes without writing |
43+
| **`--yes`**, `-y` | `boolean` | `false` | Skip prompts and use defaults |
4244

4345
### Programmatic API
4446

@@ -56,20 +58,20 @@ const result = await runSetupWizard({
5658

5759
## Available configs
5860

59-
| Slug | Detected when |
60-
| ------------------------ | -------------------------------------------------- |
61-
| `javascript` | Always recommended |
62-
| `typescript` | `tsconfig.json` exists or `typescript` is installed |
63-
| `node` | Backend/full-stack framework is installed |
64-
| `angular` | `@angular/core` is installed |
65-
| `ngrx` | `@ngrx/core` is installed |
66-
| `react` | `react` is installed |
67-
| `graphql` | GraphQL server package is installed |
68-
| `jest` | `jest` is installed or config file exists |
69-
| `vitest` | `vitest` is installed or config file exists |
70-
| `cypress` | `cypress` is installed or config file exists |
71-
| `playwright` | `@playwright/test` is installed or config exists |
72-
| `storybook` | `storybook` is installed or `.storybook` exists |
73-
| `react-testing-library` | `@testing-library/react` is installed |
61+
| Slug | Detected when |
62+
| ----------------------- | --------------------------------------------------- |
63+
| `javascript` | Always recommended |
64+
| `typescript` | `tsconfig.json` exists or `typescript` is installed |
65+
| `node` | Backend/full-stack framework is installed |
66+
| `angular` | `@angular/core` is installed |
67+
| `ngrx` | `@ngrx/core` is installed |
68+
| `react` | `react` is installed |
69+
| `graphql` | GraphQL server package is installed |
70+
| `jest` | `jest` is installed or config file exists |
71+
| `vitest` | `vitest` is installed or config file exists |
72+
| `cypress` | `cypress` is installed or config file exists |
73+
| `playwright` | `@playwright/test` is installed or config exists |
74+
| `storybook` | `storybook` is installed or `.storybook` exists |
75+
| `react-testing-library` | `@testing-library/react` is installed |
7476

7577
Configs follow an inheritance hierarchy. Selecting a child preset subsumes its parent. For example, picking `typescript` automatically includes `javascript`.

packages/eslint-config/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# @code-pushup/eslint-config
22

33
[![npm](https://img.shields.io/npm/v/%40code-pushup%2Feslint-config.svg)](https://www.npmjs.com/package/@code-pushup/eslint-config)
4-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4+
[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Feslint-config)](https://npmtrends.com/@code-pushup/eslint-config)
5+
[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup/eslint-config)](https://www.npmjs.com/package/@code-pushup/eslint-config?activeTab=dependencies)
6+
[![license](https://img.shields.io/npm/l/%40code-pushup%2Feslint-config)](https://opensource.org/licenses/MIT)
57

68
Recommended ESLint presets by [Code PushUp](https://github.com/code-pushup/cli/tree/main/packages/cli).
79

0 commit comments

Comments
 (0)