Allow for commit prefix by amitayk · Pull Request #160 · di-sukharev/opencommit

amitayk · 2023-05-04T16:39:17Z

A new configuration option called "prefix" has been added. This option allows you to set a default prefix for each commit. It also supports regular expressions (regex) to match the prefix against the branch name.

Here is a simple example of using the prefix option:

oc config set prefix amyu98-commit:

This will result in:

amyu98-commit: Some lovely AI commit content

Below is an example of using a basic regex with the prefix option:

oc config set prefix /^([a-zA-Z]+-\d+)/

For the local branch "DEV-12345-commit-prefix", this will result in:

DEV-12345: Some lovely AI commit content

… generated message feat(config.ts): add prefix configuration option to be used in the generated message. Add validation to ensure prefix is not empty.

…x and message content fix(config.ts): fix config validation for prefix to allow non-empty values

…fig.prefix is undefined instead of falsy

…egex pattern in git branch name feat(api.ts): add support for generating commit message prefix from git branch name if regex pattern is not provided feat(api.ts): add getCurrentGitBranch function to get current git branch name feat(api.ts): add generatePrefixFromRegex function to generate prefix from regex pattern in git branch name

amitayk · 2023-05-04T16:56:20Z

resolve: #152

src/api.ts

package.json

Improve generatePrefixFromRegex function to handle capturing groups Co-authored-by: Takuya Ono <takuya-o@users.osdn.me>

…c to improve security and reliability refactor(api.ts): simplify prefix generation logic by checking if prefix is defined and not empty before using it fix(api.ts): fix conditional statement in generatePrefixFromRegex to return undefined when no match is found fix(api.ts): catch error in getCurrentGitBranch and log it to console instead of throwing it

amitayk · 2023-05-07T09:28:02Z

@takuya-o Thanks, added suggestion and changed to execa (+ minor change in handling undefined prefix)

…utter dependencies list

snirbenyosef · 2023-05-08T09:46:05Z

@amyu98 Amazing, waiting for it to be released.

takuya-o

Confirmed that it has changed to execa

czlowiek488 · 2023-05-21T17:11:02Z

Any updates on this feature?
I really want to use this package but without this feature it is not usable for me 😞

ghost · 2023-05-21T18:48:48Z

@czlowiek488 Not quite sure who is supposed to push this towards merge. Do I need to do anything?

di-sukharev

Hi, sorry foe being late, have you tested the code?

To test you run: npm run build && npm run start inside the repo, so it runs actual build files and not oc which is installed globally

di-sukharev · 2023-05-22T04:38:11Z

src/commands/config.ts

+  [CONFIG_KEYS.prefix](value: any) {
+    validateConfig(
+      CONFIG_KEYS.prefix,
+      true,


true is not validating anything here :) we should validate the config input with a function or expression which return Boolean

@di-sukharev Do you have an idea what can we validate?

you somehow need to confirm that the value is the exact format you expect, if your format is ^(*) and not /^(*)/ — make sure you don't have /s in the value, you may also do multiple validations like !a && b && !c

di-sukharev

Hi, sorry for being late :) Great work!

have you tested the code?

To test you run: npm run build && npm run start inside the repo, so it runs actual build files and not oc which is installed globally

and there are some conflicts to be fixed

tomups · 2023-05-24T15:13:57Z

Any news on getting this merged? Would be awesome 🚀

di-sukharev · 2023-05-26T04:03:39Z

@tomtastico i hope soon, we need to make validateConfig() actually validate something #160 (comment)

cc @amyu98

…variable name feat(config.ts): add validation for OCO_PREFIX environment variable to ensure it is a valid string or regex pattern

…g regex instead of startsWith and endsWith methods

…o a separate function to improve readability and maintainability feat(api.ts): add prefix to the message returned by getOpenCommitLatestVersion function to improve semantics and consistency with other functions

…allowForCommitPrefix

amitayk · 2023-05-27T16:32:36Z

@di-sukharev
All set up and ready to go

amitayk · 2023-06-07T18:55:15Z

@di-sukharev Do we want anything else done?

czlowiek488 · 2023-06-23T13:50:55Z

How is this PR going? @di-sukharev Do we need something more?

mreduar · 2023-06-27T18:07:01Z

@di-sukharev

di-sukharev · 2023-07-05T06:31:55Z

going to merge now, finally, sorry, was reallyy busy :)

btw we won GitHub 2023 hackathon with the OpenCommit, congrats <3

src/commands/config.ts

di-sukharev · 2023-07-05T06:35:50Z

src/api.ts

+
+function getCurrentGitBranch(): string | undefined {
+  try {
+    const branchName = execaCommandSync('git symbolic-ref --short HEAD').stdout.trim()


is this going to add the full branch name in the commit like: #234-some-branch-name commit message text goes here?

No, it will take a regex out of the name. See my first commit on this PR.
Very cool to hear about the hackathon!

di-sukharev · 2023-07-05T06:37:07Z

added 1 comment, could you also pls take a look at this PR, isn't it what you want here, but less code and more agile?

amitayk · 2023-07-05T09:58:11Z

Hmm the other PR might do the trick 😓 @di-sukharev

mreduar · 2023-07-05T13:15:11Z

But the other PR does not extract the number automatically. You would have to pass the placeholder each time a commit is made.

github-actions · 2023-08-14T21:30:45Z

Stale pull request message

inguelcartful · 2023-08-14T21:45:40Z

Any news on getting this merged?

di-sukharev · 2023-09-03T04:29:33Z

managing to merge this today, i need to fix the conflicts first

di-sukharev · 2023-09-03T06:08:00Z

@amyu98 if you have time today, maybe it would be faster for you to solve the conflicts :)

im managing other PRs at the same time, if you chill today as we all should—will fix myself, not sure if i have so much time, there is lots of work to do..

amitayk · 2023-09-03T07:00:29Z

I'll do my best to find the time

…

On Sun, 3 Sept 2023, 9:08 Sukharev, ***@***.***> wrote: @amyu98 <https://github.com/amyu98> if you have time today, maybe it would be faster for you to solve the conflicts :) im managing other PRs at the same time, if you chill today as we all should—will fix myself, not sure if i have so much time, there is lots of work to do.. — Reply to this email directly, view it on GitHub <#160 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANXHFIFTKLOY4M65ZU5RKZTXYQNEXANCNFSM6AAAAAAXWAW7QA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

github-actions · 2023-10-13T21:30:42Z

Stale pull request message

amitayk added 4 commits May 4, 2023 16:37

feat(api.ts): add support for prefix configuration to be added to the…

83a919b

… generated message feat(config.ts): add prefix configuration option to be used in the generated message. Add validation to ensure prefix is not empty.

refactor(api.ts): improve readability by adding a space between prefi…

098db00

…x and message content fix(config.ts): fix config validation for prefix to allow non-empty values

fix(api.ts): fix generatePrefix function to return undefined when con…

b15a100

…fig.prefix is undefined instead of falsy

amitayk changed the base branch from master to dev May 4, 2023 16:39

amitayk mentioned this pull request May 4, 2023

[Feature]: Add prefix option for commit messages #152

Open

takuya-o reviewed May 6, 2023

View reviewed changes

src/api.ts Outdated Show resolved Hide resolved

takuya-o reviewed May 6, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

amitayk and others added 2 commits May 7, 2023 12:15

Update src/api.ts

2577ec1

Improve generatePrefixFromRegex function to handle capturing groups Co-authored-by: Takuya Ono <takuya-o@users.osdn.me>

chore(package.json): remove unused "child_process" dependency to decl…

148773e

…utter dependencies list

amitayk requested a review from takuya-o May 7, 2023 12:07

takuya-o reviewed May 8, 2023

View reviewed changes

di-sukharev reviewed May 22, 2023

View reviewed changes

Merge with master

52122de

amitayk added 6 commits May 27, 2023 16:15

Allow For Prefix: fix(config.ts): fix typo in OCO_PREFIX environment …

dae0408

…variable name feat(config.ts): add validation for OCO_PREFIX environment variable to ensure it is a valid string or regex pattern

Allow For Prefix: refactor(api.ts): improve prefix validation by usin…

e0d1850

…g regex instead of startsWith and endsWith methods

build

5021017

Allow For Prefix: refactor(api.ts): extract message prefixing logic t…

af6f99b

…o a separate function to improve readability and maintainability feat(api.ts): add prefix to the message returned by getOpenCommitLatestVersion function to improve semantics and consistency with other functions

build

59bc005

Merge branch 'dev' of https://github.com/di-sukharev/opencommit into …

a82f8d0

…allowForCommitPrefix

build

02d0171

di-sukharev reviewed Jul 5, 2023

View reviewed changes

src/commands/config.ts Outdated Show resolved Hide resolved

Update src/commands/config.ts

140761c

di-sukharev reviewed Jul 5, 2023

View reviewed changes

github-actions bot added the no-pr-activity label Aug 14, 2023

github-actions bot removed the no-pr-activity label Aug 15, 2023

di-sukharev mentioned this pull request Sep 3, 2023

feat(config.ts): add OCO_MESSAGE_TEMPLATE_PLACEHOLDER configuration i… #208

Merged

github-actions bot added the no-pr-activity label Oct 13, 2023

github-actions bot closed this Oct 20, 2023

di-sukharev reopened this Feb 28, 2024

di-sukharev removed the no-pr-activity label Feb 28, 2024

Conversation

amitayk commented May 4, 2023

Uh oh!

amitayk commented May 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

amitayk commented May 7, 2023

Uh oh!

snirbenyosef commented May 8, 2023

Uh oh!

takuya-o left a comment

Choose a reason for hiding this comment

Uh oh!

czlowiek488 commented May 21, 2023

Uh oh!

ghost commented May 21, 2023

Uh oh!

di-sukharev left a comment

Choose a reason for hiding this comment

Uh oh!

di-sukharev May 22, 2023

Choose a reason for hiding this comment

Uh oh!

amitayk May 23, 2023

Choose a reason for hiding this comment

Uh oh!

di-sukharev May 26, 2023

Choose a reason for hiding this comment

Uh oh!

di-sukharev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tomups commented May 24, 2023

Uh oh!

di-sukharev commented May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

amitayk commented May 27, 2023

Uh oh!

amitayk commented Jun 7, 2023

Uh oh!

czlowiek488 commented Jun 23, 2023

Uh oh!

mreduar commented Jun 27, 2023

Uh oh!

di-sukharev commented Jul 5, 2023

Uh oh!

Uh oh!

di-sukharev Jul 5, 2023

Choose a reason for hiding this comment

Uh oh!

amitayk Jul 5, 2023

Choose a reason for hiding this comment

Uh oh!

di-sukharev commented Jul 5, 2023

Uh oh!

amitayk commented Jul 5, 2023

Uh oh!

mreduar commented Jul 5, 2023

Uh oh!

github-actions bot commented Aug 14, 2023

Uh oh!

inguelcartful commented Aug 14, 2023

Uh oh!

di-sukharev commented Sep 3, 2023

Uh oh!

di-sukharev commented Sep 3, 2023

Uh oh!

amitayk commented Sep 3, 2023 via email

Uh oh!

github-actions bot commented Oct 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

amitayk commented May 4, 2023 •

edited

Loading

di-sukharev left a comment •

edited

Loading

di-sukharev commented May 26, 2023 •

edited

Loading