Skip to content

Add .js Pattern Lab Config Support #999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sghoweri opened this issue Mar 29, 2019 · 8 comments
Open

Add .js Pattern Lab Config Support #999

sghoweri opened this issue Mar 29, 2019 · 8 comments
Labels
core pinned 📌 Don't let stalebot clean this up

Comments

@sghoweri
Copy link
Contributor

As @EvanLovely mentioned in #897 (comment),
we need the ability to allow PL config files to (also?) support .js config files instead of only allow .json files.

@sghoweri sghoweri self-assigned this Mar 29, 2019
@EvanLovely
Copy link
Member

This would be super helpful!!

@cybtachyon
Copy link

This pairs pretty exactly with: pattern-lab/patternlab-php-core#116

As requested I'm copying in the features list here:

Some suggested settings:

  • patternEngine - This configures the engine being used for the pattern library. Options would be overrides specific to each engine's config.yml.
  • paths - This is an array configuring how Patterns are organized in the library. It should include support for shorthand (the default “atomic” as well as maybe some other common configurations) as well as an array hierarchy describing the directories and their relationships as in patternlab-config.json. In addition, the root should be configurable in addition to "source" and "public" to allow running Pattern Lab from a sub-directory.
  • ordering - Configures whether Pattern Lab orders patterns by the default "filename", or by "header" or by "doc" where Pattern Lab would look in the pattern comments/documentation markdown file for style guide: components.1-button etc. to organize the patterns.

Paths to resources should also be configurable to a "pattern" or "component" constant, where Pattern Lab looks in each component's directory for the relevant resource instead of a separate subdirectory. Many existing pattern libraries keep all relevant component files in the same subdirectory.

This issue is a part of a series to fold functionality present in the nearly identical tool PatternKit in an effort to coalesce the development communities and deprecate PatternKit in favor of Pattern Lab. We plan on moving forwards with development starting August 21st.

Related Reading:

@sghoweri
Copy link
Contributor Author

Made a ton of progress on this yesterday!

@stale
Copy link

stale bot commented Jun 12, 2019

It's hard to keep track of everything. This issue has been automatically marked as stale because it has not had recent activity, neither from the team nor the community. It will be closed if no further activity occurs. Please consider adding additional info, volunteering to contribute a fix for this issue, or making a further case that this is important to you, the team, and the project as a whole. Thanks!

@cybtachyon
Copy link

Shhh stale bot. Work is happening in #1000

@stale
Copy link

stale bot commented Aug 13, 2019

It's hard to keep track of everything. This issue has been automatically marked as stale because it has not had recent activity, neither from the team nor the community. It will be closed if no further activity occurs. Please consider adding additional info, volunteering to contribute a fix for this issue, or making a further case that this is important to you, the team, and the project as a whole. Thanks!

@stale
Copy link

stale bot commented Sep 12, 2019

Issue closed after going stale. It can be re-opened if still relevant.

@stale stale bot closed this as completed Sep 12, 2019
@cybtachyon
Copy link

Marking this as not stale since #1000 was updated just 11 days ago.

@bmuenzenmeyer bmuenzenmeyer added core pinned 📌 Don't let stalebot clean this up and removed needs response 🤙 labels Feb 20, 2020
@bmuenzenmeyer bmuenzenmeyer reopened this Feb 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core pinned 📌 Don't let stalebot clean this up
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants