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.

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

[FEAT]: Reformat output and refactor code #19

Closed
mheob opened this issue Dec 22, 2022 · 1 comment · Fixed by #27
Closed

[FEAT]: Reformat output and refactor code #19

mheob opened this issue Dec 22, 2022 · 1 comment · Fixed by #27
Labels
enhancement New feature or request refactor Restyle or refactor the code base

Comments

@mheob
Copy link
Owner

mheob commented Dec 22, 2022

Description

The output of a release line does not have the style we want.

For example


-   add `eslint-plugin-simple-import-sort` and `eslint-plugin-import` ESLint plugins -->
    ([#103](https://github.com/mheob/config/pull/103)) by [@mheob](https://github.com/mheob)
  • add eslint-plugin-simple-import-sort and eslint-plugin-import ESLint plugins -->
    (#103) by @mheob

should look like this

- add `eslint-plugin-simple-import-sort` and `eslint-plugin-import` ESLint plugins --> ([#103](https://github.com/mheob/config/pull/103)) by [@mheob](https://github.com/mheob)
  • add eslint-plugin-simple-import-sort and eslint-plugin-import ESLint plugins --> (#103) by @mheob

Additional Information

Besides the changes of the output we could improve the code a bit.

For example should the getUserLink function return only the userLink without the by prefix:

function getUserLink(usersFromSummary: string[], user?: string): string | undefined {
const userLink =
usersFromSummary.length > 0
? usersFromSummary
.map((userFromSummary) => `[@${userFromSummary}](https://github.com/${userFromSummary})`)
.join(', ')
.trim()
: user;
return userLink ? `by ${userLink}` : undefined;
}

@mheob mheob added enhancement New feature or request refactor Restyle or refactor the code base labels Dec 22, 2022
@mheob
Copy link
Owner Author

mheob commented Apr 13, 2023

Another idea is to change the order. For the example in the description, it should then be like this:

- [#103](https://github.com/mheob/config/pull/103) ([@mheob](https://github.com/mheob)): add `eslint-plugin-simple-import-sort` and `eslint-plugin-import` ESLint plugins
  • #103 (@mheob): add eslint-plugin-simple-import-sort and eslint-plugin-import ESLint plugins

mheob added a commit that referenced this issue Apr 13, 2023
The new output looks like: "#PR (USER): MESSAGE"

closes #19
@kodiakhq kodiakhq bot closed this as completed in #27 Apr 13, 2023
kodiakhq bot pushed a commit that referenced this issue Apr 13, 2023
Resolves #19

## Changes

- reformat changelog output
  - the new output looks like: "#PR (USER): MESSAGE"
- remove explicit return statements on every typescript functions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request refactor Restyle or refactor the code base
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant