Create/update the template for custom controls / reuse assets

ui5-community / ui5-cc-chart

Other

4 stars 0 forks source link

Create/update the template for custom controls / reuse assets #3

Open petermuessig opened 2 years ago

petermuessig commented 2 years ago

Once decided for a direction we should update the template

marcelschork commented 2 years ago

I will both update the template for the controls and create a similar one for the non-control, reuse modules the next days.

marcelschork commented 2 years ago

Hi @petermuessig, @mauriciolauffer and @marianfoo, I created a yeoman generator for scaffolding a ui5 module project. It comes with

release pipeline that automates the publishing step of the UI5 module on npm using standard-version
Prettier config and an ESLint rule set to ensure consistent code style and quality (check via lintstaged hook)
conventional changelog with commit message linting

Shall we also enforce JSDoc annotations for such modules? So that we can easily create API docs / TS type definitions in the future?

If you have other ideas, feel free to contribute. As a next step we should then bring the same setup to the already existing template for custom controls.

marianfoo commented 2 years ago

Hi Marcel, lot of good out-of-the-box features. To keep the quality high for modules in ui5-community all the checks very good. JSDoc would be good so maybe render the API docs on the website 😍

Without having tried it specifically, I have the following thoughts about it:

add author in package.sjon ?
ESLint is a hot topic for peter ;) https://github.com/ui5-community/generator-ui5-project/pull/31
Node not to 16 in github release action?
i´m (unfortunately) not too familiar with tests, add this?
create in $ModuleName.js some basic code like in Control.js

marcelschork commented 2 years ago

Hi @marianfoo, thanks for the feedback. I added the author to the package.json and updated the module with a basic code skeleton. I also added SAP's jsdoc lint plugin to the configuration, but somehow I do not get any warnings when the jsdoc is missing.

@petermuessig Can you may have a look?

marcelschork commented 2 years ago

Hi all, I added a skeleton for unit tests as well. Unfortunately the "AllTests file" failed to load and I do not really know why because the karma configuration - especially the resource mapping looks correct to me.

If somebody figures out the problem, feel free to fix it or let me know and I'll fix it.

marianfoo commented 2 years ago

I just had another idea. The readme should be expanded a little. For example, I don't know how exactly the action works. So how can I trigger a release to npm? I would also have to add the npm auth token to the repo.

marcelschork commented 2 years ago

Yes, I will do that once we agreed on the tools. Then I will try to describe everything in the README.