Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Component scaffolding generator #1998

Merged
merged 69 commits into from
Jan 14, 2023
Merged

Component scaffolding generator #1998

merged 69 commits into from
Jan 14, 2023

Conversation

anton202
Copy link
Contributor

@anton202 anton202 commented Nov 20, 2022

Fixes

Fixes #1323 by @sarayourfriend

Description

This PR adds the ability to crate a component scaffolding from the command line.
by runing: pnpm run create:component [component name in PascalCase]
this files will be created:

  • the component file
  • story file
  • unit test file
  • regression test file
  • the componet name will be added to tsconfig.ts includes property

Testing Instructions

you'll find the details in the main readme file under Frontend Components --> How to create a component, on what commands to run and how to run them in order to create the component scafolding

also please take a look at the template files inside .remake folder, to see if i missed something in the templates

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@anton202 anton202 requested a review from a team as a code owner November 20, 2022 14:44
@anton202 anton202 requested review from obulat and dhruvkb November 20, 2022 14:44
@openverse-bot openverse-bot added the 🟩 priority: low Low priority and doesn't need to be rushed label Nov 20, 2022
@anton202 anton202 marked this pull request as ready for review January 11, 2023 13:19
@anton202
Copy link
Contributor Author

@obulat Thank you!

@sarayourfriend sarayourfriend dismissed their stale review January 11, 2023 23:42

Requested changes have been addressed.

@krysal
Copy link
Member

krysal commented Jan 12, 2023

@WordPress/openverse-frontend this could benefit from another review.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
bin/create-component.sh Outdated Show resolved Hide resolved
bin/create-component.sh Outdated Show resolved Hide resolved
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so excellent. I've made some small suggestions but am very excited to merge this after those changes are made.

anton202 and others added 8 commits January 13, 2023 08:51
Co-authored-by: Zack Krida <[email protected]>
Co-authored-by: Zack Krida <[email protected]>
Co-authored-by: Zack Krida <[email protected]>
Co-authored-by: Zack Krida <[email protected]>
Co-authored-by: Zack Krida <[email protected]>
@zackkrida zackkrida self-requested a review January 13, 2023 20:03
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work. LGTM!

@zackkrida zackkrida merged commit 7e53de2 into WordPress:main Jan 14, 2023
@anton202 anton202 deleted the component_scafolding branch January 14, 2023 06:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Component scaffolding generator
6 participants