@sumup/foundry

Foundry

A toolkit that makes it a breeze to set up and maintain JavaScript + TypeScript applications. Foundry has tools for 🔍 linting and currently supports Next.js, React, Emotion, Jest, Testing Library, Cypress, Playwright and Node.

Table of contents

• Getting Started
  • Installation
  • Initialization
  • Configuration
• Lint preset
• Running a tool
• Why?
• Code of conduct (CoC)
• About SumUp

Getting Started

Installation

Foundry should be installed as a dev-dependency. Run the following command in your terminal:

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:

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.

Alternatively, you can pass your answers to the init command directly as flags. This is useful for environments such as CI where interactive prompts cannot be used. Here is an overview of all available options (you can view this help menu by running npx foundry init --help):

  -o, --openSource  Whether the project is open-source                 [boolean]
  -c, --configDir   The directory to write configs to    [string] [default: "."]
      --overwrite   Whether to overwrite existing config files
                                                      [boolean] [default: false]
      --version     Show version number                                [boolean]
      --help        Show this help menu                                [boolean]

Configuration

All config files that are generated by Foundry follow the same format. They import a configuration function, optionally call it with overrides, and export the result. Here's an example:

module.exports = require('@sumup/foundry/<tool>')(overrides);

// Example for .eslintrc.js:
module.exports = require('@sumup/foundry/eslint')({
  rules: {
    '@emotion/jsx-import': 'error',
  },
});

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 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:

npx foundry debug

If the automatic detection is inaccurate, please open an issue so we can improve it for everyone. Alternatively, you can explicitly set the options under the foundry property in your package.json file:

// package.json
{
  "foundry": {
    "environments": ["Browser"]
  }
}

The supported options are:

Name	Type	Options
language	string	'TypeScript', 'JavaScript'
environments	array	'Browser', 'Node'
plugins	array	'Circuit UI', 'Cypress', 'Emotion', 'Jest', 'Next.js', 'Playwright', 'Storybook', 'Testing Library'
frameworks	array	'Next.js', 'React'
openSource	boolean	true, false

Lint preset

Check code for syntax errors and format it automatically. The preset adds the following scripts to your package.json:

• lint: check files for problematic patterns and report them
• lint:fix: same as lint, but also try to fix the issues

The preset includes the following tools:

• ESLint identifies and fixes problematic patterns in your code so you can spot mistakes early.
• Stylelint identifies and fixes problematic patterns in your styles so you can spot mistakes early.
• Prettier is our code formatter of choice. It makes all our code look the same after every save.
• lint-staged is a tool for running linters on files staged for your next commit in git. Together with Husky (see below) it prevents problematic code from being committed.
• Husky makes setting up git hooks very easy. Whenever someone installs your project, Husky will automatically set up git hooks as part of its postinstall script.

Running a tool

Foundry manages all supported tools for you and exposes them via the run command. As an example, to run ESLint through Foundry, execute:

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.

Why?

TL;DR

Creating and maintaining a JavaScript project can be very tedious. There are tools, configurations, dependency management, and boilerplate. With Foundry, you can fix all of that with a single dependency. It lints, creates files, and keeps the tools up to date. And the best part? You can still get down and dirty with your configurations. But only if you want.

The problem

Setting up and maintaining a complex JavaScript project can be very tedious. There are many different dependencies to install (linters, testing frameworks, bundlers) and configurations to set up. Once you have a running project, you end up writing a lot of boilerplate code when creating commonly used files. For example, a React component might come with a spec file (test), a Storybook file (isolated component development), and a service for handling business logic.

It gets much, much worse when you have several (many?) projects. What happens when there is a breaking change in a tooling dependency? What if a team decides you need to add a new linting rule? Nobody wants to go through every project and update those files all the time. And who knows, if they are even the same? Syncing configurations is terrible. Or think about that new engineer you are onboarding. How are they supposed to know how you structure your project, how your components are supposed to look, which files they need to create?

You might think you could solve these issues with a boilerplate repository and some snippets or templates. But you cannot. At least the maintenance problem will not go away.

The solution

Toolkits are a way to mitigate these kinds of problems. They encapsulate as much as possible of the toolchain into a single dependency and expose it through a CLI. Doing so gets you the following, probably more!

• You don't need to set up any tooling when creating a new project. Bootstrap it and start coding. :rocket:
• When you need to update a tooling dependency or change a configuration, do it in the toolkit and update the toolkit dependency in your projects — preferably in an automated fashion. That's it. :sparkles:
• Make the way you write JavaScript more consistent. All your projects will work exactly the same. :straight_ruler:
• Easy onboarding. New colleagues will be able to get productive much more quickly. 🙇‍♂️
• The number of direct dependencies becomes much smaller and your package.json shorter. :spider_web:

But what makes Foundry different?

We were inspired by many toolkit projects, such as create-react-app and kcd-scripts. These projects are opinionated, and so is Foundry. But Foundry is different, in our opinion, because:

• It encapsulates tools and their configuration, but also lets you get down and dirty with the configs in your project.
• It merely proxies the tools you use on a CLI level instead of talking to them through their Node.js APIs. We literally execute the binaries and forward any options you provided.

So please, go ahead and try it.

Code of Conduct (CoC)

We want to foster an inclusive and friendly community around our Open Source efforts. Like all SumUp Open Source projects, this project follows the Contributor Covenant Code of Conduct. Please, read it and follow it.

If you feel another member of the community violated our CoC or you are experiencing problems participating in our community because of another individual's behavior, please get in touch with our maintainers. We will enforce the CoC.

Maintainers

• Connor Bär
• Felix Jung

About SumUp

It is our mission to make easy and fast card payments a reality across the entire world. You can pay with SumUp in more than 30 countries already. Our engineers work in Berlin, Cologne, Sofia, and Sāo Paulo. They write code in TypeScript, Swift, Ruby, Go, Java, Erlang, Elixir, and more. Want to come work with us? Head to our careers page to find out more.

Changelog

7.2.0

Minor Changes

[!WARNING] > @sumup/foundry will be renamed to @sumup-oss/foundry in the next major release. v7.2 has been published under both names, so you can already migrate by updating the package name in your package.json file.

• #970 07cd253 Thanks @connor-baer! - Extended the supported version range for eslint-plugin-jest to include v28.x.