Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Create an automated component template generator #180

Closed
5 tasks done
NicolasOmar opened this issue Oct 1, 2023 · 1 comment · Fixed by #187
Closed
5 tasks done

Create an automated component template generator #180

NicolasOmar opened this issue Oct 1, 2023 · 1 comment · Fixed by #187
Assignees
@NicolasOmar
Labels
documentation Improvements or additions to documentation feature New fun things for the users research Investigation about tech, methodology or other
Milestone
v3.0.0

Comments

@NicolasOmar
Copy link
Owner

NicolasOmar commented Oct 1, 2023 •
edited
Loading

Objective

Create a script to automate component templates.

Description

In order to understand a more efficient way to manage component creation flow and reduce my time generating the same structure over and over, I will study Hygen features and create a script which will setup a baseline for any component I will want to add to Reactive Bulma or future projects.

Tasks

  • Research
    • Study Hygen
    • Look for examples or bibliography that provides examples of Hygen usage
  • Development
    • Install Hygen and set it up following the instructions
    • Set up the new generator for a component, such tool should be capable of create a .tsx, a stories.tsx, a test.tsx and a mock.json file in a folder with linked boilerplate to be usabe even without adding more code.
    • Add recommended usage as well as examples on documentation for future user's usage

Ticket relationships

Relationship Involved tickets
Is child of none
In parent of none
Is related to none
Is blocked by none
It blocks none

Technical notes

None for now
@NicolasOmar NicolasOmar self-assigned this Oct 1, 2023
@NicolasOmar NicolasOmar converted this from a draft issue Oct 1, 2023
@NicolasOmar NicolasOmar added documentation Improvements or additions to documentation research Investigation about tech, methodology or other feature New fun things for the users labels Oct 1, 2023
@NicolasOmar NicolasOmar added this to the v3.0.0 milestone Oct 1, 2023
@NicolasOmar NicolasOmar moved this from In Analysis to To Do in Reactive-bulma | Project board Oct 1, 2023
@NicolasOmar
Copy link
Owner Author

First repo where I will look for hygen usage

@NicolasOmar NicolasOmar moved this from To Do to In Progress in Reactive-bulma | Project board Oct 13, 2023
@NicolasOmar NicolasOmar linked a pull request Oct 15, 2023 that will close this issue
Create component "Breadcrumbs" #187
Merged
8 tasks
@NicolasOmar NicolasOmar changed the title Create a automated component template generator Create an automated component template generator Oct 16, 2023
NicolasOmar added a commit that referenced this issue Oct 16, 2023
@NicolasOmar
feat: Create component "Breadcrumbs" (#187) (#63) (#180)
d8e4ae6 
### Changes made 
- Added library `Hygen` to create custom component templates that will
be generated (giving name and route) to reduce development time writing
repetitive tasks of file creations.
  - Added script `npm run create` which guide user in the process
- Added a documentation update which mentions the new addition and steps
to use the script.
- Added components Breadcrumbs and BreadcrumbItem with implemented tool
(mentioned above)

---

### My pull request is for
- [ ] A bugfix
- [x] A new component
- [ ] An existing component update

### Also, it complies with the following
- In case of a `new component`
  - [x] A folder with its name on `src/components/molecules`
  - [x] A `index.tsx` file where the component will be coded
- [x] New and/or updated interfaces, types, tuples and enums for the
component
- [x] A `index.test.ts` file for its units tests and create the needed
to reach at least 90% of code coverage
- [x] A `index.stories.tsx` file for storybook stories and add at least
2 stories for different scenarios

---

### Screenshots
Not necessary.
@github-project-automation github-project-automation bot moved this from In Progress to Done in Reactive-bulma | Project board Oct 16, 2023
github-actions bot pushed a commit that referenced this issue Oct 16, 2023
@semantic-release-bot
chore(release): 2.4.0 [skip ci]
27a186c 
# [2.4.0](v2.3.0...v2.4.0) (2023-10-16)

### Bug Fixes

* Adapting Hygen template generator to create component structure following a assistant ([0e524da](0e524da))
* BrearcrumbItem added for Breacrumb structure ([534cbcb](534cbcb))
* Dependencies updated to last version ([2e42705](2e42705))

### Features

* Create component "Breadcrumbs" ([#187](#187)) ([#63](#63)) ([#180](#180)) ([d8e4ae6](d8e4ae6))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NicolasOmar NicolasOmar

Labels
documentation Improvements or additions to documentation feature New fun things for the users research Investigation about tech, methodology or other
Projects
Reactive-bulma | Project board
Status: Done
Milestone
v3.0.0
Development

Successfully merging a pull request may close this issue.

Create component "Breadcrumbs" NicolasOmar/reactive-bulma
1 participant
@NicolasOmar