v7

.changeset/empty-eagles-rule.md

@@ -0,0 +1,5 @@
+---
+'@sumup/foundry': major
+---
+
+Added support for [`eslint-plugin-storybook`](https://github.com/storybookjs/eslint-plugin-storybook). This plugin helps conform to [Storybook](https://storybook.js.org/)'s best practices.

.changeset/four-crews-admire.md

@@ -0,0 +1,5 @@
+---
+"@sumup/foundry": major
+---
+
+Upgraded to [Stylelint 16](https://github.com/stylelint/stylelint/blob/main/CHANGELOG.md#1600). Refer to the [migration guide](https://github.com/stylelint/stylelint/blob/main/docs/migration-guide/to-16.md).

.changeset/fresh-hounds-pretend.md

@@ -0,0 +1,5 @@
+---
+'@sumup/foundry': major
+---
+
+Upgraded to Prettier v3. [Read the release announcement](https://prettier.io/blog/2023/07/05/3.0.0.html).

.changeset/fuzzy-bees-build.md

@@ -0,0 +1,5 @@
+---
+'@sumup/foundry': major
+---
+
+Upgraded `@typescript-eslint/typescript-eslint` to v6. Read the [changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/CHANGELOG.md).

.changeset/green-wasps-repeat.md

@@ -0,0 +1,5 @@
+---
+"@sumup/foundry": minor
+---
+
+Expanded the scope of the Cypress and Playwright plugins to account for end-to-end test in subdirectories.

.changeset/little-pants-attend.md

@@ -0,0 +1,5 @@
+---
+'@sumup/foundry': major
+---
+
+Upgraded `eslint-plugin-testing-library` to v6. Read the [migration guide](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/migration-guides/v6.md).

.changeset/nervous-dolphins-fix.md

@@ -0,0 +1,5 @@
+---
+"@sumup/foundry": minor
+---
+
+Added a new `debug` command to inspect the detected configuration options.

.changeset/plenty-needles-hunt.md

@@ -0,0 +1,5 @@
+---
+'@sumup/foundry': major
+---
+
+Removed the ESLint plugins for [Cypress](https://www.npmjs.com/package/eslint-plugin-cypress), [Emotion](https://www.npmjs.com/package/@emotion/eslint-plugin), [Jest](https://www.npmjs.com/package/eslint-plugin-jest), [Next.js](https://www.npmjs.com/package/eslint-config-next), [Playwright](https://www.npmjs.com/package/eslint-plugin-playwright), [Storybook](https://www.npmjs.com/package/eslint-plugin-storybook), and [Testing Library](https://www.npmjs.com/package/eslint-plugin-testing-library) from the dependencies. Install the plugins as dev dependencies in your project. Foundry still enables and configures them automatically.

.changeset/pre.json

@@ -0,0 +1,22 @@
+{
+  "mode": "exit",
+  "tag": "next",
+  "initialVersions": {
+    "@sumup/foundry": "6.1.0"
+  },
+  "changesets": [
+    "empty-eagles-rule",
+    "four-crews-admire",
+    "fresh-hounds-pretend",
+    "fuzzy-bees-build",
+    "green-wasps-repeat",
+    "little-pants-attend",
+    "nervous-dolphins-fix",
+    "plenty-needles-hunt",
+    "silly-seals-arrive",
+    "twelve-pandas-listen",
+    "twenty-comics-laugh",
+    "warm-apples-greet",
+    "wicked-trees-join"
+  ]
+}

.changeset/silly-seals-arrive.md

@@ -0,0 +1,5 @@
+---
+"@sumup/foundry": minor
+---
+
+Removed the obsolete `publish` option which hasn't been used since v6.

.changeset/twelve-pandas-listen.md

@@ -0,0 +1,5 @@
+---
+'@sumup/foundry': minor
+---
+
+Added support for [`@sumup/eslint-plugin-circuit-ui`](https://circuit.sumup.com/?path=/docs/packages-eslint-plugin-circuit-ui--docs). This plugin helps users follow best practices when using [Circuit UI](https://circuit.sumup.com/).

.changeset/twenty-comics-laugh.md

@@ -0,0 +1,5 @@
+---
+"@sumup/foundry": patch
+---
+
+Improved package version detection to handle tarball URLs and fail gracefully.

.changeset/warm-apples-greet.md

@@ -0,0 +1,5 @@
+---
+'@sumup/foundry': major
+---
+
+Added [`eslint-plugin-security`](https://github.com/eslint-community/eslint-plugin-security) for Node environments. This plugin helps identify potential security hotspots, but finds a lot of false positives which need triage by a human.

.changeset/wicked-trees-join.md

@@ -0,0 +1,5 @@
+---
+'@sumup/foundry': major
+---
+
+Raised the minimum Node version to ^18.12 || >=20 (i.e. Node 19 is not supported).

.github/workflows/ci.yaml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [16, 18]
+        node: [18, 20]
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.gitignore

@@ -5,6 +5,7 @@ dist
 public
 jest-test-results.json
 junit.xml
+coverage
 __coverage__
 __reports__
 .npm

.nvmrc

@@ -1 +1 @@
-lts/hydrogen
+lts/iron

README.md

@@ -24,28 +24,18 @@ A toolkit that makes it a breeze to set up and maintain JavaScript + TypeScript
 
 ### Installation
 
-Foundry needs to be installed as a dev-dependency via the [npm](https://www.npmjs.com) or [Yarn](https://classic.yarnpkg.com) package managers. The npm CLI ships with [Node](https://nodejs.org/en/). You can read how to install the Yarn CLI in [their documentation](https://classic.yarnpkg.com/en/docs/install). Foundry requires Node `^14.17 || >=16`.
-
-Depending on your preference, run one of the following.
+Foundry should be installed as a dev-dependency. Run the following command in your terminal:
 
 ```sh
-# With npm
-$ npm install --save-dev @sumup/foundry
-
-# With Yarn v1
-$ yarn add --dev @sumup/foundry
+npm install --save-dev @sumup/foundry
 ```
 
 ### Initialization
 
 Foundry exposes customizable configurations for the CLI tools it supports. Use the `init` command to initialize a configuration file for the tools you would like to use:
 
 ```sh
-# With npm
-$ npx foundry init
-
-# With Yarn v1
-$ yarn run foundry init
+npx foundry init
 ```
 
 Foundry will launch an interactive prompt to ask you questions about your project, such as whether you are planning to open source it. Once you have answered all questions, Foundry will write the config files (don't worry, it asks before overwriting existing files) and will add scripts to your `package.json` file to conveniently run the tools.
@@ -54,7 +44,6 @@ Alternatively, you can pass your answers to the `init` command directly as flags
 
 ```sh
   -o, --openSource  Whether the project is open-source                 [boolean]
-      --publish     Whether to publish to NPM                          [boolean]
   -c, --configDir   The directory to write configs to    [string] [default: "."]
       --overwrite   Whether to overwrite existing config files
                                                       [boolean] [default: false]
@@ -79,7 +68,13 @@ module.exports = require('@sumup/foundry/eslint')({
 
 The overrides are merged with Foundry's default configuration. The overrides follow each tool's configuration schema, please refer to their official documentation.
 
-Foundry analyzes your project's `package.json` file to tailor the configurations to your project. If the automatic detection is inaccurate, [please open an issue](https://github.com/sumup-oss/foundry/issues/new/choose) so we can improve it for everyone. Alternatively, you can explicitly set the options under the `foundry` property in your `package.json` file:
+Foundry analyzes your project's dependencies to tailor the configurations to your project. It detects which ESLint plugins are installed and enables & configures them automatically. Foundry will warn you if a framework is installed but not its corresponding ESLint plugin or if a version of a plugin is installed hasn't been tested with Foundry. Use the `debug` command to inspect the detected configuration:
+
+```sh
+npx foundry debug
+```
+
+If the automatic detection is inaccurate, [please open an issue](https://github.com/sumup-oss/foundry/issues/new/choose) so we can improve it for everyone. Alternatively, you can explicitly set the options under the `foundry` property in your `package.json` file:
 
 ```json
 // package.json
@@ -92,12 +87,13 @@ Foundry analyzes your project's `package.json` file to tailor the configurations
 
 The supported options are:
 
-| Name         | Type    | Options                                                                           | Default        |
-| ------------ | ------- | --------------------------------------------------------------------------------- | -------------- |
-| language     | string  | 'TypeScript', 'JavaScript'                                                        | _autodetected_ |
-| environments | array   | 'Browser', 'Node'                                                                 | _autodetected_ |
-| frameworks   | array   | 'React', 'Next.js', 'Emotion', 'Jest', 'Testing Library', 'Cypress', 'Playwright' | _autodetected_ |
-| openSource   | boolean | true, false                                                                       | _autodetected_ |
+| Name         | Type    | Options                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| ------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| language     | string  | 'TypeScript', 'JavaScript'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| environments | array   | 'Browser', 'Node'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| plugins      | array   | ['Circuit UI'](https://www.npmjs.com/package/@sumup/eslint-plugin-circuit-ui), ['Cypress'](https://www.npmjs.com/package/eslint-plugin-cypress), ['Emotion'](https://www.npmjs.com/package/@emotion/eslint-plugin), ['Jest'](https://www.npmjs.com/package/eslint-plugin-jest), ['Next.js'](https://www.npmjs.com/package/eslint-config-next), ['Playwright'](https://www.npmjs.com/package/eslint-plugin-playwright), ['Storybook'](https://www.npmjs.com/package/eslint-plugin-storybook), ['Testing Library'](https://www.npmjs.com/package/eslint-plugin-testing-library) |
+| frameworks   | array   | 'Next.js', 'React'                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| openSource   | boolean | true, false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 
 ## Lint preset
 
@@ -119,11 +115,7 @@ The preset includes the following tools:
 Foundry manages all supported tools for you and exposes them via the `run` command. As an example, to run ESLint through Foundry, execute:
 
 ```sh
-# With npm
-$ npx foundry run eslint src
-
-# With Yarn v1
-$ yarn foundry run eslint src
+npx foundry run eslint src
 ```
 
 Here, `src` is the folder you want ESLint to check. Note that you can use any of the command-line flags and arguments supported by ESLint and other tools. Foundry forwards them so they get handled by the tool. For example, to have ESLint fix your linting errors, run `npx foundry run eslint --fix src`.