question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

💡 Proposal - v4 package renaming

See original GitHub issue

The problem

Forma 36 package names are very long and with the new build setup there’ll be a lot of typing!

The proposed solution

Rename existing packages to use the shorter “f36” moniker:

  • @contentful/forma-36-react-components@contentful/f36-components
  • @contentful/forma-36-tokens@contentful/f36-tokens

Use the moniker for new packages as well:

  • @contentful/f36-base
  • @contentful/f36-typography
  • @contentful/f36-workbench
  • @contentful/f36-modal
  • @contentful/f36-icon
  • @contentful/f36-card
  • @contentful/f36-button
  • @contentful/f36-skeleton
  • @contentful/f36-input
  • @contentful/f36-form
  • @contentful/f36-tab
  • @contentful/f36-note
  • @contentful/f36-notification
  • @contentful/f36-switch
  • @contentful/f36-spinner
  • @contentful/f36-tag
  • @contentful/f36-dropdown
  • @contentful/f36-accordion
  • @contentful/f36-autocomplete

Later work

Maybe we can group some packages in a core package:

@contentful/f36-inputs, @contentful/f36-forms, @contentful/f36-base, and @contentful/f36-typography@contentful/f36-core

We should cut this from the initial scope since it makes sense to first investigate what packages our users would want grouped into such a core package. See https://github.com/contentful/forma-36/issues/811#issuecomment-768113163

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:3
  • Comments:5 (3 by maintainers)

github_iconTop GitHub Comments

3reactions
nikazawilacommented, Jan 27, 2021

I don’t disagree, but I think before we go ahead and create core, we could use a quick survey of what actual clients of f36 would expect to see there, as for example, for me core should also include icons and cards, but… it isn’t really about me - so knowing the expectations from people using it in their projects would be pretty good before we make assumptions for them.

1reaction
mshaaban0commented, Jan 26, 2021

100% want 🙌 One recommendation from my side is to reduce the number of packages needed to get started, maybe include typography, button and form-elements in base or core? since these components are used in almost all views!

Read more comments on GitHub >

github_iconTop Results From Across the Web

proposal: constraints: rename package to "of" #50348 - GitHub
On their own, the package names any , of , and some don't indicate any meaning. It's only after seeing them in conjunction...
Read more >
Package Renaming Process - Fedora Docs
When you wish to rename a package, you MUST request a re-review of your package through the Package Review Process. In this review...
Read more >
Renaming, Merging, and Splitting Packages
Renaming a single package is straightforward. IPS provides a mechanism to indicate that a package has been renamed. ... A require dependency on...
Read more >
How to change a package name in Eclipse? - Stack Overflow
Right click on the package; Click on refactor; Click on rename; Change the name ; Click OK. Share.
Read more >
8.5.3 Package Renaming Declarations
A package_renaming_declaration declares a new view of the renamed package. 4.1/2. At places where the declaration of the limited view of the renamed...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found