10000 Switch to tool agnostic package naming (e.g. ethereumjs-config-prettier -> ...-format) · Issue #18 · ethereumjs/ethereumjs-config · GitHub
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Oct 30, 2024. It is now read-only.
This repository was archived by the owner on Oct 30, 2024. It is now read-only.
Switch to tool agnostic package naming (e.g. ethereumjs-config-prettier -> ...-format) #18
Closed
@holgerd77

Description

@holgerd77

I think the one suboptimal structural design decision we have here in the configuration packages is that packages are named after the tools and not somewhat more agnostic after the task type to be fulfilled/supported.

Package names should optimally rather be something like:

  • ethereumjs-config-nyc -> ethereumjs-config-coverage
  • ethereumjs-config-prettier -> ethereumjs-config-format
  • ethereumjs-config-tsc -> ethereumjs-config-typescript (least important case)
  • ethereumjs-config-tslint -> ethereumjs-config-lint
    • ethereumjs-config-typedoc -> ethereumjs-config-docs (future)

This makes things more stable mid-term, it is likely that at some point there will be tool changes (hypothetical example: from tslint to eslint, came up with this since I recently stumbled upon this article), or tools are renamed (istanbul -> nyc).

Not sure if it is worth directly tackle this - I know stuff like this is a bit annoying. On the other hand: maybe better now than when things have settled too much and one gets too lazy to act. 😄

Any thoughts?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0