Skip to content

Reusable setup wizard for @code-pushup/eslint-config #45

@matejchalk

Description

@matejchalk

User story

Setting up @code-pushup/eslint-config may be relatively complex, because it depends on the user's tech stack. There is a variety of additional configurations and peer dependencies to install. Although the (generated) setup docs are extensive, it would be simpler if users could run a single npm init @code-pushup/eslint-config command and follow the prompts.

Aside from standalone usage, we can also reuse this logic for setting up @code-pushup/eslint-plugin with @code-pushup/create-cli. For more context, see the following Code PushUp CLI issue:

Implementation

See sub-issues.

Acceptance criteria

  • Both the existing @code-pushup/eslint-config and @code-pushup/create-eslint-config packages are published from the same monorepo.
  • The setup wizard may be run with npm init @code-pushup/eslint-config.
  • The setup wizard accepts a list of configs (with smart defaults) from the user.
  • The setup wizard creates or modifies an eslint.config.js and installs peer dependencies.
  • The setup wizard may be invoked programmatically. This will be used in Include @code-pushup/eslint-config in setup wizard cli#1262.

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions